Skip to content

Commit 2ee5bba

Browse files
authored
Merge pull request #302 from ckeditor/release-20240807
Internal: Changelog for v7.0.0.
2 parents da8058c + 063bd83 commit 2ee5bba

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

CHANGELOG.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,64 @@
11
Changelog
22
=========
33

4+
## [7.0.0](https://github.com/ckeditor/ckeditor5-vue/compare/v6.0.0...v7.0.0) (2024-08-07)
5+
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+
42+
### BREAKING CHANGES
43+
44+
* Bump required version to Vue 3.4+. See [#282](https://github.com/ckeditor/ckeditor5-vue/issues/282).
45+
* Change the global name used in the UMD build from `CKEditor` to `CKEDITOR_VUE`.
46+
* Export the component as `Ckeditor` instead of `default.component`. Closes [#284](https://github.com/ckeditor/ckeditor5-vue/issues/284).
47+
* Migrate to Composition API. Closes [#172](https://github.com/ckeditor/ckeditor5-vue/issues/172).
48+
* Migrate to ESM. See [ckeditor/ckeditor5#16616](https://github.com/ckeditor/ckeditor5/issues/16616).
49+
* Remove argument from the `destroy` event, as it was always `null`. Closes [#283](https://github.com/ckeditor/ckeditor5-vue/issues/283).
50+
* Rename main package exports to `CkeditorPlugin` and `Ckeditor`.
51+
52+
### Bug fixes
53+
54+
* Change the global name used in the UMD build from `CKEditor` to `CKEDITOR_VUE` to match the new convention. See [ckeditor/ckeditor5#16736](https://github.com/ckeditor/ckeditor5/issues/16736). ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/eba73a525e1422ff3a3a1a95825d6c4807b3a232))
55+
* Fix the component properties and event types. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/e2a9bbcaec754ab680fc28dae545ea27defe68e3))
56+
* Use type of the passed `editor` prop rather than generic `Editor` type. Closes [#282](https://github.com/ckeditor/ckeditor5-vue/issues/282). ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/c82a0040dfd2f23a87aca257c354b6a2c302c340))
57+
58+
### Other changes
59+
60+
* Rename exports to improve name of the editor component in Vue. ([commit](https://github.com/ckeditor/ckeditor5-vue/commit/fac44822ca6f41c9a7ea4b529b6274da1ee66cfc))
61+
462
## [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)
563

664
### BREAKING CHANGES

scripts/changelog.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@ const cliArguments = parseArguments( process.argv.slice( 2 ) );
1818
import { generateChangelogForSinglePackage } from '@ckeditor/ckeditor5-dev-release-tools';
1919

2020
await generateChangelogForSinglePackage( {
21+
from: cliArguments.from,
2122
releaseBranch: cliArguments.branch
2223
} );

scripts/utils/parsearguments.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export default function parseArguments( cliArguments ) {
2121

2222
string: [
2323
'branch',
24+
'from',
2425
'npm-tag'
2526
],
2627

0 commit comments

Comments
 (0)