Home/CKEditor 5/API

InlineEditor (editor-inline)

@ckeditor/ckeditor5-editor-inline/src/inlineeditor

class

See source

The inline editor implementation. It uses an inline editable and a floating toolbar. See the demo.

In order to create a inline editor instance, use the static InlineEditor.create() method.

Inline editor and inline build

The inline editor can be used directly from source (if you installed the @ckeditor/ckeditor5-editor-inline package) but it is also available in the inline build.

Builds are ready-to-use editors with plugins bundled in. When using the editor from source you need to take care of loading all plugins by yourself (through the config.plugins option). Using the editor from source gives much better flexibility and allows easier customization.

Read more about initializing the editor from source or as a build in InlineEditor.create().

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

commands : CommandCollection

readonly inherited
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 inherited
Holds all configurations specific to this editor instance.

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

readonly inherited

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

See source

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

readonly inherited

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

See source
editing : EditingController

readonly inherited

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

See source
element : HTMLElement | null

readonly

The main (outermost) DOM element of the editor UI.

See source

For example, in ClassicEditor it is a <div> which wraps the editable element and the toolbar. In InlineEditor it is the editable element itself (as there is no other wrapper). However, in DecoupledEditor it is set to null because this editor does not come with a single "main" HTML element (its editable element and toolbar are separate).

This property can be understood as a shorthand for retrieving the element that a specific editor integration considers to be its main DOM element. There are always other ways to access these elements, too (e.g. via editor.ui).
isReadOnly : Boolean

inherited 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 inherited
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 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 inherited
model : Model

readonly inherited

The editor's model.

See source

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

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

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

inherited 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.
ui : EditorUI

readonly

The editor UI instance.

See source

Static properties

`builtinPlugins : Array.<Function>`

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

See source

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

`defaultConfig : Object`

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

See source

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

Methods

constructor( sourceElementOrData, config )

protected

Creates an instance of the inline editor.

See source

Note: Do not use the constructor to create editor instances. Use the static InlineEditor.create() method instead.

Parameters

sourceElementOrData : HTMLElement | String

The DOM element that will be the source for the created editor (on which the editor will be initialized) or initial data for the editor. For more information see InlineEditor.create().

config : EditorConfig

The editor configuration.
bind( bindProperties ) → Object

inherited
Binds obvervable 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.

Let's 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 another observable(s).

Returns

Object

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

inherited
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

inherited
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

Updates the original editor element with the data.

Returns

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

inherited
Executes specified command with given parameters.

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

commandName : String

Name of command to execute.

[ ...commandParams ] : *

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

inherited

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).
getData() → String
Gets the data from the editor.

See source
```
editor.getData(); // -> '<p>This is editor!</p>'
```
By default the editor outputs HTML. This can be controlled by injecting a different data processor. See the Markdown output guide for more details.

Note: Not only is the format of the data configurable, but the type of the getData()'s return value does not have to be a string either. You can e.g. return an object or a DOM DocumentFragment if you consider this the right format for you.

Returns

String

Output data.
initPlugins() → Promise

inherited

Loads and initializes plugins specified in the config.

See source

Returns

Promise

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

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

inherited

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

inherited

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

inherited

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

inherited

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).
setData( data )
Sets the data in the editor.

See source
```
editor.setData( '<p>This is editor!</p>' );
```
By default the editor accepts HTML. This can be controlled by injecting a different data processor. See the Markdown output guide for more details.

Note: Not only is the format of the data configurable, but the type of the setData()'s parameter does not have to be a string either. You can e.g. accept an object or a DOM DocumentFragment if you consider this the right format for you.

Parameters

data : String

Input data.
stopDelegating( [ event ], [ emitter ] )

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

inherited
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()

inherited
Shorthand for t.

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

inherited
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 provided.
updateSourceElement()

Updates the editor source element's content with the data.

See source

Static methods

`create( sourceElementOrData, config ) → Promise`

static

Creates an inline editor instance.

See source

Creating an instance when using a CKEditor build:

