CKEditor 5 rich text editor component for Vue.js

Official CKEditor 5 rich text editor component for Vue.js.

Developer Documentation 📖

See the "Rich text editor component for Vue.js" guide in the CKEditor 5 documentation to learn more:

• Quick start
• Using component locally
• Using CKEditor from source
• Using the Document editor build
• Component directives
• Component events

Contributing

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 component (src/ckeditor.js) or plugin (src/plugin.js) files, 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

Testing component with Vue CLI

When symlinking the component in an application generated using Vue CLI, make sure your vue.config.js file configures webpack in the following way:

module.exports = {
    configureWebpack: {
        resolve: {
            symlinks: false
        }
    }
};

Otherwise, the application will fail to load the component correctly and, as a result, it will throw a build error.

Releasing

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

npm run release

Note: Only the dist/ directory will be published.

License

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