From 3bc7bd17ea3efbec289709f0958b5d428efcbb31 Mon Sep 17 00:00:00 2001 From: stockiNail Date: Wed, 10 May 2023 16:46:45 +0200 Subject: [PATCH] Update migration guide for version 3 --- .github/release-drafter.yml | 2 +- docs/guide/migrationV3.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 2ddcb941b..57df67edd 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -42,7 +42,7 @@ template: | # Essential Links * [npm](https://www.npmjs.com/package/chartjs-plugin-annotation) - * [Migration guide](https://www.chartjs.org/chartjs-plugin-annotation/latest/guide/migrationV2.html) + * [Migration guide](https://www.chartjs.org/chartjs-plugin-annotation/latest/guide/migrationV3.html) * [Docs](https://www.chartjs.org/chartjs-plugin-annotation/) * [API](https://www.chartjs.org/chartjs-plugin-annotation/latest/api/) * [Samples](https://www.chartjs.org/chartjs-plugin-annotation/latest/samples/intro.html) diff --git a/docs/guide/migrationV3.md b/docs/guide/migrationV3.md index 369ec326d..76269a067 100644 --- a/docs/guide/migrationV3.md +++ b/docs/guide/migrationV3.md @@ -6,3 +6,7 @@ The [UMD bundle](integration.md#script-tag) is still available. ## Chart.js version The annotation plugin requires at least version 4.0.0 to work because of Chart.js becomes an ESM-only package. + +### Type changes + +* The `init` options callback return value types have been changed from `void | boolean | AnnotationBoxModel` to `void | boolean | AnnotationElement`.