Home/CKEditor 5/API

Editor (core/editor)

@ckeditor/ckeditor5-core/src/editor/editor

class

Hierarchy

Observable
- Editor

Subclasses

MultiRootEditor

See source

The class representing a basic, generic editor.

Check out the list of its subclasses to learn about specific editor implementations.

All editor implementations (like ClassicEditor or 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 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 ui property (as most editor implementations do).

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

readonly
accessibility : Accessibility

See source
A namespace for the accessibility features of the editor.
readonly
commands : CommandCollection
See source
Commands registered to the editor.

Use the shorthand 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;
```
readonly
config : Config<EditorConfig>
See source
Stores all configurations specific to this editor instance.
```
editor.config.get( 'image.toolbar' );
// -> [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ]
```
readonly
conversion : Conversion

See source
Conversion manager through which you can register model-to-view and view-to-model converters.

See the Conversion documentation to learn how to add converters.
readonly
data : DataController

See source
The data controller. Used e.g. for setting and retrieving the editor data.
readonly
editing : EditingController

See source
The editing controller. Controls user input and rendering the content for editing.
readonly
id : string

See source
isReadOnly : boolean
See source
Defines whether the editor is in the read-only mode.

In read-only mode the editor 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' );
```
Parameters

value : boolean
readonly
keystrokes : EditingKeystrokeHandler
See source
An instance of the 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 editing view document (editor.editing.view.document).
readonly
locale : Locale

See source
The locale instance.
readonly
model : Model

See source
The editor's model.

The central point of the editor's abstract data model.
readonly
plugins : PluginCollection<Editor>
See source
The plugins loaded and in use by this editor instance.
```
editor.plugins.get( 'ClipboardPipeline' ); // -> An instance of the clipboard pipeline plugin.
```
observable
state : 'ready' | 'initializing' | 'destroyed'
See source
Indicates the editor life-cycle state.

The editor is in one of the following states:
- initializing – During the editor initialization (before Editor.create()) finished its job.
- ready – After the promise returned by the Editor.create() method is resolved.
- destroyed – Once the editor.destroy() method was called.
readonly
t : LocaleTranslate
See source
Shorthand for t.

Related:
- Locale#t
readonly
ui : EditorUI

See source
The editor UI instance.
protected readonly
_context : Context

See source
The editor context. When it is not provided through the configuration, the editor creates it.
protected readonly
_readOnlyLocks : Set<string | symbol>

See source
A set of lock IDs for the isReadOnly getter.

Static properties

static
Context : default

See source
The Context class.

Exposed as static editor field for easier access in editor builds.
static
ContextWatchdog : default

See source
The ContextWatchdog class.

Exposed as static editor field for easier access in editor builds.
static
EditorWatchdog : default

See source
The EditorWatchdog class.

Exposed as static editor field for easier access in editor builds.

static
`builtinPlugins : Array<PluginConstructor<Editor>> | undefined`

See source

An array of plugins built into this editor class.

It is used in 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( sourceElement, {
		// 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( sourceElement, {
		// 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.
	} );

static
`defaultConfig : EditorConfig | undefined`

See source

The default configuration which is built into the editor class.

It is used in 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( sourceElement, { bar: 3 } )
	.then( editor => {
		editor.config.get( 'foo' ); // -> 1
		editor.config.get( 'bar' ); // -> 3
	} );

Methods

constructor( config )

See source
Creates a new instance of the editor class.

Usually, not to be used directly. See the static create() method.

Parameters

config : EditorConfig

The editor configuration.

Defaults to {}
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Editor[ K1 ], K2, Editor[ K2 ]>
See source
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Type parameters

K1

K2

Parameters

bindProperty1 : K1

Observable property that will be bound to other observable(s).

bindProperty2 : K2

Observable property that will be bound to other observable(s).

Returns

DualBindChain<K1, Editor[ K1 ], K2, Editor[ K2 ]>

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperties ) → MultiBindChain
See source
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Parameters

bindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'execute' | 'plugins' | 'ui' | 'isReadOnly' | 'editing' | 'model' | 'keystrokes' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins'>

Observable properties that will be bound to other observable(s).

Returns

MultiBindChain

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperty ) → SingleBindChain<K, Editor[ K ]>
See source
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Type parameters

K

Parameters

bindProperty : K

Observable property that will be bound to other observable(s).

Returns

SingleBindChain<K, Editor[ K ]>

The bind chain with the to() and toMany() methods.
inherited
decorate( methodName ) → void
See source
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be stopped:
```
class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```
Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Finally, it is possible to access and modify the arguments the method is called with:
```
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```
Parameters

methodName : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'execute' | 'plugins' | 'ui' | 'isReadOnly' | 'editing' | 'model' | 'keystrokes' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins'

Name of the method to decorate.

Returns

void
inherited
delegate( events ) → EmitterMixinDelegateChain
See source
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
destroy() → Promise<unknown>
See source
Destroys 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 is being initialized, it will wait for the editor initialization before destroying it.

Returns

Promise<unknown>

A promise that resolves once the editor instance is fully destroyed.

Fires
- destroy
disableReadOnlyMode( lockId ) → void

See source
Removes the read-only lock from the editor with given lock ID.

When no lock is present on the editor anymore, then the isReadOnly property will be set to false.

Parameters

lockId : string | symbol

The lock ID for setting the editor to the read-only state.

Returns

void
enableReadOnlyMode( lockId ) → void
See source
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 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() 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`.
```
Parameters

lockId : string | symbol

A unique ID for setting the editor to the read-only state.

Returns

void
execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>
See source
Executes the specified command with given parameters.

Shorthand for:
```
editor.commands.get( commandName ).execute( ... );
```
Type parameters

TName : extends string

Parameters

commandName : TName

The name of the command to execute.

commandParams : Parameters<CommandsMap[ TName ][ 'execute' ]>

Command parameters.

Returns

ReturnType<CommandsMap[ TName ][ 'execute' ]>

The value returned by the commands.execute().
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

See source
Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

eventOrInfo : GetNameOrEventInfo<TEvent>

The name of the event or EventInfo object if event is delegated.

args : TEvent[ 'args' ]

Additional arguments to be passed to the callbacks.

Returns

GetEventInfo<TEvent>[ 'return' ]

By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).
focus() → void

See source
Focuses the editor.

Note To explicitly focus the editing area of the editor, use the editor.editing.view.focus() method of the editing view.

Check out the Focus in the editor UI section of the Deep dive into focus tracking guide to learn more.

Returns

void
getData( [ options ] = { [options.rootName], [options.trim], options[key: string] } ) → string
See source
Gets the data from the editor.
```
editor.getData(); // -> 'This is editor!'
```
If your editor implementation uses multiple roots, you should pass root name as one of the options:
```
editor.getData( { rootName: 'header' } ); // -> 'Content for header part.'
```
By default, the editor outputs HTML. This can be controlled by injecting a different data processor. See the 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.

Parameters

[ options ] : object

Additional configuration for the retrieved data. Editor features may introduce more configuration options that can be set through this parameter.

Properties

[ options.rootName ] : string

Root name. Defaults to 'main'.

[ options.trim ] : 'none' | 'empty'

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 ' ' for an empty editor).

options[key: string] : unknown

Returns

string

Output data.
initPlugins() → Promise<LoadedPlugins>

See source
Loads and initializes plugins specified in the configuration.

Returns

Promise<LoadedPlugins>

A promise which resolves once the initialization is completed, providing an array of loaded plugins.
inherited
listenTo( emitter, event, callback, [ options ] ) → void
See source
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.
```
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```
An event callback can stop the event and set the return value of the fire method.

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

emitter : Emitter

The object that fires the event.

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
inherited
off( event, callback ) → void

See source
Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

Parameters

event : string

The name of the event.

callback : Function

The function to stop being called.

Returns

void
inherited
on( event, callback, [ options ] ) → void

