About elastic-charts

Elastic Charts is a comprehensive React library providing a reusable set of chart components designed for Elastic's web products. It serves as a single source of truth, enabling designers to update the look and feel directly within the code while ensuring stability through rigorous unit test coverage. The library offers an API for charts that supports various visualization types, theming capabilities, and interactive features to enhance data exploration in applications. It includes a living style guide and Storybook documentation with numerous examples to help developers understand component behavior, edge cases, and integration patterns. Installation requires the Yarn CLI, as npm is not officially supported. Development involves setting up the specific Node version defined in the project, followed by running local environments to view Storybook examples. The project follows a dual license model under Elastic v2 and Server Side Public License v1. It is optimized for building consistent, reusable data visualiz

e

Published by

elastic

Visit View Profile

README.md

View on GitHub

Elastic Charts

Check out our living style guide, which contains many examples on how charts look and feel, and how to use them in your products or fork the codesandbox example here to play directly with the library.

Installation

To install the Elastic Charts into an existing project, use the yarn CLI (npm is not supported).

yarn add @elastic/charts

Important: see the consuming wiki for detailed installation requirements

Running Locally

Node

We depend upon the version of node defined in .nvmrc.

You will probably want to install a node version manager. nvm is recommended.

To install and use the correct node version with nvm:

nvm install

Development environment

You can run the dev environment locally at http://localhost:9001 by running:

yarn
yarn start

We use storybook to document API, edge-cases, and the usage of the library. A hosted version is available at https://elastic.github.io/elastic-charts/storybook.

CI

We're using the same build pipeline for building PRs and the main branch. This pipeline is triggered through webhook events hitting the buildkite-pr-bot. Configuration for the triggered pipelines can be adjusted in pull-requests.json.

Goals

The primary goal of this library is to provide reusable set of chart components that can be used throughout Elastic's web products. As a single source of truth, the framework allows our designers to make changes to our look-and-feel directly in the code. And unit test coverage for the charts components allows us to deliver a stable "API for charts".

Contributing

You can find documentation around creating and submitting new features in contributing.

Wiki

Consumption

Consuming Elastic Charts

Documentation

License

Dual-licensed under Elastic v2 and Server Side Public License, v 1 Read the FAQ for details.

elastic-charts