Official CKEditor 5 React component.
Switch branches/tags
Nothing to show
Clone or download
Latest commit f8a02b6 Nov 29, 2018

CKEditor 5 rich text editor component for React

Join the chat at npm version Build Status BrowserStack Status Coverage Status
Dependency Status devDependency Status

Official CKEditor 5 rich text editor component for React.


See the React component article in the CKEditor 5 documentation.


After cloning this repository, install necessary dependencies:

npm install

Executing tests

npm run test -- [additional options]
# or
npm t -- [additional options]

The command accepts the following options:

  • --coverage (-c) – Whether to generate the code coverage.
  • --source-map (-s) – Whether to attach the source maps.
  • --watch (-w) – Whether to watch test files.
  • --reporter (-r) – Reporter for Karma (default: mocha, can be changed to dots).
  • --browsers (-b) – Browsers that will be used to run tests (default: Chrome, available: Firefox, BrowserStack_Edge and BrowserStack_Safari).

Note: If you would like to use the BrowserStack_* browser, you need to specify the BROWSER_STACK_USERNAME and BROWSER_STACK_ACCESS_KEY as an environment variable, e.g.:

BROWSER_STACK_USERNAME=[...] BROWSER_STACK_ACCESS_KEY=[...] npm t -- -b BrowserStack_Edge,BrowserStack_Safari -c

If you are going to change the source (src/ckeditor.jsx) file, remember about rebuilding the package. You can use npm run develop in order to do it automatically.

Building the package

Build a minified version of the package that is ready to publish:

npm run build

Changelog generator

npm run changelog


Before starting to release the package, you need to generate the changelog.

npm run release

Note: Only the dist/ directory will be published.


Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the file.