CKEditor 5 widget API
This package implements the widget API for CKEditor 5.
The API consists of a few primitives and helpers that make it easy to implement rich content units such as images with captions.
# Documentation
Browse the API documentation of this package by using the module tree on the left.
The widget API consists of two layers:
- The
Widgetplugin which enables base support for this feature. Usually, your plugin which implements a specific widget will define its reliance on theWidgetplugin via itsPlugin.requiresproperty. - The
toWidget()toWidgetEditable()functions which need to be used during the conversion in order to make a specific element either a widget or a widget’s nested editable. See their documentation for more details.
Besides the above mentioned core functionalities, this package implements the following utils:
- The
WidgetToolbarRepositoryplugin which exposes a nice API for registering widget toolbars. - A couple of helper functions for managing widgets in the
@ckeditor/ckeditor5-widget/utilsmodule.
The widget API is proposed in a very different way than it was in CKEditor 4. It is just a set of utilities that allow you to implement typical object-like entities. Most of the work actually happens in the engine and this API’s role is only to properly conduct the engine.
# Installation
npm install --save @ckeditor/ckeditor5-widget
# Contribute
The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-widget.