Skip to content

Commit b6709dc

Browse files
committed
docs: move compatibility table to readme
1 parent df4a923 commit b6709dc

2 files changed

Lines changed: 15 additions & 23 deletions

File tree

‎MIGRATION.md‎

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -49,23 +49,8 @@ package compatible.
4949
ng test --watch=false
5050
```
5151

52-
### Compatibility reference
53-
54-
| `angular-plotly.js` | Angular | Notes |
55-
| --- | --- | --- |
56-
| `2.x` | 9 | Not compatible with Angular 13 |
57-
| `3.x` | 10 | Angular 10 library-format release |
58-
| `4.x` | 11–12 | Declares Angular greater than 10.0.9 |
59-
| `5.x` | 13–15 | Angular 13 compatibility line |
60-
| `6.x` | 16–19 | Declares Angular 16 or newer; validate your application before a major Angular upgrade |
61-
| `20.x` | 20 | Angular 20 compatibility line |
62-
| `21.x` | 21 | Peer dependencies are capped below Angular 22 |
63-
| `22.x` | 22 | Current compatibility line; peer dependencies are capped below Angular 23 |
64-
65-
The package version does not increase for every Angular major. Check the
66-
package peer dependencies before upgrading across an Angular major, and use
67-
the package line that declares support for the Angular version in the
68-
application.
52+
The [README compatibility table](README.md#angular-compatibility) is the
53+
single reference for matching `angular-plotly.js` and Angular versions.
6954

7055
### Plotly.js bundles and Angular 19
7156

‎README.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,33 @@
1414

1515
---
1616

17+
## Angular compatibility
18+
1719
Since version 20, the angular-plotly.js major follows the supported Angular
1820
major. Install the matching package line:
1921

20-
| angular-plotly.js | Angular | Branch | Support |
22+
| `angular-plotly.js` | Angular | Branch | Support / notes |
2123
| --- | --- | --- | --- |
22-
| 22.x | 22.x | `master` | Active |
23-
| 21.x | 21.x | `v21` | LTS |
24-
| 20.x | 20.x | `v20` | LTS through 2026-11-28 |
24+
| `2.x` | 9 | — | Historical; not compatible with Angular 13 |
25+
| `3.x` | 10 | — | Historical Angular 10 library-format release |
26+
| `4.x` | 11–12 | — | Historical; declares Angular greater than 10.0.9 |
27+
| `5.x` | 13–15 | — | Historical Angular 13 compatibility line |
28+
| `6.x` | 16–19 | — | Historical; declares Angular 16 or newer; validate before a major Angular upgrade |
29+
| `20.x` | 20 | `v20` | LTS through 2026-11-28 |
30+
| `21.x` | 21 | `v21` | LTS; peer dependencies are capped below Angular 22 |
31+
| `22.x` | 22 | `master` | Active; peer dependencies are capped below Angular 23 |
2532

2633
Maintenance and release details are documented in [MAINTENANCE.md](MAINTENANCE.md).
2734

2835
If you want to use with Angular 8.x, please use version [`angular-plotly.js@1.x`](https://github.com/plotly/angular-plotly.js/tree/1.x).
2936

30-
For upgrade instructions and historical Angular/package compatibility, see
31-
the [migration guide](MIGRATION.md).
37+
For upgrade instructions, see the [migration guide](MIGRATION.md).
3238

3339

3440
## Content
3541

3642
* [Installation](#installation)
43+
* [Angular compatibility](#angular-compatibility)
3744
* [Migration guide](MIGRATION.md)
3845
* [Quick start](#quick-start)
3946
* [API](#api-reference)

0 commit comments

Comments
 (0)