npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ckeditor/ckeditor5-angular

v7.0.1

Published

Official Angular component for CKEditor 5 – the best browser-based rich text editor.

Downloads

238,983

Readme

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+.

Developer Documentation 📖

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:

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)

First, the CKEditor 5 build should be created out 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 -- --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

Generating the changelog

npm run changelog

Packaging the component

Note This step is required to test the package used as an npm dependency.

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, 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 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).

Publishing the package

To create the release directory, run:

npm run release:prepare-packages

Then, to publish the new package in the npm registry, run:

npm run release:publish-packages

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.