CKEditor 5 - Common Integration Utils

Official CKEditor 5 common integration utils. This package contains a set of utilities that are shared between CKEditor 5 framework integrations such like:

• CKEditor 5 Vue integration
• CKEditor 5 React integration
• CKEditor 5 Angular integration

The prime example of such shared utility might be the CKEditor 5 Cloud integration loader that is used by all integrations to dynamically load the editor from the CDN.

It's highly recommended to not use this package directly in your application because it's intended to be used by through the integrations listed above. However, if you need to use it directly (because you are using framework that is not supported by the integrations), you can use it as a standalone package, but keep in mind that the API is designed to be used by the integrations and might not be user-friendly.

Contributing

After cloning this repository, install the necessary dependencies:

npm install

You can also use Yarn.

Running the development server

You can start the development server using the command below:

npm run dev

Executing tests

To test the editor integration against a set of automated tests, run the following command:

npm run test

If you want to run the tests in watch mode, use the following command:

npm run test:watch

Building the package

To build the package that is ready to publish, use the following command:

npm run build

Releasing package

CircleCI automates the release process and can release both channels: stable (X.Y.Z) and pre-releases (X.Y.Z-alpha.X, etc.).

Before you start, you need to prepare the changelog entries.

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-[YYYYMMDD] where YYYYMMDD is the current day.

3. Generate the changelog entries: yarn run changelog --branch release-[YYYYMMDD] [--from [GIT_TAG]].

   • By default, the changelog generator uses the latest published tag as a starting point for collecting commits to process.

     The --from modifier option allows overriding the default behavior. It is required when preparing the changelog entries for the next stable release while the previous one was marked as a prerelease, e.g., @alpha.

     Example: Let's assume that the v40.5.0-alpha.0 tag is our latest and that we want to release it on a stable channel. The --from modifier should be equal to --from v40.4.0.

   • This task checks what changed in each package and bumps the version accordingly. It won't create a new changelog entry if nothing changes at all. 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.
5. Ping the @ckeditor/ckeditor-5-devops team to review the pull request and trigger the release process.

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.

Changelog

2.2.3 (2025-02-12)

Features

• Added support for loading more testing versions in CDN loader. (commit)

2.2.2 (2024-11-19)

Features

• Improved error messages in loadCKEditorCloud when using editor version not supporting CDN distribution. (commit)

2.2.1 (2024-11-04)

Features

• Add testing versions support to injector. (commit)

2.2.0 (2024-10-29)

Features

• Added the createCustomCdnUrl configuration option to override default CKEditor 5 Cloud CDN URLs in loadCKEditorCloud. (commit)
• Added support for passing a translations list for CKBox in the configuration for loadCKEditorCloud. (commit)
• Improved detection of already installed versions of the editor. (commit)

2.1.0 (2024-09-26)

Features

• Better error messages in loadCKEditorCloud. It now detects existing editor installations and gives migration info from NPM to CDN. (commit)

Bug fixes

• ckeditor5-premium-features is no longer required to be installed. It should no longer raise TypeScript compilation errors while using this package with tsconfig.json file with skipLibCheck: false option. (commit)
• Removed aliases in src/ files to fix incorrect .d.ts output. (commit)

2.0.0 (2024-09-12)

BREAKING CHANGES

• The languages configuration property has been renamed to translations in loadCKEditorCloud.

Features

• Add the crossorigin=anonymous attribute to all CDN resource tags to prevent CORS issues. Closes https://github.com/ckeditor/ckeditor5-integrations-common/issues/30. (commit)
• Add the injectedHtmlElementsAttributes attribute to the loadCKEditorCloud configuration, allowing the addition of nonce and other custom attributes to injected elements. (commit)
• CKEditorCloudResult now returns more narrowly typed attributes for CKBox and CKEditorPremiumFeatures, taking into account CKEditorCloudConfig. Closes #24. (commit)
• The en language is no longer loaded when passed in translations as it is prebundled. (commit)

Bug fixes

• Rename the languages configuration property to translations in loadCKEditorCloud. (commit)

1.0.0 (2024-09-04)

We are happy to announce the first stable release of @ckeditor/ckeditor5-integrations-common, a package containing utility modules for integrating with CKEditor 5.

Below, you can find changes compared to the latest non-stable release.

Features

• CSS scripts are now injected at the beginning of the document head, allowing for easier overriding of editor styles. (commit)

Bug fixes

• Ensure that preload link tags are injected before stylesheet link tags. (commit)

0.2.1 (2024-08-27)

Bug fixes

• Export missing CdnPluginsPacks typing, which is used in integrations. (commit)

0.2.0 (2024-08-27)

Bug fixes

• No longer raise export modifier cannot be applied to ambient modules error on older TS versions. (commit)

Features

The API interface of the loadCKEditorCloud method has been simplified, and the ability to specify the CKBox theme has been added. (commit)

0.1.1 (2024-08-20)

Bug fixes

• Add missing CKEditor window variables to the final index.d.ts bundle. (commit)

0.1.0 (2024-08-20)

Features

The initial version of the cloud integration utils implementation. (commit)

0.0.1 (2024-08-19)

This is an initial package for development purposes. It does not contain code yet.