See source
Registers a callback function to be executed when an event is fired.

Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
inherited
once( event, callback, [ options ] ) → void

See source
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
inherited
set( values ) → void
See source
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

It accepts a single object literal containing key/value pairs with properties to be set.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
```
Parameters

values : object

An object with name=>value pairs.

Returns

void
inherited
set( name, value ) → void
See source
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

In TypeScript, those properties should be declared in class using declare keyword. In example:
```
public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
```
Type parameters

K

Parameters

name : K

The property's name.

value : Editor[ K ]

The property's value.

Returns

void
setData( data ) → void
See source
Sets the data in the editor.
```
editor.setData( 'This is editor!' );
```
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: 'Content for header part.',
 content: 'Content for main part.',
 footer: 'Content for footer part.'
} );
```
By default the editor accepts HTML. This can be controlled by injecting a different data processor. See the Markdown output guide for more details.

Parameters

data : string | Record<string, string>

Input data.

Returns

void
inherited
stopDelegating( [ event ], [ emitter ] ) → void
See source
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
Parameters

[ event ] : string

The name of the event to stop delegating. If omitted, stops it all delegations.

[ emitter ] : Emitter

(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

Returns

void
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
See source
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
Parameters

[ emitter ] : Emitter

The object to stop listening to. If omitted, stops it for all objects.

[ event ] : string

(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

[ callback ] : Function

(Requires the event) The function to be removed from the call list for the given event.

Returns

void
inherited
unbind( unbindProperties ) → void
See source
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Parameters

unbindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'execute' | 'plugins' | 'ui' | 'isReadOnly' | 'editing' | 'model' | 'keystrokes' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins'>

Observable properties to be unbound. All the bindings will be released if no properties are provided.

Returns

void
private
_sendUsageRequest( endpoint, request ) → Promise<any>

See source
This part of the code is not executed in installations under the GPL license (with config.licenseKey = 'GPL'). * It is only executed when a specific license key is provided. If you are uncertain whether this applies to your installation, please contact our support team.

Parameters

endpoint : string

request : unknown

Returns

Promise<any>
private
_showLicenseError( reason, [ pluginName ] ) → void

See source

Parameters

reason : LicenseErrorReason

[ pluginName ] : string

Returns

void

Static methods

static
create( args ) → void
See source
Creates 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:
Parameters

args : Array<unknown>

Returns

void

Events

change:isReadOnly( eventInfo, name, value, oldValue )

See source
Fired when the isReadOnly property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isReadOnly).

value : boolean

New value of the isReadOnly property with given key or null, if operation should remove property.

oldValue : boolean

Old value of the isReadOnly property with given key or null, if property was not set before.
change:state( eventInfo, name, value, oldValue )

See source
Fired when the state property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (state).

value : 'ready' | 'initializing' | 'destroyed'

New value of the state property with given key or null, if operation should remove property.

oldValue : 'ready' | 'initializing' | 'destroyed'

Old value of the state property with given key or null, if property was not set before.
inherited
change:{property}( eventInfo, name, value, oldValue )
See source
Fired when a property changed value.
```
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```
Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

The property name.

value : TValue

The new property value.

oldValue : TValue

The previous property value.
collectUsageData( eventInfo, <anonymous> = { .setUsageData } )

See source
Fired when the editor is about to collect usage data.

This event is fired when the editor is about to collect usage data. It allows plugins to provide additional data for the usage statistics. The usage data is collected by the editor and sent to the usage tracking server. All plugins are expected to be ready at this point.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : object

Properties

<anonymous>.setUsageData : void
destroy( eventInfo )

See source
Fired when this editor instance is destroyed. The editor at this point is not usable and this event should be used to perform the clean-up in any plugin.

See also the editor.state property.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
ready( eventInfo )

See source
Fired when the data and all additional editor components are ready.

Note: This event is most useful for plugin developers. When integrating the editor with your website or application, you do not have to listen to editor#ready because when the promise returned by the static Editor.create() event is resolved, the editor is already ready. In fact, since the first moment when the editor instance is available to you is inside then()'s callback, you cannot even add a listener to the editor#ready event.

See also the editor.state property.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
set:isReadOnly( eventInfo, name, value, oldValue )

See source
Fired when the isReadOnly property is going to be set but is not set yet (before the change event is fired).

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isReadOnly).

