AbstractCreates a new instance of the editor class.
Usually, not to be used directly. See the static module:core/editor/editor~Editor.create create() method.
Optionalconfig: EditorConfig
The editor configuration.
Protected Readonly_The editor context. When it is not provided through the configuration, the editor creates it.
Protected Readonly_A set of lock IDs for the #isReadOnly getter.
Protected Readonly_Holds attributes keys that were passed in
module:core/editor/editorconfig~EditorConfig#roots config.roots.<rootName>.modelAttributes
or module:core/editor/editorconfig~EditorConfig#root config.root.modelAttributes.
ReadonlyaccessibilityA namespace for the accessibility features of the editor.
ReadonlycommandsCommands registered to the editor.
Use the shorthand #execute editor.execute() method to execute commands:
// Execute the bold command:
editor.execute( 'bold' );
// Check the state of the bold command:
editor.commands.get( 'bold' ).value;
ReadonlyconfigStores all configurations specific to this editor instance.
editor.config.get( 'image.toolbar' );
// -> [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ]
ReadonlyconversionConversion manager through which you can register model-to-view and view-to-model converters.
See the module:engine/conversion/conversion~Conversion documentation to learn how to add converters.
ReadonlydataThe module:engine/controller/datacontroller~DataController data controller. Used e.g. for setting and retrieving the editor data.
ReadonlyeditingThe module:engine/controller/editingcontroller~EditingController editing controller. Controls user input and rendering the content for editing.
ReadonlyidReadonlykeystrokesAn instance of the module:core/editingkeystrokehandler~EditingKeystrokeHandler.
It allows setting simple keystrokes:
// Execute the bold command on Ctrl+E:
editor.keystrokes.set( 'Ctrl+E', 'bold' );
// Execute your own callback:
editor.keystrokes.set( 'Ctrl+E', ( data, cancel ) => {
console.log( data.keyCode );
// Prevent the default (native) action and stop the underlying keydown event
// so no other editor feature will interfere.
cancel();
} );
Note: Certain typing-oriented keystrokes (like Backspace or Enter) are handled
by a low-level mechanism and trying to listen to them via the keystroke handler will not work reliably.
To handle these specific keystrokes, see the events fired by the
module:engine/view/document~ViewDocument editing view document (editor.editing.view.document).
ReadonlylocaleThe locale instance.
ReadonlymodelThe editor's model.
The central point of the editor's abstract data model.
ReadonlypluginsThe plugins loaded and in use by this editor instance.
editor.plugins.get( 'ClipboardPipeline' ); // -> An instance of the clipboard pipeline plugin.
Indicates the editor life-cycle state.
The editor is in one of the following states:
initializing – During the editor initialization (before
module:core/editor/editor~Editor.create Editor.create()) finished its job.ready – After the promise returned by the module:core/editor/editor~Editor.create Editor.create()
method is resolved.destroyed – Once the #destroy editor.destroy() method was called.ReadonlytShorthand for module:utils/locale~Locale#t.
Static OptionalbuiltinAn array of plugins built into this editor class.
It is used in the now deprecated CKEditor 5 builds to provide a list of plugins which are later automatically initialized during the editor initialization.
They will be automatically initialized by the editor, unless listed in config.removePlugins and
unless config.plugins is passed.
// Build some plugins into the editor class first.
ClassicEditor.builtinPlugins = [ FooPlugin, BarPlugin ];
// Normally, you need to define config.plugins, but since ClassicEditor.builtinPlugins was
// defined, now you can call create() without any configuration.
ClassicEditor
.create( sourceElement )
.then( editor => {
editor.plugins.get( FooPlugin ); // -> An instance of the Foo plugin.
editor.plugins.get( BarPlugin ); // -> An instance of the Bar plugin.
} );
ClassicEditor
.create( {
// Do not initialize these plugins (note: it is defined by a string):
removePlugins: [ 'Foo' ]
} )
.then( editor => {
editor.plugins.get( FooPlugin ); // -> Undefined.
editor.config.get( BarPlugin ); // -> An instance of the Bar plugin.
} );
ClassicEditor
.create( {
// Load only this plugin. It can also be defined by a string if
// this plugin was built into the editor class.
plugins: [ FooPlugin ]
} )
.then( editor => {
editor.plugins.get( FooPlugin ); // -> An instance of the Foo plugin.
editor.config.get( BarPlugin ); // -> Undefined.
} );
See also module:core/editor/editor~Editor.defaultConfig.
StaticContextThe module:core/context~Context class.
Exposed as static editor field for easier access in editor builds.
StaticContextThe module:watchdog/contextwatchdog~ContextWatchdog class.
Exposed as static editor field for easier access in editor builds.
Static OptionaldefaultThe default configuration which is built into the editor class.
It was used in the now deprecated CKEditor 5 builds to provide the default configuration options which are later used during the editor initialization.
ClassicEditor.defaultConfig = {
foo: 1,
bar: 2
};
ClassicEditor
.create( sourceElement )
.then( editor => {
editor.config.get( 'foo' ); // -> 1
editor.config.get( 'bar' ); // -> 2
} );
// The default options can be overridden by the configuration passed to create().
ClassicEditor
.create( { bar: 3 } )
.then( editor => {
editor.config.get( 'foo' ); // -> 1
editor.config.get( 'bar' ); // -> 3
} );
See also module:core/editor/editor~Editor.builtinPlugins.
StaticEditorThe module:watchdog/editorwatchdog~EditorWatchdog class.
Exposed as static editor field for easier access in editor builds.
Defines whether the editor is in the read-only mode.
In read-only mode the editor #commands commands are disabled so it is not possible to modify the document by using them. Also, the editable element(s) become non-editable.
In order to make the editor read-only, you need to call the #enableReadOnlyMode method:
editor.enableReadOnlyMode( 'feature-id' );
Later, to turn off the read-only mode, call #disableReadOnlyMode:
editor.disableReadOnlyMode( 'feature-id' );
AbstractuiThe editor UI instance.
Protected_Optionalname: stringDestroys the editor instance, releasing all resources used by it.
Note The editor cannot be destroyed during the initialization phase so if it is called while the editor #state is being initialized, it will wait for the editor initialization before destroying it.
A promise that resolves once the editor instance is fully destroyed.
Removes the read-only lock from the editor with given lock ID.
When no lock is present on the editor anymore, then the #isReadOnly isReadOnly property will be set to false.
The lock ID for setting the editor to the read-only state.
Turns on the read-only mode in the editor.
Editor can be switched to or out of the read-only mode by many features, under various circumstances. The editor supports locking mechanism for the read-only mode. It enables easy control over the read-only mode when many features wants to turn it on or off at the same time, without conflicting with each other. It guarantees that you will not make the editor editable accidentally (which could lead to errors).
Each read-only mode request is identified by a unique id (also called "lock"). If multiple plugins requested to turn on the read-only mode, then, the editor will become editable only after all these plugins turn the read-only mode off (using the same ids).
Note, that you cannot force the editor to disable the read-only mode if other plugins set it.
After the first enableReadOnlyMode() call, the #isReadOnly isReadOnly property will be set to true:
editor.isReadOnly; // `false`.
editor.enableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `true`.
You can turn off the read-only mode ("clear the lock") using the #disableReadOnlyMode disableReadOnlyMode() method:
editor.enableReadOnlyMode( 'my-feature-id' );
// ...
editor.disableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `false`.
All "locks" need to be removed to enable editing:
editor.enableReadOnlyMode( 'my-feature-id' );
editor.enableReadOnlyMode( 'my-other-feature-id' );
// ...
editor.disableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `true`.
editor.disableReadOnlyMode( 'my-other-feature-id' );
editor.isReadOnly; // `false`.
A unique ID for setting the editor to the read-only state.
Executes the specified command with given parameters.
Shorthand for:
editor.commands.get( commandName ).execute( ... );
The name of the command to execute.
Command parameters.
The value returned by the module:core/commandcollection~CommandCollection#execute commands.execute().
Focuses the editor.
Note To explicitly focus the editing area of the editor, use the
module:engine/view/view~EditingView#focus editor.editing.view.focus() method of the editing view.
Check out the {@glink framework/deep-dive/ui/focus-tracking#focus-in-the-editor-ui Focus in the editor UI} section of the {@glink framework/deep-dive/ui/focus-tracking Deep dive into focus tracking} guide to learn more.
Gets the data from the editor.
editor.getData(); // -> '<p>This is editor!</p>'
If your editor implementation uses multiple roots, you should pass root name as one of the options:
editor.getData( { rootName: 'header' } ); // -> '<p>Content for header part.</p>'
By default, the editor outputs HTML. This can be controlled by injecting a different data processor. See the {@glink features/markdown Markdown output} guide for more details.
A warning is logged when you try to retrieve data for a detached root, as most probably this is a mistake. A detached root should be treated like it is removed, and you should not save its data. Note, that the detached root data is always an empty string.
Optionaloptions: { rootName?: string; trim?: "empty" | "none"; [key: string]: unknown }
Additional configuration for the retrieved data. Editor features may introduce more configuration options that can be set through this parameter.
OptionalrootName?: stringRoot name. Defaults to 'main'.
Optionaltrim?: "empty" | "none"Whether returned data should be trimmed. This option is set to 'empty' by default,
which means that whenever editor content is considered empty, an empty string is returned. To turn off trimming
use 'none'. In such cases exact content will be returned (for example '<p> </p>' for an empty editor).
Output data.
Returns attributes for the specified root. If no root name is provided, it returns attributes for the 'main' root by default.
Note: all and only ~Editor#registerRootAttribute registered roots attributes will be returned.
If a registered root attribute is not set for a given root, null will be returned.
OptionalrootName: stringLoads and initializes plugins specified in the configuration.
A promise which resolves once the initialization is completed, providing an array of loaded plugins.
Registers a given string as a root attribute key. Registered root attributes are added to the module:engine/model/schema~ModelSchema schema.
Note: Attributes passed in the configuration for multi-root editors
(module:core/editor/editorconfig~EditorConfig#roots config.roots.<rootName>.modelAttributes) or
single-root editors (module:core/editor/editorconfig~EditorConfig#root config.root.modelAttributes)
are automatically registered when the editor is initialized. However, registering the same attribute twice
does not have any negative impact, so it is recommended to use this method in any feature that uses
root attributes.
Note: Registered attributes are attached only to the generic $root schema element. A custom root
module:core/editor/editorconfig~RootConfig#modelElement modelElement must opt into the $root
attribute chain via allowAttributesOf: '$root' to inherit these attributes.
See the {@glink framework/deep-dive/schema#custom-root-elements Custom root elements} section of the
{@glink framework/deep-dive/schema Schema deep-dive} guide for more details.
Sets the data in the editor.
editor.setData( '<p>This is editor!</p>' );
If your editor implementation uses multiple roots, you should pass an object with keys corresponding to the editor root names and values equal to the data that should be set in each root:
editor.setData( {
header: '<p>Content for header part.</p>',
content: '<p>Content for main part.</p>',
footer: '<p>Content for footer part.</p>'
} );
By default the editor accepts HTML. This can be controlled by injecting a different data processor. See the {@glink features/markdown Markdown output} guide for more details.
Input data.
StaticcreateCreates and initializes a new editor instance.
This is an abstract method. Every editor type needs to implement its own initialization logic.
See the create() methods of the existing editor types to learn how to use them:
ClassicEditor.create()BalloonEditor.create()DecoupledEditor.create()InlineEditor.create()
The class representing a basic, generic editor.
Check out the list of its subclasses to learn about specific editor implementations.
All editor implementations (like module:editor-classic/classiceditor~ClassicEditor or module:editor-inline/inlineeditor~InlineEditor) should extend this class. They can add their own methods and properties.
When you are implementing a plugin, this editor represents the API which your plugin can expect to get when using its module:core/plugin~Plugin#editor property.
This API should be sufficient in order to implement the "editing" part of your feature (schema definition, conversion, commands, keystrokes, etc.). It does not define the editor UI, which is available only if the specific editor implements also the ~Editor#ui property (as most editor implementations do).