Skip to content

Commit 063bd83

Browse files
committed
Changelog for v7.0.0.
1 parent 5fc488a commit 063bd83

File tree

1 file changed

+36
-7
lines changed

1 file changed

+36
-7
lines changed

CHANGELOG.md

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,42 @@ Changelog
33

44
## [7.0.0](https://github.com/ckeditor/ckeditor5-vue/compare/v6.0.0...v7.0.0) (2024-08-07)
55

6+
We are excited to announce a new major release of the Vue integration.
7+
8+
In this release, we have introduced the following breaking changes that should make using the integration more intuitive and easier.
9+
10+
* **Composition API**: The integration has been rewritten in Composition API, which follows the recommended way of writing components in Vue 3.
11+
* **Vue 3.4+**: The minimum required version of Vue is now 3.4+ because we are using the [Generics](https://vuejs.org/api/sfc-script-setup.html#generics) and [`defineModel()`](https://vuejs.org/api/sfc-script-setup.html#definemodel) features to provide better typings for the `editor` prop and component events.
12+
* **ESM-first**: Besides the UMD build, the integration is now available in ESM format. In most projects, the new ESM build should be automatically prioritized by bundlers and other tools.
13+
* **Changed exports**: We have changed how the Vue plugin and component are exported. The Vue plugin is no longer the `default` export but is exported as `CkeditorPlugin`. The component is now exported as `Ckeditor` instead of `default.component`.
14+
15+
Here's a comparison of how you can import the Vue plugin that registers a global `<ckeditor>` component:
16+
17+
```ts
18+
// Before the release.
19+
import CKEditor from '@ckeditor/ckeditor5-vue';
20+
21+
// After the release.
22+
import { CkeditorPlugin } from '@ckeditor/ckeditor5-vue';
23+
```
24+
25+
If you prefer to use a local component instead of a global component, here's a comparison of how you can import it:
26+
27+
```ts
28+
// Before the release.
29+
import CKEditor from '@ckeditor/ckeditor5-vue';
30+
31+
const component = CKEditor.component;
32+
33+
// After the release.
34+
import { Ckeditor } from '@ckeditor/ckeditor5-vue';
35+
36+
const component = Ckeditor;
37+
```
38+
39+
* **Remove the `editor` argument from the `destroy` event**: The `destroy` event no longer has an `editor` argument since it was always `null`.
40+
* **New name of the global variable**: The name of the global variable used in the UMD build changed from `CKEditor` to `CKEDITOR_VUE`.
41+
642
### BREAKING CHANGES
743

844
* Bump required version to Vue 3.4+. See [#282](https://github.com/ckeditor/ckeditor5-vue/issues/282).
@@ -12,11 +48,6 @@ Changelog
1248
* Migrate to ESM. See [ckeditor/ckeditor5#16616](https://github.com/ckeditor/ckeditor5/issues/16616).
1349
* Remove argument from the `destroy` event, as it was always `null`. Closes [#283](https://github.com/ckeditor/ckeditor5-vue/issues/283).
1450
* Rename main package exports to `CkeditorPlugin` and `Ckeditor`.
15-
* Replace the default export with named `CKEditorPlugin` export.
16-
17-
### Features
18-
19-
* Add UMD for better backward compatibility. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/0412b19f26ef954a7cf8fb8c2bc7d1bce686e0e6))
2051

2152
### Bug fixes
2253

@@ -27,8 +58,6 @@ Changelog
2758
### Other changes
2859

2960
* Rename exports to improve name of the editor component in Vue. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/fac44822ca6f41c9a7ea4b529b6274da1ee66cfc))
30-
* Updated yarn.lock to fix dependabot alert. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/e0d7a9e9c974025f6d0060b70d1d19718cb14f48))
31-
3261

3362
## [7.0.0-alpha.2](https://github.com/ckeditor/ckeditor5-vue/compare/v7.0.0-alpha.1...v7.0.0-alpha.2) (2024-07-17)
3463

0 commit comments

Comments
 (0)