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

Documentation

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

Installation

npm install ckeditor5

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 or https://ckeditor.com/legal/ckeditor-oss-license.