# InlineEditor

class

The inline editor implementation. It uses an inline editable and a floating toolbar. See the [demo](../examples/builds/inline-editor.md).

In order to create a inline editor instance, use the static [`InlineEditor.create()`](#static-function-create) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-editor-inline/src/inlineeditor.ts#L39)

<a id="properties">

## Properties

<a id="member-accessibility">

### `accessibility: Accessibility` _(readonly)_

A namespace for the accessibility features of the editor.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L87)

<a id="member-commands">

### `commands: CommandCollection` _(readonly)_

Commands registered to the editor.

Use the shorthand [`editor.execute()`](#function-execute) method to execute commands:

```typescript
// Execute the bold command:
editor.execute( 'bold' );

// Check the state of the bold command:
editor.commands.get( 'bold' ).value;
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L102)

<a id="member-config">

### `config: Config<EditorConfig>` _(readonly)_

Stores all configurations specific to this editor instance.

```typescript
editor.config.get( 'image.toolbar' );
// -> [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ]
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L112)

<a id="member-conversion">

### `conversion: Conversion` _(readonly)_

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

See the [`Conversion`](module_engine_conversion_conversion-Conversion.md) documentation to learn how to add converters.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L119)

<a id="member-data">

### `data: DataController` _(readonly)_

The [data controller](module_engine_controller_datacontroller-DataController.md). Used e.g. for setting and retrieving the editor data.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L125)

<a id="member-editing">

### `editing: EditingController` _(readonly)_

The [editing controller](module_engine_controller_editingcontroller-EditingController.md). Controls user input and rendering the content for editing.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L131)

<a id="member-id">

### `id: string` _(readonly)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L187)

<a id="member-isReadOnly">

### `isReadOnly: boolean` _(readonly)_

Defines whether the editor is in the read-only mode.

In read-only mode the editor [commands](#member-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`](#function-enableReadOnlyMode) method:

```typescript
editor.enableReadOnlyMode( 'feature-id' );
```

* Later, to turn off the read-only mode, call [`disableReadOnlyMode`](#function-disableReadOnlyMode):

```typescript
editor.disableReadOnlyMode( 'feature-id' );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L646)

<a id="member-keystrokes">

### `keystrokes: EditingKeystrokeHandler` _(readonly)_

An instance of the [`EditingKeystrokeHandler`](module_core_editingkeystrokehandler-EditingKeystrokeHandler.md).

It allows setting simple keystrokes:

```typescript
// 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](module_engine_view_document-ViewDocument.md) (`editor.editing.view.document`).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L178)

<a id="member-locale">

### `locale: Locale` _(readonly)_

The locale instance.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L136)

<a id="member-model">

### `model: Model` _(readonly)_

The editor's model.

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L143)

<a id="member-plugins">

### `plugins: PluginCollection<Editor>` _(readonly)_

The plugins loaded and in use by this editor instance.

