Official CKEditor 5 Angular 2+ component.
Switch branches/tags
Clone or download
pomek Merge pull request #56 from ckeditor/t/55
Tests: Removed a test which fails on Edge randomly. Closes #55.
Latest commit 46799e3 Nov 21, 2018

README.md

CKEditor 5 rich text editor component for Angular 2+

Join the chat at https://gitter.im/ckeditor/ckeditor5 npm version Build Status Coverage Status BrowserStack Status
Dependency Status devDependency Status

Official CKEditor 5 rich text editor component for Angular 2+.

Documentation

See the Angular 2+ component article in the CKEditor 5 documentation.

Contributing

After cloning this repository, install necessary dependencies:

npm install

The structure of the repository

This repository contains the following code:

  • ./src/ckeditor contains the CKEditor component,
  • ./src/app is a demo application using the component.

Note: The npm package contains a packaged component only.

Testing the component (demo)

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.

Releasing

Generating the changelog

npm run changelog

Packaging the component

This project uses ng-packagr to create a package meeting the Angular Package Format specification.

Calling:

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

After generating the package, create a symlink to the ckeditor5-angular/dist package directory to test it in another (third–party) Angular project:

ln -s /path/to/ckeditor5-angular/dist node_modules/\@ckeditor/ckeditor5-angular

You may also need the following configuration in angular.json to include the symlinked component package without errors:

{
	"project-name": {
		"architect": {
			"build": {
				"options": {
					"preserveSymlinks": true
				}
			}
		}
	}
}

Publishing the package

To publish the new package in the npm registry, run:

npm run release

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.