@carbon/charts-react

Carbon Charts React

Carbon Charts React is a thin React wrapper around the vanilla JavaScript @carbon/charts component library. The charts are based on D3.js, a peer dependency.

The required styles should be imported from @carbon/charts-react/dist/styles.css. Additional documentation is provided in the Storybook demos.

Storybook demos

Storybook demo sources

Getting started

Run the following command using npm:

npm install -S @carbon/charts-react d3 d3-cloud d3-sankey

If you prefer Yarn, use the following command instead:

yarn add @carbon/charts-react d3 d3-cloud d3-sankey

Step-by-step instructions

Read Getting Started

Storybook and StackBlitz Examples

Sample use cases can be seen here.

When opening the link above, click on the Edit on StackBlitz button for each demo to see an isolated project showing you how to reproduce the demo.

Charting data & options

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.

For instructions on using the tabular data format, see here

Customizable options (specific to chart type) can be found here

IBM Telemetry

This package uses IBM Telemetry to collect 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. For more information on the data being collected, please see the IBM Telemetry documentation.

Changelog

1.14.5 (2024-02-26)

Note: Version bump only for package @carbon/charts-monorepo

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.