Skip to main content

Migration to v4

With v4, this library introduces a number of breaking changes. In order to improve performance, offer new features, and improve maintainability, it was necessary to break backwards compatibility, but we aimed to do so only when worth the benefit.

v4 is fully compatible with Chart.js v3.

New exports

  • All re-exports from chart.js were removed
  • Default export was renamed to Chart
v3
import Chart, {
Chart as ChartJS,
defaults
} from 'react-chartjs-2';
v4
import {
Chart as ChartJS,
defaults
} from 'chart.js';
import {
Chart
} from 'react-chartjs-2';

Tree-shaking

v4 of this library, just like Chart.js v3, is tree-shakable. It means that you need to import and register the controllers, elements, scales, and plugins you want to use.

For a list of all the available items to import, see Chart.js docs.

v3
import Chart from 'react-chartjs-2';

<Chart type='line' data={chartData} />
v4 — lazy way
import 'chart.js/auto';
import { Chart } from 'react-chartjs-2';

<Chart type='line' data={chartData} />
v4 — tree-shakable way
import { Chart } from 'react-chartjs-2';
import { Chart as ChartJS, LineController, LineElement, PointElement, LinearScale, Title } from 'chart.js';

ChartJS.register(LineController, LineElement, PointElement, LinearScale, Title);

<Chart type='line' data={chartData} />

Using the "lazy way" is okay to simplify the migration, but please consider using the tree-shakable way to decrease the bundle size.

Please note that typed chart components register their controllers by default, so you don't need to register them by yourself. For example, when using the Line component, you don't need to register LineController explicitly.

v4 — Line component
import { Line } from 'react-chartjs-2';
import { Chart as ChartJS, LineElement, PointElement, LinearScale, Title } from 'chart.js';

ChartJS.register(LineElement, PointElement, LinearScale, Title);

<Line data={chartData} />

Drawing charts with gradients

The option to pass a function to the data prop was removed.

v3
const chartData = canvas => {
const ctx = canvas.getContext('2d');

return {
datasets: [{
backgroundColor: createBackgroundGradient(ctx),
// ...
}],
};
};

<Chart type='bar' data={chartData} />
v4
const chartRef = useRef(null);
const [chartData, setChartData] = useState({
datasets: [],
});

useEffect(() => {
const chart = chartRef.current;

if (chart) {
setChartData({
datasets: [{
backgroundColor: createBackgroundGradient(chart.ctx),
// ...
}]
});
}
}, []);

<Chart type='bar' data={chartData} />

See the full working example.

Getting data from click events

getDatasetAtEvent, getElementAtEvent and getElementsAtEvent props were removed in favor of tree-shakable methods with the same names.

v3
<Chart
type='bar'
data={chartData}
getDatasetAtEvent={(dataset, event) => { /* ... */ }}
getElementAtEvent={(element, event) => { /* ... */ }}
getElementsAtEvent={(elements, event) => { /* ... */ }}
/>
v4
const chartRef = useRef(null);

<Chart
ref={chartRef}
type='bar'
data={chartData}
onClick={(event) => {
const dataset = getDatasetAtEvent(chartRef.current, event);
const element = getElementAtEvent(chartRef.current, event);
const elements = getElementsAtEvent(chartRef.current, event);
}}
/>

See the full working example.