InlineEditor
    .create( document.querySelector( '#editor' ) )
    .then( editor => {
        console.log( 'Editor was initialized', editor );
    } )
    .catch( err => {
        console.error( err.stack );
    } );

Creating an instance when using CKEditor from source (make sure to specify the list of plugins to load and the toolbar):

import InlineEditor from '@ckeditor/ckeditor5-editor-inline/src/inlineeditor';
import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
import ...

InlineEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Essentials, Bold, Italic, ... ],
        toolbar: [ 'bold', 'italic', ... ]
    } )
    .then( editor => {
        console.log( 'Editor was initialized', editor );
    } )
    .catch( err => {
        console.error( err.stack );
    } );

Creating an instance when using the initial data instead of a DOM element:

import InlineEditor from '@ckeditor/ckeditor5-editor-inline/src/inlineeditor';
import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
import ...

InlineEditor
    .create( '<p>Hello world!</p>' )
    .then( editor => {
        console.log( 'Editor was initialized', editor );

        // Initial data was provided so `editor.element` needs to be added manually to the DOM.
        document.body.appendChild( editor.element );
    } )
    .catch( err => {
        console.error( err.stack );
    } );

Parameters

sourceElementOrData : HTMLElement | String

The DOM element that will be the source for the created editor (on which the editor will be initialized) or the initial data for the editor.

If a source element is passed, then its contents will be automatically loaded to the editor on startup and the element itself will be used as the editor's editable element.

If data is provided, then editor.element will be created automatically and needs to be added to the DOM manually.

config : EditorConfig

The editor configuration.

Returns

Promise: A promise resolved once the editor is ready. The promise returns the created InlineEditor instance.

Events

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

inherited

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 )

inherited

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 )

inherited
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.
dataReady( eventInfo )

inherited

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.

See source

Parameters

eventInfo : EventInfo

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

inherited

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.
pluginsReady( eventInfo )

inherited

Fired after plugins are initialized.

See source

Parameters

eventInfo : EventInfo

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

inherited

Fired when plugins, and 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 )

inherited
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.
uiReady( eventInfo )

Fired when the editor UI is ready.

See source

Fired after event-pluginsReady and before event-dataReady.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

InlineEditor (editor-inline)

Inline editor and inline build

Filtering

Properties

commands : CommandCollectionmodule:editor-inline/inlineeditor~InlineEditor#commands

config : Configmodule:editor-inline/inlineeditor~InlineEditor#config

conversion : Conversionmodule:editor-inline/inlineeditor~InlineEditor#conversion

data : DataControllermodule:editor-inline/inlineeditor~InlineEditor#data

editing : EditingControllermodule:editor-inline/inlineeditor~InlineEditor#editing

element : HTMLElement | nullmodule:editor-inline/inlineeditor~InlineEditor#element

isReadOnly : Booleanmodule:editor-inline/inlineeditor~InlineEditor#isReadOnly

keystrokes : EditingKeystrokeHandlermodule:editor-inline/inlineeditor~InlineEditor#keystrokes

locale : Localemodule:editor-inline/inlineeditor~InlineEditor#locale

model : Modelmodule:editor-inline/inlineeditor~InlineEditor#model

plugins : PluginCollectionmodule:editor-inline/inlineeditor~InlineEditor#plugins

state : 'initializing' | 'ready' | 'destroyed'module:editor-inline/inlineeditor~InlineEditor#state

ui : EditorUImodule:editor-inline/inlineeditor~InlineEditor#ui

Static properties

builtinPlugins : Array.<Function>module:editor-inline/inlineeditor~InlineEditor.builtinPlugins

defaultConfig : Objectmodule:editor-inline/inlineeditor~InlineEditor.defaultConfig

Methods

constructor( sourceElementOrData, config )module:editor-inline/inlineeditor~InlineEditor#constructor

Parameters

bind( bindProperties ) → Objectmodule:editor-inline/inlineeditor~InlineEditor#bind

Parameters

Returns

