v3.0.1: Chart is being deprecated & replaced

[MadsBuchmann]

Hi! 🥳

What's going on?

In v3.0.1 we begin the process of removing the old chart component based on Highcharts and replace it with a new chart component based on chart.js.

Unfortunately Highcharts requires a license, so we've been working on removing our dependency to it which up until v3.0.1 has been used for the chart component. Chart.js on the other hand is open source and does not require any licenses.

The first step has been to deprecate the Highcharts based chart component (which is now called ChartDeprecatedComponent) & replace it with a chart.js based one (which is called ChartComponent).

ChartDeprecatedComponent will be removed in a later version; no deadline has been found yet however. An announcement will be made when one has been found.

What should I do as a user of Kirby?

As ChartDeprecatedComponent will eventually be removed you should be aiming at replacing your charts with the new chart.js based ChartComponent.

As the API has significantly changed we're well aware that this might take some time. Therefore to get your code working with v3.0.1, you can start by updating your code to accommodate the breaking changes.

This mostly consists of updating names of types & selectors to include the word deprecated.

But wait! The new chart does not support all the types of the old one!?

We've been surveying consumer projects (more specifically DRB for those in the know) for which of the chart types made available by Kirby, were actually in use. The conclusion was that only the Column & Bar types was in use. Hence these are also the first two to be released.

Future chart types will be implemented in the future and can be requested by creating a new issue 😄

Breaking changes

• Renamed old ChartComponent based on Highcharts to ChartDeprecatedComponent

• Changed selector of ChartDeprecatedComponent to kirby-chart-deprecated.

• Added word deprecated to types related to the old chart component. For example ChartType which is now called ChartDeprecatedType.

• Repurposed name ChartComponent for new chart.js based chart component.

• Repurposed selector kirby-chart for new chart.js based chart component.

• Renamed StockChartComponent to StockChartDeprecatedComponent

• Changed kirby-stock-chart selector to kirby-stock-chart-deprecated.

Got questions?

Write a comment to this announcement or create a separate Q&A discussion: here