@ckeditor/ckeditor5-react - npm Package Versions

5.0.2 (2022-05-26)

Other changes

• Upgraded the @ckeditor/ckeditor5-watchdog package to the latest version. (commit)

5.0.1 (2022-05-18)

Bug fixes

• Fixed component double rendering in StrictMode. Closes #294. (commit)

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

4.0.1 (2022-04-01)

Other changes

• Bumped Karma test runner to v6.x. Closes #292. (commit)
• Support for React 18. Closes #297. (commit)

4.0.0 (2022-02-09)

BREAKING CHANGES

• Upgraded the minimal versions of Node.js to 14.0.0 due to the end of LTS.

Bug fixes

• Use async/await in CKEditorContext#_destroyContext() to handle context destruction properly. Closes #283. (commit)

Other changes

• Updated the required version of Node.js to 14. See ckeditor/ckeditor5#10972. (commit)

3.0.3 (2021-10-05)

Internal changes only (updated dependencies, documentation, etc.).

3.0.2 (2021-03-08)

Bug fixes

• Make sure that the watchdog instance exists before destroying itself. Closes #197. (commit)

3.0.1 (2021-02-09)

Other changes

• Added React@^17 as allowed version in peerDependencies. (commit)

3.0.0 (2020-10-28)

BREAKING CHANGES

• The onInit property was renamed to onReady and can be called multiple times (after the initialization and after the component is ready when an error occurred).

• The entry point of the package has changed. The default import was removed since the package provides more than a single component now. Use

  import { CKEditor } from '@ckeditor/ckeditor5-react';
  

  instead of

  import CKEditor from '@ckeditor/ckeditor5-react';
  

Features

• Support for the config.initialData option in the configuration object when creating the <CKEditor> component. When passing the [data] property and the initialData value in the configuration object, the later one will take precedence and a warning message will be logged on the console. (commit)

• The <CKEditor> component contains the built-in watchdog feature. Closes #118. (commit)

• Introduced the <CKEditorContext> component that supports the context feature. (commit)

• Added the id property which is used to distinguish different documents. When this property changes, the component restarts the underlying editor instead of setting data on it, which allows e.g. for switching between collaboration documents and fixes a couple of issues (e.g. the onChange event no longer fires during changing the document). Closes #168, #169. (commit)

• The onError() callback will be called with two arguments. The first one will be an error object (as it was before the release 3+). A second argument is an object that contains two properties:. (commit)

  • {String} phase: 'initialization'|'runtime' - Informs when the error has occurred (during the editor/context initialization or after the initialization).

  • {Boolean} willEditorRestart - When true, it means that the editor component will restart itself.

  • {Boolean} willContextRestart - When true, it means that the context component will restart itself.

    The willEditorRestart property will not appear when the error has occurred in the context feature. The willContextRestart property will not appear when the error has occurred in the editor.

Both components (<CKEditor> and <CKEditorContext>) will internally use the Watchdog class that restarts the editor or context when an error occurs.

2.1.0 (2020-01-16)

Features

• Introduced support for onError callback that is being called if an error occurred during the editor's initialization. Closes #123. (becf9f7)

  Thanks to @ansorensen.