Editor (core/editor)

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

class

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 EditorWithUI interface (as most editor implementations do).

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

commands : CommandCollection

readonly
Commands registered to the editor.

See source
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;
```
config : Config

readonly
Stores all configurations specific to this editor instance.

See source
```
editor.config.get( 'image.toolbar' );
// -> [ 'imageStyle:full', 'imageStyle:side', '|', 'imageTextAlternative' ]
```
conversion : Conversion

readonly

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

See source

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

readonly

The data controller. Used e.g. for setting and retrieving the editor data.

See source
editing : EditingController

readonly

The editing controller. Controls user input and rendering the content for editing.

See source
isReadOnly : Boolean

observable
Defines whether this editor is in read-only mode.

See source
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 can set this value directly:
```
editor.isReadOnly = true;
```
keystrokes : EditingKeystrokeHandler

readonly
An instance of the EditingKeystrokeHandler.

See source
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).
locale : Locale

readonly
model : Model

readonly

The editor's model.

See source

The central point of the editor's abstract data model.
plugins : PluginCollection

readonly
The plugins loaded and in use by this editor instance.

See source
```
editor.plugins.get( 'Clipboard' ); // -> An instance of the clipboard plugin.
```
state : 'initializing' | 'ready' | 'destroyed'

observable
Indicates the editor life-cycle state.

See source
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.
_context : Context

protected

The editor context. When it is not provided through the configuration, the editor creates it.

See source

Static properties

`builtinPlugins : Array.<Function>`

static

An array of plugins built into this editor class.

See source

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.
    } );

`defaultConfig : Object`

static

The default configuration which is built into the editor class.

See source

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 ] )

Creates a new instance of the editor class.

See source

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

Parameters

[ config ] : Object

The editor configuration.

Defaults to {}
bind( bindProperties ) → Object

mixed
Binds observable properties to other objects implementing the Observable interface.

See source
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 );
```
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 : String

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

Returns

Object

The bind chain with the to() and toMany() methods.
decorate( methodName )

mixed
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.

