Changelog
7.3.0 (2024-11-25)
Features
Features
7.2.0 (2024-09-26)
Bug fixes
- Experimental: Better error messages in
useCKEditorCloud. It now detects existing editor installations and gives migration info from NPM to CDN. (commit)
Other changes
- Remove
ckeditor5-premium-features from peerDependencies. (commit)
7.1.0 (2024-09-19)
Features
Features
7.0.0 (2024-08-07)
We are excited to announce a new major release of the Vue integration.
In this release, we have introduced the following breaking changes that should make using the integration more intuitive and easier.
- Composition API: The integration has been rewritten in Composition API, which follows the recommended way of writing components in Vue 3.
- Vue 3.4+: The minimum required version of Vue is now 3.4+ because we are using the Generics and
defineModel() features to provide better typings for the editor prop and component events.
- 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.
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.
Here's a comparison of how you can import the Vue plugin that registers a global <ckeditor> component:
import CKEditor from '@ckeditor/ckeditor5-vue';
import { CkeditorPlugin } from '@ckeditor/ckeditor5-vue';
If you prefer to use a local component instead of a global component, here's a comparison of how you can import it:
import CKEditor from '@ckeditor/ckeditor5-vue';
const component = CKEditor.component;
import { Ckeditor } from '@ckeditor/ckeditor5-vue';
const component = Ckeditor;
Remove the editor argument from the destroy event: The destroy event no longer has an editor argument since it was always null.
- New name of the global variable: The name of the global variable used in the UMD build changed from
CKEditor to CKEDITOR_VUE.
BREAKING CHANGES
- Bump required version to Vue 3.4+. See #282.
- Change the global name used in the UMD build from
CKEditor to CKEDITOR_VUE.
- Export the component as
Ckeditor instead of default.component. Closes #284.
- Migrate to Composition API. Closes #172.
- Migrate to ESM. See ckeditor/ckeditor5#16616.
- Remove argument from the
destroy event, as it was always null. Closes #283.
- Rename main package exports to
CkeditorPlugin and Ckeditor.
Bug fixes
- Change the global name used in the UMD build from
CKEditor to CKEDITOR_VUE to match the new convention. See ckeditor/ckeditor5#16736. (commit)
- Fix the component properties and event types. (commit)
- Use type of the passed
editor prop rather than generic Editor type. Closes #282. (commit)
Other changes
- Rename exports to improve name of the editor component in Vue. (commit)
BREAKING CHANGES
- Change the global name used in the UMD build from
CKEditor to CKEDITOR_VUE.
Bug fixes
- Change the global name used in the UMD build from
CKEditor to CKEDITOR_VUE to match the new convention. See ckeditor/ckeditor5#16736. (commit)
- Fix the component properties and event types. (commit)
BREAKING CHANGES
- Rename main package exports to
CkeditorPlugin and Ckeditor.
Other changes
- Rename exports to improve name of the editor component in Vue. (commit)
We are excited to announce the alpha release of the next major version of the Vue integration.
In this release, we have introduced the following breaking changes that should make using the integration more intuitive and easier.
- Composition API: The integration has been rewritten in Composition API, which follows the recommended way of writing components in Vue 3.
- Vue 3.4+: The minimum required version of Vue is now 3.4+ because we are using the Generics and
defineModel() features to provide better typings for the editor prop and component events.
- 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.
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.
Here's a comparison of how you can import the Vue plugin that registers a global <ckeditor> component:
import CKEditor from '@ckeditor/ckeditor5-vue';
import { CKEditorPlugin } from '@ckeditor/ckeditor5-vue';
If you prefer to use a local component instead of a global component, here's a comparison of how you can import it:
import CKEditor from '@ckeditor/ckeditor5-vue';
const component = CKEditor.component;
import { CKEditor } from '@ckeditor/ckeditor5-vue';
const component = CKEditor;
Remove the editor argument from the destroy event: The destroy event no longer has an editor argument since it was always null.
BREAKING CHANGES
- The
@ckeditor/ckeditor5-vue package requires Vue 3.4+. See #282.
- Export the component as
CKEditor instead of default.component. Closes #284.
- Migrate to Composition API. Closes #172.
- Migrate to ESM. See ckeditor/ckeditor5#16616.
- Remove the argument from the
destroy event, as it was always null. Closes #283.
- Replace the default export with named
CKEditorPlugin export.
Bug fixes
- Use the type of the passed
editor prop rather than generic Editor type. Closes #282. (commit)
Other changes
- Add UMD for better backward compatibility. (commit)
- Updated yarn.lock to fix dependabot alert. (commit)
6.0.0 (2024-06-26)
We are excited to announce the next major version of the Vue integration.
This release is intended to allow the integration to work with the latest version of new installation methods.
We are happy to announce the alpha release of the next major version of the React integration.
This release is intended to allow the integration to work with existing and new installation methods announced in this post.
Please refer to our nightly documentation build for the installation instructions.
Features
- Change the implementation to only depend on types from the
ckeditor5 packages and not runtime code to make the integration work with existing and new installation methods. (commit)
Other changes
5.1.0 (2023-04-18)
Features
- Added
disableTwoWayDataBinding property that allows disabling the two-way data binding. It increases performance when working with large documents. Closes ckeditor/ckeditor5-vue#246. (commit)
5.0.0 (2023-04-07)
Release highlights
This release introduces improved TypeScript support for better code suggestion and completion.
BREAKING CHANGES
- Due to rewriting to TypeScript, the component requires CKEditor 5 typings that are available in version 37 or higher. See ckeditor/ckeditor5#11704.
- Upgraded the minimal versions of Node.js to
16.0.0 due to the end of LTS.
Features
Other changes
- Updated the required version of Node.js to 16. (commit)
- Added a missing postinstall script to the published files. (commit)
BREAKING CHANGES
- Due to rewriting to TypeScript, the component requires CKEditor 5 typings that are available in version 37 or higher. See ckeditor/ckeditor5#11704.
- Upgraded the minimal versions of Node.js to
16.0.0 due to the end of LTS.
Features
- Improve typings for events emitted by the Vue component. (commit)
Other changes
- Updated the required version of Node.js to 16. (commit)
Other changes
- Added a missing postinstall script to published files. (commit)
Release highlights
This release introduces improved TypeScript support for better code suggestion and completion.
Please keep in mind that the release is marked as alpha, which means it is an experimental version, and some unexpected results may occur when using these typings.
We appreciate your feedback, as it helps us significantly improve the project's final shape. Please share it here.
Features
4.0.1 (2022-05-18)
Bug fixes
- Synchronize the editor content after the editor is ready. Closes #220. (commit)
4.0.0 (2022-04-12)
BREAKING CHANGES
- Due to introducing the lock mechanism for the
Editor#isReadOnly property, the <CKEditor> component uses the new way of enabling the read-only mode in the editor. The component requires an instance of CKEditor 5 in version 34 or higher. See ckeditor/ckeditor5#10496.
Other changes
- Aligned the
<CKEditor> component API to use the new lock mechanism when enabling/disabling the read-only mode. (commit)
- Bumped Karma test runner to v6.x. Closes #210. (commit)
3.0.0 (2022-03-17)
BREAKING CHANGES
- Upgraded the minimal versions of Node.js to
14.0.0 due to the end of LTS.
Bug fixes
- Marked the editor instance
this.instance as a raw object so that it will never be converted to a proxy. Closes #203. (commit)
Other changes
2.0.1 (2020-11-23)
Bug fixes
- When using the
<CKEditor> component with an unsupported version of Vue.js, the component will display an error. Closes #170. (commit)
2.0.0 (2020-11-20)
The CKEditor 5 WYSIWYG editor component is compatible with Vue.js 3+. For Vue.js 2.x, check the dedicated @ckeditor/ckeditor5-vue2 component.
1.0.3 (2020-09-22)
Bug fixes
- The editor should not slow down with lots of content when using the integration. Closes #153. (commit)
MINOR BREAKING CHANGES ℹ️
- The reference to the CKEditor 5 instance previously available under the
instance property of the component (data) is now private ($_instance). We recommend you use the ready component event to access the editor API instead.
1.0.2 (2020-09-01)
Bug fixes
- The
#input event should be fired immediately despite being debounced to prevent race conditions. Closes #149. (commit)
1.0.1 (2019-12-05)
Bug fixes
- Editor config defined in the component should not be mutable. Closes #101. (42651e3)
1.0.0 (2019-09-20)
Bug fixes
Bug fixes
- Improved performance when editing large content. Debounced the component
#input event. Closes #42. (dfaee36)
- The data initialization should not break collaboration. Instead of using
editor.setData(), the initial content is now set via innerHTML of the source element. Closes #47. (6f821fa)
First developer preview. It contains a ready-to-use <ckeditor> component that allows using CKEditor 5 Builds and CKEditor 5 Framework in Vue.js applications.
ckeditor