```typescript
editor.plugins.get( 'ClipboardPipeline' ); // -> An instance of the clipboard pipeline plugin.
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L152)

<a id="member-sourceElement">

### `sourceElement: HTMLElement | undefined` _(readonly)_

The element on which the editor has been initialized.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/utils/elementapimixin.ts#L88)

<a id="member-state">

### `state: 'ready' | 'initializing' | 'destroyed'` _(inherited)_

Indicates the editor life-cycle state.

The editor is in one of the following states:

* `initializing` – During the editor initialization (before [`Editor.create()`](module_core_editor_editor-Editor.md#static-function-create)) finished its job.
* `ready` – After the promise returned by the [`Editor.create()`](module_core_editor_editor-Editor.md#static-function-create) method is resolved.
* `destroyed` – Once the [`editor.destroy()`](#function-destroy) method was called.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L202)

<a id="member-t">

### `t: LocaleTranslate` _(readonly)_

Shorthand for [`t`](module_utils_locale-Locale.md#member-t).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L185)

#### Related:

* [Locale#t](module_utils_locale-Locale.md#member-t)

<a id="member-ui">

### `ui: InlineEditorUI` _(readonly)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-editor-inline/src/inlineeditor.ts#L50)

<a id="member-_context">

### `_context: Context` _(protected)_

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L293)

<a id="member-_readOnlyLocks">

### `_readOnlyLocks: Set<string | symbol>` _(protected)_

A set of lock IDs for the [`isReadOnly`](#member-isReadOnly) getter.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L298)

<a id="member-_registeredRootsAttributesKeys">

### `_registeredRootsAttributesKeys: Set<string>` _(protected)_

Holds attributes keys that were passed in [`config.roots.<rootName>.modelAttributes`](module_core_editor_editorconfig-EditorConfig.md#member-roots) or [`config.root.modelAttributes`](module_core_editor_editorconfig-EditorConfig.md#member-root).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L305)

#### Static properties

<a id="static-member-Context">

### `Context: Context` _(inherited)_

The [`Context`](module_core_context-Context.md) class.

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L1029)

<a id="static-member-ContextWatchdog">

### `ContextWatchdog: ContextWatchdog` _(inherited)_

The [`ContextWatchdog`](module_watchdog_contextwatchdog-ContextWatchdog.md) class.

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L1043)

<a id="static-member-EditorWatchdog">

### `EditorWatchdog: EditorWatchdog` _(inherited)_

The [`EditorWatchdog`](module_watchdog_editorwatchdog-EditorWatchdog.md) class.

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L1036)

<a id="static-member-_throwErrorWhenUsedAsAPlugin">

### `_throwErrorWhenUsedAsAPlugin: true` _(inherited)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L314)

<a id="static-member-builtinPlugins">

### `builtinPlugins?: Array<PluginConstructor<Editor>>` _(inherited)_

An array of plugins built into this editor class.

It is used in the now deprecated CKEditor 5 builds to provide a list of plugins which are later automatically initialized during the editor initialization.

They will be automatically initialized by the editor, unless listed in `config.removePlugins` and unless `config.plugins` is passed.

```typescript
// Build some plugins into the editor class first.
ClassicEditor.builtinPlugins = [ FooPlugin, BarPlugin ];

// Normally, you need to define config.plugins, but since ClassicEditor.builtinPlugins was
// defined, now you can call create() without any configuration.
ClassicEditor
	.create( sourceElement )
	.then( editor => {
		editor.plugins.get( FooPlugin ); // -> An instance of the Foo plugin.
		editor.plugins.get( BarPlugin ); // -> An instance of the Bar plugin.
	} );

ClassicEditor
	.create( {
		// Do not initialize these plugins (note: it is defined by a string):
		removePlugins: [ 'Foo' ]
	} )
	.then( editor => {
		editor.plugins.get( FooPlugin ); // -> Undefined.
		editor.config.get( BarPlugin ); // -> An instance of the Bar plugin.
	} );

ClassicEditor
	.create( {
		// Load only this plugin. It can also be defined by a string if
		// this plugin was built into the editor class.
		plugins: [ FooPlugin ]
	} )
	.then( editor => {
		editor.plugins.get( FooPlugin ); // -> An instance of the Foo plugin.
		editor.config.get( BarPlugin ); // -> Undefined.
	} );
```

See also [`defaultConfig`](module_core_editor_editor-Editor.md#static-member-defaultConfig).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L282)

<a id="static-member-defaultConfig">

### `defaultConfig?: EditorConfig` _(inherited)_

The default configuration which is built into the editor class.

It was used in the now deprecated CKEditor 5 builds to provide the default configuration options which are later used during the editor initialization.

```typescript
ClassicEditor.defaultConfig = {
	foo: 1,
	bar: 2
};

ClassicEditor
	.create( sourceElement )
	.then( editor => {
		editor.config.get( 'foo' ); // -> 1
		editor.config.get( 'bar' ); // -> 2
	} );

// The default options can be overridden by the configuration passed to create().
ClassicEditor
	.create( { bar: 3 } )
	.then( editor => {
		editor.config.get( 'foo' ); // -> 1
		editor.config.get( 'bar' ); // -> 3
	} );
