@carbon/charts-react
Version:
Carbon Charts component library for React
46 lines (36 loc) • 2.3 kB
Markdown
<p align="center">
<a href="https://charts.carbondesignsystem.com/">
<img src="../../assets/dashboard.png" alt="Carbon Charts" />
</a>
<h3 align="center">Carbon Charts React</h3>
<p align="center">
A component library of 26 charts for React.
<br /><br />
<a href="https://www.npmjs.com/package/@carbon/charts">
<img src="https://img.shields.io/npm/v/@carbon/charts.svg" />
</a>
<img alt="semantic-versioning" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--ver-e10079.svg" />
<img alt="semantic-versioning" src="https://img.shields.io/badge/downloads-+60k%2Fweek-green" />
<a href="https://discord.gg/J7JEUEkTRX">
<img src="https://img.shields.io/discord/689212587170201628?color=5865F2" alt="Chat with us on Discord">
</a>
</p>
</p>
**[Documentation with StackBlitz examples](https://charts.carbondesignsystem.com/)**
## Getting started
Run the following command using [npm](https://www.npmjs.com/):
```bash
npm install -S @carbon/charts-react
```
If you prefer [Yarn](https://yarnpkg.com/en/), use the following command instead:
```bash
yarn add @carbon/charts-react
```
The required styles should be imported from `@carbon/charts-react/dist/styles.css`.
## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
This package uses IBM Telemetry to collect de-identified and anonymized metrics
data. By installing this package as a dependency you are agreeing to telemetry
collection. To opt out, see
[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
For more information on the data being collected, please see the
[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).