@ckeditor/ckeditor5-utils

What is @ckeditor/ckeditor5-utils?

@ckeditor/ckeditor5-utils is a utility library for CKEditor 5 that provides a variety of helper functions and classes to facilitate common tasks such as DOM manipulation, event handling, and data structures.

What are @ckeditor/ckeditor5-utils's main functionalities?

Event Handling

The EmitterMixin class allows you to add event handling capabilities to your classes. In this example, we create a class that extends EmitterMixin, instantiate it, and then set up an event listener for 'myEvent'. When 'myEvent' is fired, the listener logs a message to the console.

const { EmitterMixin } = require('@ckeditor/ckeditor5-utils');

class MyClass extends EmitterMixin() {}

const myInstance = new MyClass();

myInstance.on('myEvent', () => {
  console.log('myEvent was fired!');
});

myInstance.fire('myEvent');

DOM Manipulation

The createElement function simplifies the process of creating and configuring DOM elements. In this example, we create a <div> element with a class and id, and then append it to the document body.

const { createElement } = require('@ckeditor/ckeditor5-utils');

const div = createElement(document, 'div', {
  class: 'my-class',
  id: 'my-id'
});

document.body.appendChild(div);

Data Structures

The Collection class provides a way to manage a collection of items. In this example, we create a new collection, add items to it, and then retrieve an item by its id.

const { Collection } = require('@ckeditor/ckeditor5-utils');

const collection = new Collection();

collection.add({ id: 1, name: 'Item 1' });
collection.add({ id: 2, name: 'Item 2' });

console.log(collection.get(1)); // { id: 1, name: 'Item 1' }

Other packages similar to @ckeditor/ckeditor5-utils

lodash

Lodash is a popular utility library that provides a wide range of functions for common programming tasks such as manipulating arrays, objects, and strings. Compared to @ckeditor/ckeditor5-utils, Lodash offers a broader set of utilities but does not include CKEditor-specific features like event handling and DOM manipulation.

jquery

jQuery is a fast, small, and feature-rich JavaScript library that simplifies HTML document traversal and manipulation, event handling, and animation. While jQuery offers powerful DOM manipulation and event handling capabilities similar to @ckeditor/ckeditor5-utils, it is a larger library and includes many features that may not be necessary for all projects.

eventemitter3

EventEmitter3 is a high-performance event emitter for Node.js and the browser. It provides a simple and efficient way to handle events, similar to the EmitterMixin in @ckeditor/ckeditor5-utils. However, EventEmitter3 focuses solely on event handling and does not include other utilities like DOM manipulation or data structures.

README

CKEditor 5 utilities

Various utilities used by CKEditor 5 and its features. This is a sort of CKEditor 5's standard library.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

Documentation

See the @ckeditor/ckeditor5-utils package page in CKEditor 5 documentation.

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

44.0.0 (December 2, 2024)

Release Highlights

We are excited to introduce CKEditor 5 v44.0.0, a release packed with high impact updates designed to enhance your editing experience and simplify access to our premium offers. Here's what’s new:

🚀 Self-service plans: Simplified access to premium features

We are introducing flexible self-service plans that put you in control with full transparency. Now, you can:

• Choose the plan that fits your needs, pay only for what you use, and get started instantly with a commitment-free trial.
• Seamlessly manage your license keys, track usage, and more in the new Customer Portal.

💡 Important for current users:

If you are upgrading to v44.0.0+, ensure a smooth transition by updating your license keys in the editor, as we implemented a new format of the key. To get the new key, visit the Customer Portal. You can also refer to our license key and activation guide for help with logging in to the portal.

📣 The open-source licensing remains unchanged. However, config.licenseKey is now a required property in the editor configuration. Use 'GPL' for installations under the GPL terms. Read more in the update guide.

🔖 Bookmarks: Organize your content with ease

Say hello to Bookmarks, a long-awaited feature that simplifies content navigation within the editor. With this release, you can:

• Add anchors as reference points within text.
• Link to the newly created bookmarks in the editor to navigate to specific locations within complex documents, such as contracts or technical manuals.

📍 Future updates to Bookmarks and the linking experience are planned for the upcoming releases. Follow progress and share your feedback on GitHub.

⚡ Performance improvements: Faster table rendering

The current release includes another stride towards improving the performance aspect of the editor, this time focusing on how tables are handled in the content. Implemented optimizations have made table rendering 3x faster, with the average load time of a document with a very long, complex tables dropping from around 4.5 seconds to just 1.5 seconds.