```

See also [`builtinPlugins`](module_core_editor_editor-Editor.md#static-member-builtinPlugins).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L234)

<a id="static-member-editorName">

### `editorName: 'InlineEditor'` _(readonly)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-editor-inline/src/inlineeditor.ts#L43)

<a id="methods">

## Methods

<a id="function-constructor">

### `constructor( sourceElementOrData, config )` _(deprecated)_

Creates an instance of the inline editor.

**Note:** Do not use the constructor to create editor instances. Use the static [`InlineEditor.create()`](#static-function-create) method instead.

**Note**: This constructor signature is deprecated and will be removed in the future release.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-editor-inline/src/inlineeditor.ts#L76)

#### Parameters

* `sourceElementOrData: string | HTMLElement`

  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()`](#static-function-create).

* `config: EditorConfig`

  The editor configuration.

<a id="function-constructor">

### `constructor( config )` _(protected)_

Creates an instance of the inline editor.

**Note:** Do not use the constructor to create editor instances. Use the static [`InlineEditor.create()`](#static-function-create) method instead.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-editor-inline/src/inlineeditor.ts#L60)

#### Parameters

* `config: EditorConfig`

  The editor configuration.

<a id="function-bind:MANY_BIND">

### `bind( bindProperties ) → ObservableMultiBindChain` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
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`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
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:

```typescript
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:

```typescript
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:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1074)

#### Parameters

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

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

#### Returns

* `ObservableMultiBindChain`

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

<a id="function-bind:DUAL_BIND">

### `bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, InlineEditor[ K1 ], K2, InlineEditor[ K2 ]>` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
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`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
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:

```typescript
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:

```typescript
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:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L996)

#### 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

* `ObservableDualBindChain<K1, InlineEditor[ K1 ], K2, InlineEditor[ K2 ]>`

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

<a id="function-bind:SINGLE_BIND">

### `bind( bindProperty ) → ObservableSingleBindChain<K, InlineEditor[ K ]>` _(inherited)_

Binds [observable properties](#function-set:KEY_VALUE) to other objects implementing the [`Observable`](module_utils_observablemixin-Observable.md) interface.

Read more in the [dedicated](../framework/deep-dive/observables.md#property-bindings) 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:

```typescript
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```

or even shorter:

```typescript
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`](module_utils_observablemixin-Observable.md#function-unbind).

You can also "rename" the property in the binding by specifying the new name in the `to()` chain:

```typescript
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```

It is possible to bind more than one property at a time to shorten the code:

```typescript
button.bind( 'isEnabled', 'value' ).to( command );
```

which corresponds to:

```typescript
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:

```typescript
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:

```typescript
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:

```typescript
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L918)

#### Type parameters

* `K`

#### Parameters

* `bindProperty: K`

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

#### Returns

* `ObservableSingleBindChain<K, InlineEditor[ K ]>`

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

<a id="function-decorate">

### `decorate( methodName ) → void` _(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.

Read more in the [dedicated](../framework/deep-dive/observables.md#decorating-object-methods) 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](module_utils_eventinfo-EventInfo.md#member-stop):

```typescript
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](module_utils_priorities-PriorityString.md) 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:

```typescript
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:

```typescript
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'
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1159)

#### Parameters

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

  Name of the method to decorate.

#### Returns

* `void`

<a id="function-delegate">

### `delegate( events ) → EmitterMixinDelegateChain` _(inherited)_

Delegates selected events to another [`Emitter`](module_utils_emittermixin-Emitter.md). For instance:

```typescript
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```

then `eventX` is delegated (fired by) `emitterB` and `emitterC` along with `data`:

```typescript
emitterA.fire( 'eventX', data );
```

and `eventY` is delegated (fired by) `emitterC` along with `data`:

```typescript
emitterA.fire( 'eventY', data );
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L539)

#### Parameters

* `events: Array<string>`

  Event names that will be delegated to another emitter.

#### Returns

* `EmitterMixinDelegateChain`

<a id="function-destroy">

### `destroy() → Promise<unknown>`

Destroys the editor instance, releasing all resources used by it.

Updates the original editor element with the data if the [`updateSourceElementOnDestroy`](module_core_editor_editorconfig-EditorConfig.md#member-updateSourceElementOnDestroy) configuration option is set to `true`.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-editor-inline/src/inlineeditor.ts#L122)

#### Returns

* `Promise<unknown>`

<a id="function-disableReadOnlyMode">

### `disableReadOnlyMode( lockId ) → void` _(inherited)_

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](#member-isReadOnly) will be set to `false`.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L749)

#### Parameters

* `lockId: string | symbol`

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

#### Returns

* `void`

<a id="function-enableReadOnlyMode">

### `enableReadOnlyMode( lockId ) → void` _(inherited)_

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](#member-isReadOnly) will be set to `true`:

```typescript
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()`](#function-disableReadOnlyMode) method:

```typescript
editor.enableReadOnlyMode( 'my-feature-id' );
// ...
editor.disableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `false`.
```

All "locks" need to be removed to enable editing:

```typescript
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`.
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L719)

#### Parameters

* `lockId: string | symbol`

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

#### Returns

* `void`

<a id="function-execute">

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

Executes the specified command with given parameters.

Shorthand for:

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L927)

#### 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()`](module_core_commandcollection-CommandCollection.md#function-execute).

<a id="function-fire">

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

Fires an event, executing all callbacks registered for it.

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L512)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### 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`](module_utils_eventinfo-EventInfo.md#member-return)'s property (the event info is the first param of every callback).

