@ckeditor/ckeditor5-react - npm Package Versions

9.4.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)

Bug fixes

• Call onChangeInitializedEditors on startup of CKEditorContext if there are ready editors. (commit)

9.3.1 (2024-10-16)

Bug fixes

• Behavior of useCKEditorCloud hook is now consistent with Vite and Next runtimes while changing properties. (commit)
• Prevent potential crashes of useMultiRootEditor during the initialization phase when setting the new state of the multi-root editor with an attached watchdog. Closes #542. (commit)
• Update roots with modified content only. (commit)

9.3.0 (2024-09-26)

Features

• 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)

9.2.0 (2024-09-19)

Features

• Experimental: Improve result type of useCKEditorCloud to make CKEditorPremiumFeatures and CKBox non-nullable when proper configuration is passed. (commit)

Other changes

• Experimental: Rename the languages configuration property to translations in useCKEditorCloud. (commit)

9.1.0 (2024-09-05)

We added an onChangeInitializedEditors callback to CKEditorContext component to allow tracking newly initialized editors within the JSX React tree.

Example

<CKEditorContext
  context={ ClassicEditor.Context }
  contextWatchdog={ ClassicEditor.ContextWatchdog }
  onChangeInitializedEditors={ editors => {
    console.log( editors );
  }}
>
  <CKEditor
    editor={ ClassicEditor }
    data="<h2>Editor</h2>"
    contextItemMetadata={{
      name: 'editor1',
      user: { id: '2' }
    }}
  />

  <CKEditor
    editor={ ClassicEditor }
    data="<h2>Another Editor</h2><p>... in a common Context</p>"
    contextItemMetadata={{
      name: 'editor2'
    }}
  />
</CKEditorContext>

onChangeInitializedEditors will be called twice in the example above:

1. First log: { editor1: ... }
2. Second log: { editor1: ..., editor2: ... }

⚠️ Order of initialization is not guaranteed. editor2 might be initialized before editor1.

Features

• Add an onChangeInitializedEditors callback to CKEditorContext to allow tracking of newly initialized editors within the JSX React tree. Closes #513. (commit)
• Experimental: Added useCKEditorCloud hook for managing asynchronous loading of CKEditor from a CDN. (commit)
• Experimental: Added withCKEditorCloud HOC to simplify CKEditor integration with CDN in React components. (commit)

Bug fixes

• Image upload should be now possible in demos. (commit)
• Indent button is no longer disabled in manual demos. (commit)
• Manual demos should point to existing documentation links. (commit)

9.0.0 (2024-08-07)

We are excited to announce a new major release of the React integration.

In this release, we have introduced the following breaking changes that should make using the integration more intuitive and easier.

• 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.
• Support for React 19: We improved support for using the integration in React 19. As a result, the <CKEditorContext> component and the useMultiRootEditor hook should no longer throw errors.
• New name of the global variable: The name of the global variable used in the UMD build changed from CKEditor to CKEDITOR_REACT.

BREAKING CHANGES

• Change the global name used in the UMD build from CKEditor to CKEDITOR_REACT.

Bug fixes

• Adjusted CKEditorContext format to prevent race conditions in the CKEditor component. (commit)
• Change JSX runtime to classic so that react-jsx-runtime is not bundled. (commit)
• Change the global name used in the UMD build from CKEditor to CKEDITOR_REACT to match the new convention. See ckeditor/ckeditor5#16736. (commit)

Other changes

• Added support for React 19. (commit)
• Updated yarn.lock to fix dependabot alert. (commit)

9.0.0-alpha.1 (2024-07-17)

BREAKING CHANGES

• Change the global name used in the UMD build from CKEditor to CKEDITOR_REACT.

Bug fixes

• Change JSX runtime to classic so that react-jsx-runtime is not bundled. (commit)
• Change the global name used in the UMD build from CKEditor to CKEDITOR_REACT to match the new convention. See ckeditor/ckeditor5#16736. (commit)

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

We are excited to announce the alpha release of the next major version of the React integration.

In this release, we have introduced the following breaking changes that should make using the integration more intuitive and easier.

• 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.
• Support for React 19: We improved support for using the integration in React 19. As a result, the <CKEditorContext> component and the useMultiRootEditor hook should no longer throw errors.

BREAKING CHANGES

• Migrate to ESM. See ckeditor/ckeditor5#16616.

Bug fixes

• Adjusted CKEditorContext format to prevent race conditions in the CKEditor component. (commit)

Other changes

• Added support for React 19. (commit)

8.0.0 (2024-06-26)

We are excited to announce the next major version of the React integration.

This release is intended to allow the integration to work with the latest version of new installation methods.

8.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.

BREAKING CHANGES

• Add a new required contextWatchdog prop to the <CKEditorContext> component.

Features

• Change the implementation to only depend on types from the ckeditor5 package and not runtime code to make the integration work with existing and new installation methods. (commit)