Wondering what’s next for npm?Check out our public roadmap! »

    @ckeditor/ckeditor5-angular
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    CKEditor 5 rich text editor component for Angular

    npm version Build Status Coverage Status
    Dependency Status devDependency Status

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

    Developer Documentation 📖

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

    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 ckeditor5-angular@1.x.x releases.

    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 <ckeditor> component,
    • ./src/app is a demo application using the component.

    Note: The npm package contains a packaged component only.

    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.

    Releasing

    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.

    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

    To test the ckeditor5-angular package, first 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 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 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

    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.

    Install

    npm i @ckeditor/ckeditor5-angular

    DownloadsWeekly Downloads

    23,758

    Version

    2.0.1

    License

    GPL-2.0-or-later

    Unpacked Size

    246 kB

    Total Files

    24

    Homepage

    ckeditor.com

    Last publish

    Collaborators

    • avatar