<a id="function-focus">

### `focus() → void` _(inherited)_

Focuses the editor.

**Note** To explicitly focus the editing area of the editor, use the [`editor.editing.view.focus()`](module_engine_view_view-EditingView.md#function-focus) method of the editing view.

Check out the [Focus in the editor UI](../framework/deep-dive/ui/focus-tracking.md#focus-in-the-editor-ui) section of the [Deep dive into focus tracking](../framework/deep-dive/ui/focus-tracking.md) guide to learn more.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L949)

#### Returns

* `void`

<a id="function-getData">

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

Gets the data from the editor.

```typescript
editor.getData(); // -> '<p>This is editor!</p>'
```

If your editor implementation uses multiple roots, you should pass root name as one of the options:

```typescript
editor.getData( { rootName: 'header' } ); // -> '<p>Content for header part.</p>'
```

By default, the editor outputs HTML. This can be controlled by injecting a different data processor. See the [Markdown output](../features/markdown.md) 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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L820)

#### 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 `'<p>&nbsp;</p>'` for an empty editor).

  * `options.[key: string]: unknown`

#### Returns

* `string`

  Output data.

<a id="function-getRootAttributes">

### `getRootAttributes( rootName ) → EditorRootAttributes` _(inherited)_

Returns attributes for the specified root. If no root name is provided, it returns attributes for the 'main' root by default.

Note: all and only [registered](#function-registerRootAttribute) roots attributes will be returned. If a registered root attribute is not set for a given root, `null` will be returned.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L986)

#### Parameters

* `rootName: string`

  Defaults to `'main'`

#### Returns

* `EditorRootAttributes`

<a id="function-initPlugins">

### `initPlugins() → Promise<LoadedPlugins>` _(inherited)_

Loads and initializes plugins specified in the configuration.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L833)

#### Returns

* `Promise<LoadedPlugins>`

  A promise which resolves once the initialization is completed, providing an array of loaded plugins.

<a id="function-listenTo:BASE_EMITTER">

### `listenTo( emitter, event, callback, options? ) → void` _(inherited)_

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.

```typescript
// 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](module_utils_eventinfo-EventInfo.md#member-stop) and set the [return value](module_utils_eventinfo-EventInfo.md#member-return) of the [`fire`](#function-fire) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L475)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type describing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### 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`

<a id="function-off">

### `off( event, callback ) → void` _(inherited)_

Stops executing the callback on the given event. Shorthand for [`this.stopListening( this, event, callback )`](#function-stopListening:BASE_STOP).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L444)

#### Parameters

* `event: string`

  The name of the event.

* `callback: Function`

  The function to stop being called.

#### Returns

* `void`

<a id="function-on">

### `on( event, callback, options? ) → void` _(inherited)_

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

Shorthand for [`this.listenTo( this, event, callback, options )`](#function-listenTo:BASE_EMITTER) (it makes the emitter listen on itself).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L416)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### 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`

<a id="function-once">

### `once( event, callback, options? ) → void` _(inherited)_

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling [`on`](#function-on) followed by [`off`](#function-off) in the callback.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L431)

#### Type parameters

* `TEvent: extends BaseEvent`

  The type descibing the event. See [`BaseEvent`](module_utils_emittermixin-BaseEvent.md).

#### 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`

<a id="function-registerRootAttribute">

### `registerRootAttribute( key ) → void` _(inherited)_

Registers a given string as a root attribute key. Registered root attributes are added to the [schema](module_engine_model_schema-ModelSchema.md).

**Note:** Attributes passed in the configuration for multi-root editors ([`config.roots.<rootName>.modelAttributes`](module_core_editor_editorconfig-EditorConfig.md#member-roots)) or single-root editors ([`config.root.modelAttributes`](module_core_editor_editorconfig-EditorConfig.md#member-root)) are automatically registered when the editor is initialized. However, registering the same attribute twice does not have any negative impact, so it is recommended to use this method in any feature that uses root attributes.

**Note:** Registered attributes are attached only to the generic `$root` schema element. A custom root [`modelElement`](module_core_editor_editorconfig-RootConfig.md#member-modelElement) must opt into the `$root` attribute chain via `allowAttributesOf: '$root'` to inherit these attributes. See the [Custom root elements](../framework/deep-dive/schema.md#custom-root-elements) section of the [Schema deep-dive](../framework/deep-dive/schema.md) guide for more details.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L970)

#### Parameters

* `key: string`

#### Returns

* `void`

<a id="function-set:OBJECT">

### `set( values ) → void` _(inherited)_

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:

```typescript
public declare myProp1: number;
public declare myProp2: string;

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L843)

#### Parameters

* `values: object & object`

  An object with `name=>value` pairs.

#### Returns

* `void`

<a id="function-set:KEY_VALUE">

### `set( name, value ) → void` _(inherited)_

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:

```typescript
public declare myProp: number;

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L815)

#### Type parameters

* `K`

#### Parameters

* `name: K`

  The property's name.

* `value: InlineEditor[ K ]`

  The property's value.

#### Returns

* `void`

<a id="function-setData">

### `setData( data ) → void` _(inherited)_

Sets the data in the editor.

```typescript
editor.setData( '<p>This is editor!</p>' );
```

If your editor implementation uses multiple roots, you should pass an object with keys corresponding to the editor root names and values equal to the data that should be set in each root:

```typescript
editor.setData( {
	header: '<p>Content for header part.</p>',
	content: '<p>Content for main part.</p>',
	footer: '<p>Content for footer part.</p>'
} );
```

By default the editor accepts HTML. This can be controlled by injecting a different data processor. See the [Markdown output](../features/markdown.md) guide for more details.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L789)

#### Parameters

* `data: string | Record<string, string>`

  Input data.

#### Returns

* `void`

<a id="function-stopDelegating">

### `stopDelegating( event?, emitter? ) → void` _(inherited)_

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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L552)

#### 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`

<a id="function-stopListening:BASE_STOP">

### `stopListening( emitter?, event?, callback? ) → void` _(inherited)_

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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/emittermixin.ts#L497)

#### 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`

<a id="function-unbind">

### `unbind( unbindProperties ) → void` _(inherited)_

Removes the binding created with [`bind`](#function-bind:SINGLE_BIND).

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

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1090)

#### Parameters

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

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

#### Returns

* `void`

<a id="function-updateSourceElement">

### `updateSourceElement( data? ) → void` _(inherited)_

Updates the [editor source element](#member-sourceElement)'s content with the data if the [`updateSourceElementOnDestroy`](module_core_editor_editorconfig-EditorConfig.md#member-updateSourceElementOnDestroy) configuration option is set to `true`.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/utils/elementapimixin.ts#L97)

#### Parameters

* `data?: string`

  Data that the [editor source element](#member-sourceElement) should be updated with.

#### Returns

* `void`

<a id="function-_showLicenseError">

### `_showLicenseError( reason, name? ) → void` _(protected)_

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L1045)

#### Parameters

* `reason: LicenseErrorReason`
* `name?: string`

#### Returns

* `void`

#### Static methods

<a id="static-function-create">

### `create( sourceElementOrData, config ) → Promise<InlineEditor>` _(deprecated)_

Creates a new inline editor instance.

**Note**: This method signature is deprecated and will be removed in the future release.

There are three general ways how the editor can be initialized.

#### Using an existing DOM element (and loading data from it)

You can initialize the editor using an existing DOM element:

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

The element's content will be used as the editor data and the element will become the editable element.

#### Creating a detached editor

Alternatively, you can initialize the editor by passing the initial data directly as a `String`. In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:

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

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

This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.

#### Using an existing DOM element (and data provided in `config.root.initialData`)

You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:

```typescript
InlineEditor
	.create( document.querySelector( '#editor' ), {
		root: {
			initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
		}
	} )
	.then( editor => {
		console.log( 'Editor was initialized', editor );
	} )
	.catch( err => {
		console.error( err.stack );
	} );
```

This method can be used to initialize the editor on an existing element with the specified content in case if your integration makes it difficult to set the content of the source element.

Note that an error will be thrown if you pass the initial data both as the first parameter and also in the configuration.

#### Configuring the editor

See the [editor configuration documentation](module_core_editor_editorconfig-EditorConfig.md) to learn more about customizing plugins, toolbar and more.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-editor-inline/src/inlineeditor.ts#L315)

#### Parameters

* `sourceElementOrData: string | HTMLElement`

  The DOM element that will be the source for the created editor or the editor's initial data.

  If a DOM element is passed, its content will be automatically loaded to the editor upon initialization. The editor data will be set back to the original element once the editor is destroyed only if the [updateSourceElementOnDestroy](module_core_editor_editorconfig-EditorConfig.md#member-updateSourceElementOnDestroy) option is set to `true`.

  If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually. It is available under the [`editor.ui.element`](module_editor-inline_inlineeditorui-InlineEditorUI.md#member-element) property.

* `config: EditorConfig`

  The editor configuration.

#### Returns

* `Promise<InlineEditor>`

  A promise resolved once the editor is ready. The promise resolves with the created editor instance.

<a id="static-function-create">

### `create( config ) → Promise<InlineEditor>` _(static)_

Creates a new inline editor instance.

There are three general ways how the editor can be initialized.

#### Using an existing DOM element (and loading data from it)

You can initialize the editor using an existing DOM element:

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

The element's content will be used as the editor data and the element will become the editable element.

#### Creating a detached editor

Alternatively, you can initialize the editor by passing the initial data directly as a `String`. In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:

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

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

This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.

#### Using an existing DOM element (and data provided in `config.root.initialData`)

You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:

```typescript
InlineEditor
	.create( {
		root: {
			element: document.querySelector( '#editor' ),
			initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
		}
	} )
	.then( editor => {
		console.log( 'Editor was initialized', editor );
	} )
	.catch( err => {
		console.error( err.stack );
	} );
```

This method can be used to initialize the editor on an existing element with the specified content in case if your integration makes it difficult to set the content of the source element.

#### Configuring the editor

See the [editor configuration documentation](module_core_editor_editorconfig-EditorConfig.md) to learn more about customizing plugins, toolbar and more.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-editor-inline/src/inlineeditor.ts#L223)

#### Parameters

* `config: EditorConfig`

  The editor configuration.

#### Returns

* `Promise<InlineEditor>`

  A promise resolved once the editor is ready. The promise resolves with the created editor instance.

<a id="events">

## Events

<a id="event-change:isReadOnly">

### `change:isReadOnly( eventInfo, name, value, oldValue )` _(inherited)_

Fired when the `isReadOnly` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L646)

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

<a id="event-change:state">

### `change:state( eventInfo, name, value, oldValue )` _(inherited)_

Fired when the `state` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L202)

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

<a id="event-change:%7Bproperty%7D">

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

Fired when a property changed value.

```typescript
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'
```

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1190)

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

<a id="event-collectUsageData">

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

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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L1295)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: object`

  Properties

  * `<anonymous>.setUsageData: void`

<a id="event-destroy">

### `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 also the [`editor.state`](module_core_editor_editor-Editor.md#member-state) property.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L1312)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

<a id="event-ready">

### `ready( eventInfo )` _(inherited)_

Fired when the [data](module_engine_controller_datacontroller-DataController.md#event-ready) 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()`](module_core_editor_editor-Editor.md#static-function-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`](module_core_editor_editor-Editor.md#member-state) property.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L1281)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

<a id="event-set:isReadOnly">

### `set:isReadOnly( eventInfo, name, value, oldValue )` _(inherited)_

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L646)

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

<a id="event-set:state">

### `set:state( eventInfo, name, value, oldValue )` _(inherited)_

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-core/src/editor/editor.ts#L202)

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

<a id="event-set:%7Bproperty%7D">

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

You can control the final value of the property by using the [event's `return` property](module_utils_eventinfo-EventInfo.md#member-return).

```typescript
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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-utils/src/observablemixin.ts#L1228)

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

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)