@ckeditor/ckeditor5-vue - npm Package Versions

7.3.0-alpha.0 (2024-11-13)

Features

• Align integration to work with the future self-service plan. Read more in the CKEditor 5 repository. (commit)

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

• Experimental: Added a useCKEditorCloud() composable for managing asynchronous loading of CKEditor 5 from a CDN. (https://github.com/ckeditor/ckeditor5-vue/commit/d17eb7f99c50c05f987a436c7a2884eafbc2d5e0)

7.1.0-alpha.0 (2024-09-06)

Features

• Experimental: Added a useCKEditorCloud() composable for managing asynchronous loading of CKEditor 5 from a CDN. (https://github.com/ckeditor/ckeditor5-vue/commit/d17eb7f99c50c05f987a436c7a2884eafbc2d5e0)

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:

  // Before the release.
  import CKEditor from '@ckeditor/ckeditor5-vue';
  
  // After the release.
  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:

  // Before the release.
  import CKEditor from '@ckeditor/ckeditor5-vue';
  
  const component = CKEditor.component;
  
  // After the release.
  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)

7.0.0-alpha.2 (2024-07-17)

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)

7.0.0-alpha.1 (2024-07-16)

BREAKING CHANGES

• Rename main package exports to CkeditorPlugin and Ckeditor.

Other changes

• Rename exports to improve name of the editor component in Vue. (commit)

7.0.0-alpha.0 (2024-07-15)

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:

  // Before the change
  import CKEditor from '@ckeditor/ckeditor5-vue';
  
  // After the changes
  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:

  // Before the change
  import CKEditor from '@ckeditor/ckeditor5-vue';
  
  const component = CKEditor.component;
  
  // After the changes
  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.

6.0.0-alpha.0 (2024-06-05)

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

• Updated the required version of Node.js to 18 when developing the repository. See ckeditor/ckeditor5#14924. (commit)