decorate( methodName )module:editor-inline/inlineeditor~InlineEditor#decorate

Parameters

delegate( events ) → EmitterMixinDelegateChainmodule:editor-inline/inlineeditor~InlineEditor#delegate

Parameters

Returns

destroy() → Promisemodule:editor-inline/inlineeditor~InlineEditor#destroy

Returns

execute( commandName, [ ...commandParams ] )module:editor-inline/inlineeditor~InlineEditor#execute

Parameters

fire( eventOrInfo, [ args ] ) → *module:editor-inline/inlineeditor~InlineEditor#fire

Parameters

Returns

getData() → Stringmodule:editor-inline/inlineeditor~InlineEditor#getData

Returns

initPlugins() → Promisemodule:editor-inline/inlineeditor~InlineEditor#initPlugins

Returns

listenTo( emitter, event, callback, [ options ] = { [options.priority] } )module:editor-inline/inlineeditor~InlineEditor#listenTo

Parameters

off( event, callback )module:editor-inline/inlineeditor~InlineEditor#off

Parameters

on( event, callback, [ options ] = { [options.priority] } )module:editor-inline/inlineeditor~InlineEditor#on

Parameters

once( event, callback, [ options ] = { [options.priority] } )module:editor-inline/inlineeditor~InlineEditor#once

Parameters

set( name, [ value ] )module:editor-inline/inlineeditor~InlineEditor#set

Parameters

setData( data )module:editor-inline/inlineeditor~InlineEditor#setData

Parameters

stopDelegating( [ event ], [ emitter ] )module:editor-inline/inlineeditor~InlineEditor#stopDelegating

Parameters

stopListening( [ emitter ], [ event ], [ callback ] )module:editor-inline/inlineeditor~InlineEditor#stopListening

Parameters

t()module:editor-inline/inlineeditor~InlineEditor#t

Related:

unbind( [ unbindProperties ] )module:editor-inline/inlineeditor~InlineEditor#unbind

Parameters

updateSourceElement()module:editor-inline/inlineeditor~InlineEditor#updateSourceElement

Static methods

create( sourceElementOrData, config ) → Promisemodule:editor-inline/inlineeditor~InlineEditor.create

Parameters

Returns

Events

change:isReadOnly( eventInfo, name, value, oldValue )module:editor-inline/inlineeditor~InlineEditor#event:change:isReadOnly

Parameters

change:state( eventInfo, name, value, oldValue )module:editor-inline/inlineeditor~InlineEditor#event:change:state

Parameters

change:{property}( eventInfo, name, value, oldValue )module:editor-inline/inlineeditor~InlineEditor#event:change:{property}

Parameters

dataReady( eventInfo )module:editor-inline/inlineeditor~InlineEditor#event:dataReady

Parameters

destroy( eventInfo )module:editor-inline/inlineeditor~InlineEditor#event:destroy

Parameters

pluginsReady( eventInfo )module:editor-inline/inlineeditor~InlineEditor#event:pluginsReady

Parameters

`commands : CommandCollection`

`config : Config`

`conversion : Conversion`

`data : DataController`

`editing : EditingController`

`element : HTMLElement | null`

`isReadOnly : Boolean`

`keystrokes : EditingKeystrokeHandler`

`locale : Locale`

`model : Model`

`plugins : PluginCollection`

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

`ui : EditorUI`

`builtinPlugins : Array.<Function>`

`defaultConfig : Object`

`constructor( sourceElementOrData, config )`

`bind( bindProperties ) → Object`

`decorate( methodName )`

`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → Promise`

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

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

`getData() → String`

`initPlugins() → Promise`

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

`setData( data )`

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

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

`t()`

`unbind( [ unbindProperties ] )`

`updateSourceElement()`

`create( sourceElementOrData, config ) → Promise`

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

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

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

`dataReady( eventInfo )`

`destroy( eventInfo )`

`pluginsReady( eventInfo )`

`ready( eventInfo )`

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

`uiReady( eventInfo )`