value : boolean

New value of the isReadOnly property with given key or null, if operation should remove property.

oldValue : boolean

Old value of the isReadOnly property with given key or null, if property was not set before.
set:state( eventInfo, name, value, oldValue )

See source
Fired when the state property is going to be set but is not set yet (before the change event is fired).

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (state).

value : 'ready' | 'initializing' | 'destroyed'

New value of the state property with given key or null, if operation should remove property.

oldValue : 'ready' | 'initializing' | 'destroyed'

Old value of the state property with given key or null, if property was not set before.
inherited
set:{property}( eventInfo, name, value, oldValue )
See source
Fired when a property value is going to be set but is not set yet (before the change event is fired).

You can control the final value of the property by using the event's return property.
```
observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
 // -> 'Current property value is 1'
 // -> 'Value has changed from 1 to 3'
```
Note: The event is fired even when the new value is the same as the old value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

The property name.

value : TValue

The new property value.

oldValue : TValue

The previous property value.

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.

Editor (core/editor)

Filtering

Properties

readonly accessibility : Accessibilitymodule:core/editor/editor~Editor#accessibility

readonly commands : CommandCollectionmodule:core/editor/editor~Editor#commands

readonly config : Config<EditorConfig>module:core/editor/editor~Editor#config

readonly conversion : Conversionmodule:core/editor/editor~Editor#conversion

readonly data : DataControllermodule:core/editor/editor~Editor#data

readonly editing : EditingControllermodule:core/editor/editor~Editor#editing

readonly id : stringmodule:core/editor/editor~Editor#id

isReadOnly : booleanmodule:core/editor/editor~Editor#isReadOnly

Parameters

readonly keystrokes : EditingKeystrokeHandlermodule:core/editor/editor~Editor#keystrokes

readonly locale : Localemodule:core/editor/editor~Editor#locale

readonly model : Modelmodule:core/editor/editor~Editor#model

readonly plugins : PluginCollection<Editor>module:core/editor/editor~Editor#plugins

observable state : 'ready' | 'initializing' | 'destroyed'module:core/editor/editor~Editor#state

readonly t : LocaleTranslatemodule:core/editor/editor~Editor#t

Related:

readonly ui : EditorUImodule:core/editor/editor~Editor#ui

protected readonly _context : Contextmodule:core/editor/editor~Editor#_context

protected readonly _readOnlyLocks : Set<string | symbol>module:core/editor/editor~Editor#_readOnlyLocks

Static properties

static Context : defaultmodule:core/editor/editor~Editor.Context

static ContextWatchdog : defaultmodule:core/editor/editor~Editor.ContextWatchdog

static EditorWatchdog : defaultmodule:core/editor/editor~Editor.EditorWatchdog

static builtinPlugins : Array<PluginConstructor<Editor>> | undefinedmodule:core/editor/editor~Editor.builtinPlugins

static defaultConfig : EditorConfig | undefinedmodule:core/editor/editor~Editor.defaultConfig

readonly static editorName : `${ string }Editor`module:core/editor/editor~Editor.editorName

Methods

constructor( config )module:core/editor/editor~Editor#constructor

Parameters

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Editor[ K1 ], K2, Editor[ K2 ]>module:core/editor/editor~Editor#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperties ) → MultiBindChainmodule:core/editor/editor~Editor#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, Editor[ K ]>module:core/editor/editor~Editor#bind:SINGLE_BIND

Type parameters

Parameters

Returns

inherited decorate( methodName ) → voidmodule:core/editor/editor~Editor#decorate

Parameters

Returns

inherited delegate( events ) → EmitterMixinDelegateChainmodule:core/editor/editor~Editor#delegate

Parameters

