From: Dan Onoshko Date: Fri, 25 Nov 2022 10:31:14 +0000 (+0400) Subject: docs: add info about ESM into migration guide. (#10903) X-Git-Tag: v4.1.0~16 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=80a931ebd3299387e4fdb9b2a80ec2139477fbfc;p=thirdparty%2FChart.js.git docs: add info about ESM into migration guide. (#10903) --- diff --git a/docs/migration/v4-migration.md b/docs/migration/v4-migration.md index fd80b6465..eeeeb3112 100644 --- a/docs/migration/v4-migration.md +++ b/docs/migration/v4-migration.md @@ -37,6 +37,13 @@ A number of changes were made to the configuration options passed to the `Chart` * The order of the `ChartMeta` parameters have been changed from `` to ``. ### General +* Chart.js becomes an [ESM-only package](https://nodejs.org/api/esm.html) ([the UMD bundle is still available](../getting-started/installation.md#cdn)). To use Chart.js, your project should also be an ES module. Make sure to have this in your `package.json`: + ```json + { + "type": "module" + } + ``` + If you are experiencing problems with [Jest](https://jestjs.io), follow its [documentation](https://jestjs.io/docs/ecmascript-modules) to enable the ESM support. Or, we can recommend you migrating to [Vitest](https://vitest.dev/). Vitest has the ESM support out of the box and [almost the same API as Jest](https://vitest.dev/guide/migration.html#migrating-from-jest). See an [example of migration](https://github.com/reactchartjs/react-chartjs-2/commit/7f3ec96101d21e43cae8cbfe5e09a46a17cff1ef). * Removed fallback to `fontColor` for the legend text and strikethrough color. * Removed `config._chart` fallback for `this.chart` in the filler plugin. * Removed `this._chart` in the filler plugin.