widget.md 1.6 KB


category: api-reference

CKEditor 5 widget API

npm version

This package implements widget API for CKEditor 5.

The API consists of a couple of primitives and helpers which make it easy to implement rich content units such as images with caption.

Documentation

Browse the API documentation of this package by using the module tree on the left.

The widget API is proposed in a very different way than what you might remember from CKEditor 4. It is just a set of utils which allows you to implement typical object-like entities. Most of the work actually happens in the {@link api/engine engine} and this API's role is only to properly conduct the engine.

Therefore, this is just one of the ways how widgets can be proposed. We expect this API to change (grow) and for now, the only available documentation is in the {@link module:image/image/imageengine~ImageEngine}'s code (which is the only widget API consumer for now).

Installation

npm install --save @ckeditor/ckeditor5-widget

Contribute

The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-widget.

External links