See source
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 {
    constructor() {
        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 : String

Name of the method to decorate.
delegate( events ) → EmitterMixinDelegateChain

mixed
Delegates selected events to another Emitter. For instance:

See source
```
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 : String

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
destroy() → Promise
Destroys the editor instance, releasing all resources used by it.

See source
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

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

Fires
- destroy
execute( commandName, [ ...commandParams ] )
Executes the specified command with given parameters.

See source
Shorthand for:
```
editor.commands.get( commandName ).execute( ... );
```
Parameters

commandName : String

The name of the command to execute.

[ ...commandParams ] : *

Command parameters.
fire( eventOrInfo, [ args ] ) → *

mixed

Fires an event, executing all callbacks registered for it.

See source

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

Parameters

eventOrInfo : String | EventInfo

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

[ args ] : *

Additional arguments to be passed to the callbacks.

Returns

*

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).
initPlugins() → Promise.<LoadedPlugins>

Loads and initializes plugins specified in the configuration.

See source

Returns

Promise.<LoadedPlugins>

A promise which resolves once the initialization is completed, providing an array of loaded plugins.
listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

mixed
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

See source
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.

Parameters

emitter : Emitter

The object that fires the event.

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
off( event, callback )

mixed

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

See source

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.
on( event, callback, [ options ] = { [options.priority] } )

mixed

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

See source

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

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
once( event, callback, [ options ] = { [options.priority] } )

mixed

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.

See source

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
set( name, [ value ] )

mixed

Creates and sets the value of an observable property of this object. Such an property becomes a part of the state and is be observable.

See source

It accepts also 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 have 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.

Parameters

name : String | Object

The property's name or object with name=>value pairs.

[ value ] : *

The property's value (if name was passed in the first parameter).
stopDelegating( [ event ], [ emitter ] )

mixed
Stops delegating events. It can be used at different levels:

See source
- 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.
stopListening( [ emitter ], [ event ], [ callback ] )

mixed
Stops listening for events. It can be used at different levels:

See source
- 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.
t()
Shorthand for t.

See source
Related:
- Locale#t
unbind( [ unbindProperties ] )

mixed
Removes the binding created with bind.

See source
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

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

[ unbindProperties ] : String

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

Static methods

create()

static
Creates and initializes a new editor instance.

See source
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:

Events

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

Fired when the isReadOnly property changed value.

See source

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 )

Fired when the state property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (state).

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

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

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

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

mixed
Fired when a property changed value.

See source
```
observable.set( 'prop', 1 );

observable.on( '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 : *

The new property value.

oldValue : *

The previous property value.
destroy( eventInfo )

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 source

See also the editor.state property.

Parameters

eventInfo : EventInfo

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

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

See source

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:{property}( eventInfo, name, value, oldValue )

mixed
Fired when a property value is going to be set but is not set yet (before the change event is fired).

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

observable.on( '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( '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: 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 : *

The new property value.

oldValue : *

The previous property value.

Editor (core/editor)

Filtering

Properties

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

config : Configmodule:core/editor/editor~Editor#config

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

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

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

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

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

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

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

plugins : PluginCollectionmodule:core/editor/editor~Editor#plugins

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

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

Static properties

builtinPlugins : Array.<Function>module:core/editor/editor~Editor.builtinPlugins

defaultConfig : Objectmodule:core/editor/editor~Editor.defaultConfig

Methods

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

Parameters

bind( bindProperties ) → Objectmodule:core/editor/editor~Editor#bind

Parameters

Returns

decorate( methodName )module:core/editor/editor~Editor#decorate

Parameters

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

Parameters

Returns

destroy() → Promisemodule:core/editor/editor~Editor#destroy

Returns

Fires

execute( commandName, [ ...commandParams ] )module:core/editor/editor~Editor#execute

Parameters

fire( eventOrInfo, [ args ] ) → *module:core/editor/editor~Editor#fire

Parameters

Returns

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

Returns

listenTo( emitter, event, callback, [ options ] = { [options.priority] } )module:core/editor/editor~Editor#listenTo

Parameters

off( event, callback )module:core/editor/editor~Editor#off

Parameters

on( event, callback, [ options ] = { [options.priority] } )module:core/editor/editor~Editor#on

Parameters

once( event, callback, [ options ] = { [options.priority] } )module:core/editor/editor~Editor#once

Parameters

set( name, [ value ] )module:core/editor/editor~Editor#set

Parameters

stopDelegating( [ event ], [ emitter ] )module:core/editor/editor~Editor#stopDelegating

Parameters

stopListening( [ emitter ], [ event ], [ callback ] )module:core/editor/editor~Editor#stopListening

Parameters

t()module:core/editor/editor~Editor#t

Related:

unbind( [ unbindProperties ] )module:core/editor/editor~Editor#unbind

Parameters

Static methods

create()module:core/editor/editor~Editor.create

Events

change:isReadOnly( eventInfo, name, value, oldValue )module:core/editor/editor~Editor#event:change:isReadOnly

Parameters

change:state( eventInfo, name, value, oldValue )module:core/editor/editor~Editor#event:change:state

Parameters

change:{property}( eventInfo, name, value, oldValue )module:core/editor/editor~Editor#event:change:{property}

Parameters

destroy( eventInfo )module:core/editor/editor~Editor#event:destroy

Parameters

ready( eventInfo )module:core/editor/editor~Editor#event:ready

Parameters

set:{property}( eventInfo, name, value, oldValue )module:core/editor/editor~Editor#event:set:{property}

Parameters

`commands : CommandCollection`

`config : Config`

`conversion : Conversion`

`data : DataController`

`editing : EditingController`

`isReadOnly : Boolean`

`keystrokes : EditingKeystrokeHandler`

`locale : Locale`

`model : Model`

`plugins : PluginCollection`

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

`_context : Context`

`builtinPlugins : Array.<Function>`

`defaultConfig : Object`

`constructor( [ config ] )`

`bind( bindProperties ) → Object`

`decorate( methodName )`

`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → Promise`

`execute( commandName, [ ...commandParams ] )`

`fire( eventOrInfo, [ args ] ) → *`

`initPlugins() → Promise.<LoadedPlugins>`

`listenTo( emitter, event, callback, [ options ] = { [options.priority] } )`

`off( event, callback )`

`on( event, callback, [ options ] = { [options.priority] } )`

`once( event, callback, [ options ] = { [options.priority] } )`

`set( name, [ value ] )`

`stopDelegating( [ event ], [ emitter ] )`

`stopListening( [ emitter ], [ event ], [ callback ] )`

`t()`

`unbind( [ unbindProperties ] )`

`create()`

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

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

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

`destroy( eventInfo )`

`ready( eventInfo )`

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