|
|
@@ -6,18 +6,18 @@ category: api-reference
|
|
|
|
|
|
[](https://www.npmjs.com/package/@ckeditor/ckeditor5-widget)
|
|
|
|
|
|
-This package implements widget API for CKEditor 5.
|
|
|
+This package implements the 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.
|
|
|
+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.
|
|
|
|
|
|
<info-box>
|
|
|
- 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.
|
|
|
+ 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 {@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).
|
|
|
+ Therefore, this is just one of the ways how widgets can be proposed. This API can be expected 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 at this stage).
|
|
|
</info-box>
|
|
|
|
|
|
## Installation
|