Report an issue
Class

Editor (core/editor)

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

class

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, then 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 the specific editor implements also the EditorWithUI interface (as most editor implementations do).

Filtering

Properties

  • commands : CommandCollection

    readonly

    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;
  • config : Config

    readonly

    Holds all configurations specific to this editor instance.

    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 Conversion's documentation to learn how to add converters.

  • data : DataController

    readonly

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

  • editing : EditingController

    readonly

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

  • isReadOnly : Boolean

    observable

    Defines whether this editor is in 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 can set this value directly:

    editor.isReadOnly = true;
  • keystrokes : EditingKeystrokeHandler

    readonly

    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 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 low level mechanism and trying to listen to them via the keystroke handler will not work reliably. To handle those 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.

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

  • plugins : PluginCollection

    readonly

    The plugins loaded and in use by this editor instance.

    editor.plugins.get( 'Clipboard' ); // -> instance of the Clipboard plugin.
  • state : 'initializing' | 'ready' | 'destroyed'

    observable

    Indicates the editor life-cycle state.

    The editor is in one of the following states:

Static properties

  • builtinPlugins : Array.<Function>

    static

    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 ); // -> instance of the Foo plugin
            editor.plugins.get( BarPlugin ); // -> instance of the Bar plugin
        } );
    
    ClassicEditor
        .create( sourceElement, {
            // Don't initialize this plugins (note: it's defined by a string):
            removePlugins: [ 'Foo' ]
        } )
        .then( editor => {
            editor.plugins.get( FooPlugin ); // -> undefined
            editor.config.get( BarPlugin ); // -> instance of the Bar plugin
        } );
    
    ClassicEditor
        .create( sourceElement, {
            // Load only this plugin. Can also be define by a string if
            // this plugin was built into the editor class.
            plugins: [ FooPlugin ]
        } )
        .then( editor => {
            editor.plugins.get( FooPlugin ); // -> instance of the Foo plugin
            editor.config.get( BarPlugin ); // -> undefined
        } );

    See also defaultConfig.

  • defaultConfig : Object

    static

    The default config which is built into the editor class. It is used in CKEditor 5 builds to provide the default config options which are later used during 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 config passed to create().
    ClassicEditor
        .create( sourceElement, { bar: 3 } )
        .then( editor => {
            editor.config.get( 'foo' ); // -> 1
            editor.config.get( 'bar' ); // -> 3
        } );

    See also builtinPlugins.

Methods

  • constructor( config )

    Creates a new instance of the Editor class.

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

    Parameters

    config : Object

    The editor config.

  • bind( bindProperties ) → Object

    Binds observable properties to another objects implementing Observable interface (like Model).

    Once bound, the observable will immediately share the current state of properties of the observable it is bound to and react to the changes to these properties in the future.

    Note: To release the binding use unbind.

    Using bind().to() chain:

    A.bind( 'a' ).to( B );
    A.bind( 'a' ).to( B, 'b' );
    A.bind( 'a', 'b' ).to( B, 'c', 'd' );
    A.bind( 'a' ).to( B, 'b', C, 'd', ( b, d ) => b + d );

    It is also possible to bind to the same property in a observables collection using bind().toMany() chain:

    A.bind( 'a' ).toMany( [ B, C, D ], 'x', ( a, b, c ) => a + b + c );
    A.bind( 'a' ).toMany( [ B, C, D ], 'x', ( ...x ) => x.every( x => x ) );

    Parameters

    bindProperties : String

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

    Returns

    Object

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

  • decorate( methodName )

    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.

    This is a very simplified method decoration. Itself it doesn't change the behavior of a method (expect adding the event), but it allows to modify it later on by listening to the method's event.

    For example, in order to cancel the method execution one can stop the event:

    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: we used a high priority listener here to execute this callback before the one which calls the original method (which used the default priority).

    It's also possible to change the return value:

    foo.on( 'method', ( evt ) => {
        evt.return = 'Foo!';
    } );
    
    foo.method(); // -> 'Foo'

    Finally, it's possible to access and modify the parameters:

    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

    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 : String

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain
  • destroy() → Promise

    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

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

    Fires

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

    Executes specified command with given parameters.

    Shorthand for:

    editor.commands.get( commandName ).execute( ... );

    Parameters

    commandName : String

    Name of command to execute.

    [ ...commandParams ] : *

    Command parameters.

  • fire( eventOrInfo, [ args ] ) → *

    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.

    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

    Loads and initializes plugins specified in the config.

    Returns

    Promise

    A promise which resolves once the initialization is completed.

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

    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.

    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 )

    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.

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

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

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

    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.

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

    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.

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

    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.

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

    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.

  • t()

    Shorthand for t.

  • unbind( [ unbindProperties ] )

    Removes the binding created with bind.

    A.unbind( 'a' );
    A.unbind();

    Parameters

    [ unbindProperties ] : String

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

Static methods

  • create( config ) → Promise

    static

    Creates and initializes a new editor instance.

    Parameters

    config : Object

    The editor config. You can find the list of config options in EditorConfig.

    Returns

    Promise

    Promise resolved once editor is ready.

    Editor

    return.editor The editor instance.

Events

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

    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 )

    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 : '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 )

    Fired when a property changed value.

    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.

  • dataReady( eventInfo )

    Fired when the data loaded to the editor is ready. If a specific editor doesn't load any data initially, this event will be fired right before event-ready.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

  • 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 also the editor.state property.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

  • pluginsReady( eventInfo )

    Fired after plugins are initialized.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

  • ready( eventInfo )

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

    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( '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.