Skip to content

ckeditor/ckeditor5-angular

Repository files navigation

CKEditor 5 rich text editor component for Angular

npm version CircleCI Coverage Status Dependency Status

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

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

Supported Angular versions

Because of the breaking changes in the Angular library output format, the @ckeditor/ckeditor5-angular package is released in the following versions to support various Angular ecosystems:

Package version Angular version Details
Actively supported versions
^7 13+ Changes in peer dependencies. (issue)
Past releases (no longer maintained)
^6 13+ Requires CKEditor 5 at least in version 42.
^5 13+ Requires Angular at least in version 13+. Lower versions are no longer maintained.
^4 9.1+ Requires CKEditor 5 at least in version 34.
^3 9.1+ Requires Node.js at least in version 14.
^2 9.1+ Migration to TypeScript 4. Declaration files are not backward compatible.
^1 5.x - 8.x Angular versions are no longer maintained.

Note that the package.json file used in the main repository isn't published on npm (the production one is present in src/ckeditor/package.json).

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 implementation of 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 -- --configuration production

To run unit tests, use:

npm run test

To run e2e tests, run:

# Prepare the server.
npm run start
# Then, start tests.
npm run test:e2e

To run coverage tests, run:

npm run coverage

Play with the application and make sure the component works properly.

Releasing

This package's release process is automated via CircleCI. Before you start a new release, you'll need to test the package and then prepare the changelog entries.

Testing the package before releasing

To test the package used as an npm dependency, first you need to build it.

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

Calling:

npm run build-package

creates a package in the ./dist directory.

Next, to verify the generated ckeditor5-angular package, bootstrap an empty Angular package using ng new and add the <ckeditor> component by following the guide.

Then, create a symlink to the ckeditor5-angular/dist package directory to test the ckeditor5-angular component 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 angular.json:

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

Make sure to test the package with the production setup (ng build --configuration production) and with older Angular versions (at least with the 9.1).

Generating the changelog

  1. Make sure the #master branch is up-to-date: git fetch && git checkout master && git pull.
  2. Prepare a release branch: git checkout -b release-[YYYY-MM-DD] where YYYY-MM-DD is the current day.
  3. Generate the changelog entries: yarn run changelog --branch release-[YYYY-MM-DD].
    • This task checks what changed in each package and bumps the version accordingly. If nothing changes at all, it won't create a new changelog entry. If changes were irrelevant (e.g., only dependencies), it would make an "internal changes" entry.
    • Scan the logs printed by the tool to search for errors (incorrect changelog entries). Incorrect entries (e.g., ones without the type) should be addressed. You may need to create entries for them manually. This is done directly in CHANGELOG.md (in the root directory). Make sure to verify the proposed version after you modify the changelog.
  4. Commit all changes and prepare a new pull request targeting the #master branch.

Release the package

Once the package is successfully tested and the pull request with changelog is ready, ping the @ckeditor/ckeditor-5-devops team to review the pull request and trigger the release process.

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.