@carbon/charts-vue

Carbon Charts Vue

Carbon Charts Vue is a thin Vue.js wrapper around the vanilla JavScript @carbon/charts component library. The charts are based on D3.js, a peer dependency. This version is for Vue.js ^2.7.0. For Vue.js 3.x support, check for the availability of @carbon/charts-vue@next.

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

Storybook demos

Storybook demo sources

Maintenance & support

This component library is community-maintained.

Getting started

Run the following command using npm:

npm install -S @carbon/charts-vue @carbon/styles d3 d3-cloud d3-sankey

If you prefer Yarn, use the following command instead:

yarn add @carbon/charts-vue @carbon/styles 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