All Versions
Latest Version
Avg Release Cycle
88 days
Latest Release
756 days ago

Changelog History
Page 1

  • v5.0.2 Changes

    May 26, 2022

    Other changes

  • v5.0.1 Changes

    May 18, 2022

    ๐Ÿ› Bug fixes

    • ๐Ÿ›  Fixed component double rendering in StrictMode. Closes #294. (commit)
  • v5.0.0 Changes

    April 12, 2022


    • ๐Ÿ”’ 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)
  • v4.0.1 Changes

    April 01, 2022

    Other changes

    • โฌ†๏ธ Bumped Karma test runner to v6.x. Closes #292. (commit)
    • ๐Ÿ‘Œ Support for React 18. Closes #297. (commit)
  • v4.0.0 Changes

    February 09, 2022


    • โฌ†๏ธ 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

  • v3.0.3 Changes

    October 05, 2021

    ๐Ÿ“š Internal changes only (updated dependencies, documentation, etc.).

  • v3.0.2 Changes

    March 08, 2021

    ๐Ÿ› Bug fixes

    • ๐Ÿ‘‰ Make sure that the watchdog instance exists before destroying itself. Closes #197. (commit)
  • v3.0.1 Changes

    February 09, 2021

    Other changes

    • โž• Added React@^17 as allowed version in peerDependencies. (commit)
  • v3.0.0 Changes

    October 28, 2020


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

  • v2.1.0 Changes

    January 16, 2020

    ๐Ÿ”‹ 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.