Skip to content

Update migration guide for version 3 #882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2023
Merged

Update migration guide for version 3 #882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/release-drafter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions docs/guide/migrationV3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.