Skip to content

Commit c7d95f1

Browse files
authored
Update migration guide for version 3 (#882)
1 parent c0bfea9 commit c7d95f1

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

.github/release-drafter.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ template: |
4242
# Essential Links
4343
4444
* [npm](https://www.npmjs.com/package/chartjs-plugin-annotation)
45-
* [Migration guide](https://www.chartjs.org/chartjs-plugin-annotation/latest/guide/migrationV2.html)
45+
* [Migration guide](https://www.chartjs.org/chartjs-plugin-annotation/latest/guide/migrationV3.html)
4646
* [Docs](https://www.chartjs.org/chartjs-plugin-annotation/)
4747
* [API](https://www.chartjs.org/chartjs-plugin-annotation/latest/api/)
4848
* [Samples](https://www.chartjs.org/chartjs-plugin-annotation/latest/samples/intro.html)

docs/guide/migrationV3.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,7 @@ The [UMD bundle](integration.md#script-tag) is still available.
66
## Chart.js version
77

88
The annotation plugin requires at least version 4.0.0 to work because of Chart.js becomes an ESM-only package.
9+
10+
### Type changes
11+
12+
* The `init` options callback return value types have been changed from `void | boolean | AnnotationBoxModel` to `void | boolean | AnnotationElement`.

0 commit comments

Comments
 (0)