Elastic Charts

Check out our [living style guide][docs], 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

$3

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
`

$3

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][docs].

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][contributing].

[Wiki][wikiroot]

$3

- [Consuming Elastic Charts][consuming]

$3

- [Overview][overview]
- [Theming][theming]

License

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

[license]: LICENSE.txt
[wikiroot]: https://github.com/elastic/elastic-charts/wiki
[faq]: https://github.com/elastic/elastic-charts/wiki/FAQ
[docs]: https://elastic.github.io/elastic-charts/storybook/
[consuming]: https://github.com/elastic/elastic-charts/wiki/Consuming-@elastic-charts
[overview]: https://github.com/elastic/elastic-charts/wiki/Overview
[theming]: https://github.com/elastic/elastic-charts/wiki/Theming
[contributing]: https://github.com/elastic/elastic-charts/wiki/Contributing-to-Elastic-Charts