@carbon/charts-react 1.9.0-rc.6 → 1.10.1
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/README.md +9 -20
- package/dist/index.js.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/styles.css +0 -22118
- package/dist/styles.css.map +1 -1
- package/dist/styles.min.css +1 -1
- package/dist/styles.min.css.map +1 -1
- package/package.json +27 -24
package/README.md
CHANGED
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Carbon Charts React
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Carbon Charts React is a thin React wrapper around the vanilla JavScript `@carbon/charts` component library. The charts are based on D3.js, a peer dependency.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
> Carbon Charting React Wrappers
|
|
5
|
+
The required styles should be imported from `@carbon/charts-react/styles.css` and `@carbon/styles/css/styles.css`. Additional documentation is provided in the Storybook demos.
|
|
8
6
|
|
|
9
7
|
**[Storybook demos](https://carbon-design-system.github.io/carbon-charts/react)**
|
|
10
8
|
|
|
@@ -15,44 +13,35 @@
|
|
|
15
13
|
Run the following command using [npm](https://www.npmjs.com/):
|
|
16
14
|
|
|
17
15
|
```bash
|
|
18
|
-
npm install -S @carbon/charts @carbon/
|
|
16
|
+
npm install -S @carbon/charts-react @carbon/styles d3 d3-cloud d3-sankey
|
|
19
17
|
```
|
|
20
18
|
|
|
21
19
|
If you prefer [Yarn](https://yarnpkg.com/en/), use the following command instead:
|
|
22
20
|
|
|
23
21
|
```bash
|
|
24
|
-
yarn add @carbon/charts @carbon/
|
|
22
|
+
yarn add @carbon/charts-react @carbon/styles d3 d3-cloud d3-sankey
|
|
25
23
|
```
|
|
26
24
|
|
|
27
|
-
**Note:** you'd also need to install `carbon-components` if you're not using a bundled version of
|
|
28
|
-
the library.
|
|
29
|
-
|
|
30
25
|
## Step-by-step instructions
|
|
31
26
|
|
|
32
27
|
Read
|
|
33
28
|
[here](https://carbon-design-system.github.io/carbon-charts/?path=/story/docs-getting-started--react)
|
|
34
29
|
|
|
35
|
-
##
|
|
30
|
+
## StackBlitz examples
|
|
36
31
|
|
|
37
32
|
[Sample use cases can be seen here](https://carbon-design-system.github.io/carbon-charts/react).
|
|
38
33
|
|
|
39
|
-
**When opening the link above**, click on the **Edit on
|
|
34
|
+
**When opening the link above**, click on the **Edit on StackBlitz** button for each demo to see an
|
|
40
35
|
isolated project showing you how to reproduce the demo.
|
|
41
36
|
|
|
42
37
|
## Charting data & options
|
|
43
38
|
|
|
44
|
-
Although
|
|
45
|
-
such as maps, Data and options follow the same model in all charts, with minor exceptions and
|
|
46
|
-
differences in specific components.
|
|
47
|
-
|
|
48
|
-
For instance in the case of a donut chart you're able to pass in an additional field called `center`
|
|
49
|
-
in your options configuring the donut center.
|
|
39
|
+
Although new charts will be introduced in the future (such as a choropleth), data and options follow the same model for all charts with minor exceptions. For example, in the case of a donut chart, you're able to pass in an additional field called `center` in your options to configure the donut center.
|
|
50
40
|
|
|
51
41
|
For instructions on using the **tabular data format**, see
|
|
52
42
|
[here](https://carbon-design-system.github.io/carbon-charts/?path=/story/docs-tutorials--tabular-data-format)
|
|
53
43
|
|
|
54
|
-
There are also additional options available depending on the chart type being used,
|
|
55
|
-
[see our demo examples here](https://github.com/carbon-design-system/carbon-charts/tree/master/packages/core/demo/data).
|
|
44
|
+
There are also additional options available depending on the chart type being used, [see our demo examples here](https://github.com/carbon-design-system/carbon-charts/tree/master/packages/core/demo/data).
|
|
56
45
|
|
|
57
46
|
Customizable options (specific to chart type) can be found
|
|
58
47
|
[here](https://carbon-design-system.github.io/carbon-charts/documentation/modules/_interfaces_charts_.html)
|