CKEditor 5 rich text editor component for Angular
Official CKEditor 5 rich text editor component for Angular 9.1+.
- Quick start
- Integration with
Supported Angular versions
The integration can be used together with Angular at version
9.1.0 and higher. It is an implication of Angular metadata produced for this package by the Angular builder. Note that the
package.json used in the main repository isn't published on NPM (the production one is present in
src/ckeditor/package.json), so there are only a few peer dependencies to
@angular/core >= 9.0.0,
@angular/common >= 9.0.0 and
@angular/forms >= 9.0.0 required by this package.
Note: For Angular >= 5.0.0 && < 9.0.0 use
After cloning this repository, install necessary dependencies:
The structure of the repository
This repository contains the following code:
./src/ckeditorcontains the implementation of
./src/appis a demo application using the component.
Testing the component (demo)
First, the CKEditor 5 build should be created of source files:
npm run build-ckeditor
To open the demo application using the component, run:
npm run start
To test it in production, use:
npm run start -- --prod
To run unit tests, use:
npm run test
To run e2e tests run:
npm run e2e
To run coverage tests run:
npm run coverage
Play with the application and make sure the component works properly.
Generating the changelog
npm run changelog
Packaging the component
Note This step is optional in the release process (the script is executed anyway by the postversion hook) but it is required to test the package used as an NPM dependency.
This project uses ng-packagr to create a package meeting the Angular Package Format specification.
npm run build-package
creates a package in the
./dist directory, which can be then published in the npm registry.
Testing the package before releasing
Then, create a symlink to the
ckeditor5-angular/dist package directory to test the
ckeditor5-angular via this repository.
ln -s path/to/ckeditor5-angular/dist node_modules/\@ckeditor/ckeditor5-angular
Make sure that the
preserveSymlinks option is set to
true for the
build architect in
Make sure to test package with the production setup (
ng build --prod) and with older Angular versions (at least with the 9.1).
Publishing the package
To publish the new package in the npm registry, run:
npm run release
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.