Returns

destroy() → Promise<unknown>module:core/editor/editor~Editor#destroy

Returns

Fires

disableReadOnlyMode( lockId ) → voidmodule:core/editor/editor~Editor#disableReadOnlyMode

Parameters

Returns

enableReadOnlyMode( lockId ) → voidmodule:core/editor/editor~Editor#enableReadOnlyMode

Parameters

Returns

execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>module:core/editor/editor~Editor#execute

Type parameters

Parameters

Returns

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:core/editor/editor~Editor#fire

Type parameters

Parameters

Returns

focus() → voidmodule:core/editor/editor~Editor#focus

Returns

getData( [ options ] = { [options.rootName], [options.trim], options[key: string] } ) → stringmodule:core/editor/editor~Editor#getData

Parameters

Returns

initPlugins() → Promise<LoadedPlugins>module:core/editor/editor~Editor#initPlugins

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:core/editor/editor~Editor#listenTo:BASE_EMITTER

Type parameters

Parameters

Returns

inherited off( event, callback ) → voidmodule:core/editor/editor~Editor#off

Parameters

Returns

readonly
`accessibility : Accessibility`

readonly
`commands : CommandCollection`

readonly
`config : Config<EditorConfig>`

readonly
`conversion : Conversion`

readonly
`data : DataController`

readonly
`editing : EditingController`

readonly
`id : string`

`isReadOnly : boolean`

readonly
`keystrokes : EditingKeystrokeHandler`

readonly
`locale : Locale`

readonly
`model : Model`

readonly
`plugins : PluginCollection<Editor>`

observable
`state : 'ready' | 'initializing' | 'destroyed'`

readonly
`t : LocaleTranslate`

readonly
`ui : EditorUI`

protected readonly
`_context : Context`

protected readonly
`_readOnlyLocks : Set<string | symbol>`

static
`Context : default`

static
`ContextWatchdog : default`

static
`EditorWatchdog : default`

static
`builtinPlugins : Array<PluginConstructor<Editor>> | undefined`

static
`defaultConfig : EditorConfig | undefined`

readonly static
editorName : `${ string }Editor`

`constructor( config )`

inherited
`bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Editor[ K1 ], K2, Editor[ K2 ]>`

inherited
`bind( bindProperties ) → MultiBindChain`

inherited
`bind( bindProperty ) → SingleBindChain<K, Editor[ K ]>`

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → Promise<unknown>`

`disableReadOnlyMode( lockId ) → void`

`enableReadOnlyMode( lockId ) → void`

`execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>`

inherited
`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`

`focus() → void`

`getData( [ options ] = { [options.rootName], [options.trim], options[key: string] } ) → string`

`initPlugins() → Promise<LoadedPlugins>`

inherited
`listenTo( emitter, event, callback, [ options ] ) → void`

inherited
`off( event, callback ) → void`

inherited
`on( event, callback, [ options ] ) → void`

inherited
`once( event, callback, [ options ] ) → void`

inherited
`set( values ) → void`

inherited
`set( name, value ) → void`

`setData( data ) → void`

inherited
`stopDelegating( [ event ], [ emitter ] ) → void`

inherited
`stopListening( [ emitter ], [ event ], [ callback ] ) → void`

inherited
`unbind( unbindProperties ) → void`

private
`_sendUsageRequest( endpoint, request ) → Promise<any>`

private
`_showLicenseError( reason, [ pluginName ] ) → void`

static
`create( args ) → void`

`change:isReadOnly( eventInfo, name, value, oldValue )`

`change:state( eventInfo, name, value, oldValue )`

inherited
`change:{property}( eventInfo, name, value, oldValue )`

`collectUsageData( eventInfo, <anonymous> = { .setUsageData } )`

`destroy( eventInfo )`

`ready( eventInfo )`

`set:isReadOnly( eventInfo, name, value, oldValue )`

`set:state( eventInfo, name, value, oldValue )`

inherited
`set:{property}( eventInfo, name, value, oldValue )`