@elastic/charts 66.0.1 → 66.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/LICENSE.txt +0 -6
- package/README.md +0 -87
package/package.json
CHANGED
package/LICENSE.txt
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
Source code in this repository is covered by (i) a dual license under the Server
|
|
2
|
-
Side Public License, v 1 and the Elastic License 2.0 or (ii) an Apache License
|
|
3
|
-
2.0 compatible license or (iii) solely under the Elastic License 2.0, in each
|
|
4
|
-
case, as noted in the applicable header. The default throughout the repository
|
|
5
|
-
is a dual license under the Server Side Public License, v 1 and the Elastic
|
|
6
|
-
License 2.0, unless the header specifies another license.
|
package/README.md
DELETED
|
@@ -1,87 +0,0 @@
|
|
|
1
|
-
<h1 align="center">
|
|
2
|
-
<img src="https://raw.githubusercontent.com/elastic/elastic-charts/main/public/logo.png" alt="elastic-charts logo" width="100" /><br />
|
|
3
|
-
Elastic Charts
|
|
4
|
-
</h1>
|
|
5
|
-
<p align="center">
|
|
6
|
-
<a href="https://buildkite.com/elastic/datavis-ci/builds?branch=main">
|
|
7
|
-
<img alt="Build Status - main branch" src="https://badge.buildkite.com/1b2f6369ef27e5b23a7fccf2545d7d6e31bff1957c7c941d31.svg?branch=main">
|
|
8
|
-
</a>
|
|
9
|
-
<a href="https://www.npmjs.com/@elastic/charts"><img alt="NPM version" src="https://img.shields.io/npm/v/@elastic/charts.svg"></a>
|
|
10
|
-
<a href="http://commitizen.github.io/cz-cli/"><img alt="Commitizen friendly" src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg"></a>
|
|
11
|
-
<a href="https://elastic.github.io/elastic-charts/storybook">
|
|
12
|
-
<img src="https://img.shields.io/static/v1?label=examples&message=storybook&color=ff4685">
|
|
13
|
-
</a>
|
|
14
|
-
</p>
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
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](https://codesandbox.io/p/sandbox/elastic-charts-playground-gmnjx9?file=%2Fsrc%2FApp.tsx) example here to play directly with the library.
|
|
19
|
-
|
|
20
|
-
## Installation
|
|
21
|
-
|
|
22
|
-
To install the Elastic Charts into an existing project, use the `yarn` CLI (`npm` is not supported).
|
|
23
|
-
|
|
24
|
-
```
|
|
25
|
-
yarn add @elastic/charts
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
> **Important:** see the [consuming] wiki for detailed installation requirements
|
|
29
|
-
|
|
30
|
-
## Running Locally
|
|
31
|
-
|
|
32
|
-
### Node
|
|
33
|
-
|
|
34
|
-
We depend upon the version of node defined in [.nvmrc](.nvmrc).
|
|
35
|
-
|
|
36
|
-
You will probably want to install a node version manager. [nvm](https://github.com/creationix/nvm) is recommended.
|
|
37
|
-
|
|
38
|
-
To install and use the correct node version with `nvm`:
|
|
39
|
-
|
|
40
|
-
```
|
|
41
|
-
nvm install
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### Development environment
|
|
45
|
-
|
|
46
|
-
You can run the dev environment locally at [http://localhost:9001](http://localhost:9001/) by running:
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
yarn
|
|
50
|
-
yarn start
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
We use [storybook](https://storybook.js.org) to document API, edge-cases, and the usage of the library.
|
|
54
|
-
A hosted version is available at [https://elastic.github.io/elastic-charts/storybook][docs].
|
|
55
|
-
|
|
56
|
-
## Goals
|
|
57
|
-
|
|
58
|
-
The primary goal of this library is to provide reusable set of chart components that can be used throughout Elastic's web products.
|
|
59
|
-
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".
|
|
60
|
-
|
|
61
|
-
## Contributing
|
|
62
|
-
|
|
63
|
-
You can find documentation around creating and submitting new features in [contributing][contributing].
|
|
64
|
-
|
|
65
|
-
## [Wiki][wikiroot]
|
|
66
|
-
|
|
67
|
-
### Consumption
|
|
68
|
-
|
|
69
|
-
- [Consuming Elastic Charts][consuming]
|
|
70
|
-
|
|
71
|
-
### Documentation
|
|
72
|
-
|
|
73
|
-
- [Overview][overview]
|
|
74
|
-
- [Theming][theming]
|
|
75
|
-
|
|
76
|
-
## License
|
|
77
|
-
|
|
78
|
-
[Dual-licensed under Elastic v2 and Server Side Public License, v 1][license] Read the [FAQ][faq] for details.
|
|
79
|
-
|
|
80
|
-
[license]: LICENSE.txt
|
|
81
|
-
[wikiroot]: https://github.com/elastic/elastic-charts/wiki
|
|
82
|
-
[faq]: https://github.com/elastic/elastic-charts/wiki/FAQ
|
|
83
|
-
[docs]: https://elastic.github.io/elastic-charts/storybook/
|
|
84
|
-
[consuming]: https://github.com/elastic/elastic-charts/wiki/Consuming-@elastic-charts
|
|
85
|
-
[overview]: https://github.com/elastic/elastic-charts/wiki/Overview
|
|
86
|
-
[theming]: https://github.com/elastic/elastic-charts/wiki/Theming
|
|
87
|
-
[contributing]: https://github.com/elastic/elastic-charts/wiki/Contributing-to-Elastic-Charts
|