# ViewDocument

class

Document class creates an abstract layer over the content editable area, contains a tree of view elements and [view selection](module_engine_view_documentselection-ViewDocumentSelection.md) associated with this document.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L28)

<a id="properties">

## Properties

<a id="member-isComposing">

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

True if composition is in progress inside the document.

This property is updated by the [`CompositionObserver`](module_engine_view_observer_compositionobserver-CompositionObserver.md). If the [`CompositionObserver`](module_engine_view_observer_compositionobserver-CompositionObserver.md) is disabled this property will not change.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L89)

<a id="member-isFocused">

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

True if document is focused.

This property is updated by the [`FocusObserver`](module_engine_view_observer_focusobserver-FocusObserver.md). If the [`FocusObserver`](module_engine_view_observer_focusobserver-FocusObserver.md) is disabled this property will not change.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L67)

<a id="member-isReadOnly">

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

Defines whether document is in read-only mode.

When document is read-ony then all roots are read-only as well and caret placed inside this root is hidden.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L56)

<a id="member-isSelecting">

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

`true` while the user is making a selection in the document (e.g. holding the mouse button and moving the cursor). When they stop selecting, the property goes back to `false`.

This property is updated by the [`SelectionObserver`](module_engine_view_observer_selectionobserver-SelectionObserver.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L78)

<a id="member-roots">

### `roots: Collection<ViewRootEditableElement>` _(readonly)_

Roots of the view tree. Collection of the [view elements](module_engine_view_element-ViewElement.md).

View roots are created as a result of binding between [`roots`](#member-roots) and [`roots`](module_engine_model_document-ModelDocument.md#member-roots) and this is handled by [`EditingController`](module_engine_controller_editingcontroller-EditingController.md), so to create view root we need to create model root using [`createRoot`](module_engine_model_document-ModelDocument.md#function-createRoot).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L42)

<a id="member-selection">

### `selection: ViewDocumentSelection` _(readonly)_

Selection done on this document.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L32)

<a id="member-stylesProcessor">

### `stylesProcessor: StylesProcessor` _(readonly)_

The styles processor instance used by this document when normalizing styles.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L47)

<a id="member-_postFixers">

### `_postFixers: Set<ViewDocumentPostFixer>` _(private)_

Post-fixer callbacks registered to the view document.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L94)

<a id="methods">

## Methods

<a id="function-constructor">

### `constructor( stylesProcessor )`

Creates a Document instance.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L101)

#### Parameters

* `stylesProcessor: StylesProcessor`

  The styles processor instance.

<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' | 'destroy' | 'isFocused' | 'selection' | 'isReadOnly' | 'roots' | 'stylesProcessor' | 'isSelecting' | 'isComposing' | 'getRoot' | 'getRoots' | 'registerPostFixer' | '_callPostFixers'>`

  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, ViewDocument[ K1 ], K2, ViewDocument[ 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, ViewDocument[ K1 ], K2, ViewDocument[ K2 ]>`

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

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

### `bind( bindProperty ) → ObservableSingleBindChain<K, ViewDocument[ 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, ViewDocument[ 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' | 'destroy' | 'isFocused' | 'selection' | 'isReadOnly' | 'roots' | 'stylesProcessor' | 'isSelecting' | 'isComposing' | 'getRoot' | 'getRoots' | 'registerPostFixer' | '_callPostFixers'`

  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() → void`

Destroys this instance. Makes sure that all observers are destroyed and listeners removed.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L189)

#### Returns

* `void`

<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-getRoot">

### `getRoot( name ) → ViewRootEditableElement | null`

Gets a [view root element](#member-roots) with the specified name. If the name is not specific "main" root is returned.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L121)

#### Parameters

* `name: string`

  Name of the root.

  Defaults to `'main'`

#### Returns

* `ViewRootEditableElement | null`

  The view root element with the specified name or null when there is no root of given name.

<a id="function-getRoots">

### `getRoots() → Array<ViewRootEditableElement>`

Returns an array with all roots added to the document.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L128)

#### Returns

* `Array<ViewRootEditableElement>`

<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-registerPostFixer">

### `registerPostFixer( postFixer ) → void`

Allows registering post-fixer callbacks. A post-fixers mechanism allows to update the view tree just before it is rendered to the DOM.

Post-fixers are executed right after all changes from the outermost change block were applied but before the [render event](module_engine_view_view-EditingView.md#event-render) is fired. If a post-fixer callback made a change, it should return `true`. When this happens, all post-fixers are fired again to check if something else should not be fixed in the new document tree state.

View post-fixers are useful when you want to apply some fixes whenever the view structure changes. Keep in mind that changes executed in a view post-fixer should not break model-view mapping.

The types of changes which should be safe:

* adding or removing attribute from elements,
* changes inside of [UI elements](module_engine_view_uielement-ViewUIElement.md),
* [marking some of the model elements to be re-converted](module_engine_controller_editingcontroller-EditingController.md#function-reconvertItem).

Try to avoid changes which touch view structure:

* you should not add or remove nor wrap or unwrap any view elements,
* you should not change the editor data model in a view post-fixer.

As a parameter, a post-fixer callback receives a [downcast writer](module_engine_view_downcastwriter-ViewDowncastWriter.md).

Typically, a post-fixer will look like this:

```typescript
editor.editing.view.document.registerPostFixer( writer => {
	if ( checkSomeCondition() ) {
		writer.doSomething();

		// Let other post-fixers know that something changed.
		return true;
	}

	return false;
} );
```

Note that nothing happens right after you register a post-fixer (e.g. execute such a code in the console). That is because adding a post-fixer does not execute it. The post-fixer will be executed as soon as any change in the document needs to cause its rendering. If you want to re-render the editor's view after registering the post-fixer then you should do it manually by calling [`view.forceRender()`](module_engine_view_view-EditingView.md#function-forceRender).

If you need to register a callback which is executed when DOM elements are already updated, use [render event](module_engine_view_view-EditingView.md#event-render).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L182)

#### Parameters

* `postFixer: ViewDocumentPostFixer`

#### 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: ViewDocument[ K ]`

  The property's value.

#### 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' | 'destroy' | 'isFocused' | 'selection' | 'isReadOnly' | 'roots' | 'stylesProcessor' | 'isSelecting' | 'isComposing' | 'getRoot' | 'getRoots' | 'registerPostFixer' | '_callPostFixers'>`

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

#### Returns

* `void`

<a id="function-_callPostFixers">

### `_callPostFixers( writer ) → void` _(internal)_

Performs post-fixer loops. Executes post-fixer callbacks as long as none of them has done any changes to the model.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L199)

#### Parameters

* `writer: ViewDowncastWriter`

#### Returns

* `void`

<a id="events">

## Events

<a id="event-arrowKey">

### `arrowKey( eventInfo, data )`

Event fired when the user presses an arrow keys.

Introduced by [`ArrowKeysObserver`](module_engine_view_observer_arrowkeysobserver-ArrowKeysObserver.md).

Note that because [`ArrowKeysObserver`](module_engine_view_observer_arrowkeysobserver-ArrowKeysObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/arrowkeysobserver.ts#L66)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentKeyEventData`

<a id="event-beforeinput">

### `beforeinput( eventInfo, data )`

Fired before the web browser inputs, deletes, or formats some data.

This event is introduced by [`InputObserver`](module_engine_view_observer_inputobserver-InputObserver.md) and available by default in all editor instances (attached by [`EditingView`](module_engine_view_view-EditingView.md)).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/inputobserver.ts#L290)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentInputEventData`

  Event data containing detailed information about the event.

#### Related:

* [InputObserver](module_engine_view_observer_inputobserver-InputObserver.md)

<a id="event-blur">

### `blur( eventInfo, data )`

Fired when one of the editables loses focus.

Introduced by [`FocusObserver`](module_engine_view_observer_focusobserver-FocusObserver.md).

Note that because [`FocusObserver`](module_engine_view_observer_focusobserver-FocusObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/focusobserver.ts#L229)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<FocusEvent>`

  Event data.

#### Related:

* [FocusObserver](module_engine_view_observer_focusobserver-FocusObserver.md)

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

### `change:isComposing( eventInfo, name, value, oldValue )`

Fired when the `isComposing` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L89)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isComposing`).

* `value: boolean`

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

* `oldValue: boolean`

  Old value of the `isComposing` property with given key or `null`, if property was not set before.

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

### `change:isFocused( eventInfo, name, value, oldValue )`

Fired when the `isFocused` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L67)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isFocused`).

* `value: boolean`

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

* `oldValue: boolean`

  Old value of the `isFocused` property with given key or `null`, if property was not set before.

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

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

Fired when the `isReadOnly` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L56)

#### 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:isSelecting">

### `change:isSelecting( eventInfo, name, value, oldValue )`

Fired when the `isSelecting` property changed value.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L78)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isSelecting`).

* `value: boolean`

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

* `oldValue: boolean`

  Old value of the `isSelecting` 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-click">

### `click( eventInfo, data )`

Fired when one of the editables has been clicked.

Introduced by [`ClickObserver`](module_engine_view_observer_clickobserver-ClickObserver.md).

Note that this event is not available by default. To make it available [`ClickObserver`](module_engine_view_observer_clickobserver-ClickObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by a [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/clickobserver.ts#L47)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<MouseEvent>`

  Event data.

#### Related:

* [ClickObserver](module_engine_view_observer_clickobserver-ClickObserver.md)

<a id="event-clipboardInput">

### `clipboardInput( eventInfo, data )`

Fired as a continuation of the [event-paste](#event-paste) and [event-drop](#event-drop) events.

It is a part of the [clipboard input pipeline](../framework/deep-dive/clipboard.md#input-pipeline).

This event carries a `dataTransfer` object which comes from the clipboard and whose content should be processed and inserted into the editor.

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

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

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<ClipboardEvent | DragEvent> & ClipboardInputEventData`

  The event data.

#### Related:

* [ClipboardObserver](module_clipboard_clipboardobserver-ClipboardObserver.md)
* [Clipboard](module_clipboard_clipboard-Clipboard.md)

<a id="event-clipboardOutput">

### `clipboardOutput( eventInfo, data )`

Fired on [event-copy](#event-copy) and [event-cut](#event-cut) with a copy of the selected content. The content can be processed before it ends up in the clipboard.

It is a part of the [clipboard output pipeline](../framework/deep-dive/clipboard.md#output-pipeline).

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

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentClipboardOutputEventData`

  The event data.

#### Related:

* [ClipboardObserver](module_clipboard_clipboardobserver-ClipboardObserver.md)
* [ClipboardPipeline](module_clipboard_clipboardpipeline-ClipboardPipeline.md)

<a id="event-compositionend">

### `compositionend( eventInfo, data )`

Fired when composition ends inside one of the editables.

Introduced by [`CompositionObserver`](module_engine_view_observer_compositionobserver-CompositionObserver.md).

Note that because [`CompositionObserver`](module_engine_view_observer_compositionobserver-CompositionObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/compositionobserver.ts#L129)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentCompositionEventData`

  Event data.

#### Related:

* [CompositionObserver](module_engine_view_observer_compositionobserver-CompositionObserver.md)

<a id="event-compositionstart">

### `compositionstart( eventInfo, data )`

Fired when composition starts inside one of the editables.

Introduced by [`CompositionObserver`](module_engine_view_observer_compositionobserver-CompositionObserver.md).

Note that because [`CompositionObserver`](module_engine_view_observer_compositionobserver-CompositionObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/compositionobserver.ts#L95)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentCompositionEventData`

  Event data.

#### Related:

* [CompositionObserver](module_engine_view_observer_compositionobserver-CompositionObserver.md)

<a id="event-compositionupdate">

### `compositionupdate( eventInfo, data )`

Fired when composition is updated inside one of the editables.

Introduced by [`CompositionObserver`](module_engine_view_observer_compositionobserver-CompositionObserver.md).

Note that because [`CompositionObserver`](module_engine_view_observer_compositionobserver-CompositionObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/compositionobserver.ts#L112)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentCompositionEventData`

  Event data.

#### Related:

* [CompositionObserver](module_engine_view_observer_compositionobserver-CompositionObserver.md)

<a id="event-copy">

### `copy( eventInfo, data )`

Fired when the user copied the content from one of the editing roots of the editor.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L274)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<ClipboardEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ClipboardObserver](module_clipboard_clipboardobserver-ClipboardObserver.md)

<a id="event-cut">

### `cut( eventInfo, data )`

Fired when the user cut the content from one of the editing roots of the editor.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L294)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<ClipboardEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ClipboardObserver](module_clipboard_clipboardobserver-ClipboardObserver.md)

<a id="event-delete">

### `delete( eventInfo, data )`

Event fired when the user tries to delete content (e.g. presses `Delete` or `Backspace`).

Note: This event is fired by the [delete observer](module_typing_deleteobserver-DeleteObserver.md) (usually registered by the [delete feature](module_typing_delete-Delete.md)).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-typing/src/deleteobserver.ts#L231)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: DeleteEventData`

  The event data.

<a id="event-dragend">

### `dragend( eventInfo, data )`

Fired when the user ended dragging the content.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L383)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<DragEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ViewDocument#event:clipboardInput](#event-clipboardInput)

<a id="event-dragenter">

### `dragenter( eventInfo, data )`

Fired when the user drags the content into one of the editing roots of the editor.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L403)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<DragEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ViewDocument#event:clipboardInput](#event-clipboardInput)

<a id="event-dragging">

### `dragging( eventInfo, data )`

Fired as a continuation of the [event-dragover](#event-dragover) event.

It is a part of the [clipboard input pipeline](../framework/deep-dive/clipboard.md#input-pipeline).

This event carries a `dataTransfer` object which comes from the clipboard and whose content should be processed and inserted into the editor.

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L319)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<DragEvent> & DraggingEventData`

  The event data.

#### Related:

* [ClipboardObserver](module_clipboard_clipboardobserver-ClipboardObserver.md)
* [Clipboard](module_clipboard_clipboard-Clipboard.md)

<a id="event-dragleave">

### `dragleave( eventInfo, data )`

Fired when the user drags the content out of one of the editing roots of the editor.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L423)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<DragEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ViewDocument#event:clipboardInput](#event-clipboardInput)

<a id="event-dragover">

### `dragover( eventInfo, data )`

Fired when the user drags the content over one of the editing roots of the editor.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L214)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<DragEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ViewDocument#event:clipboardInput](#event-clipboardInput)

<a id="event-dragstart">

### `dragstart( eventInfo, data )`

Fired when the user starts dragging the content in one of the editing roots of the editor.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L363)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<DragEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ViewDocument#event:clipboardInput](#event-clipboardInput)

<a id="event-drop">

### `drop( eventInfo, data )`

Fired when the user dropped the content into one of the editing roots of the editor.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

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

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<DragEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ViewDocument#event:clipboardInput](#event-clipboardInput)

<a id="event-enter">

### `enter( eventInfo, <anonymous> )`

Fired when the user presses the `Enter` key.

Note: This event is fired by the [observer](module_enter_enterobserver-EnterObserver.md) (usually registered by the [Enter feature](module_enter_enter-Enter.md) and [ShiftEnter feature](module_enter_shiftenter-ShiftEnter.md)).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-enter/src/enterobserver.ts#L97)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: ViewDocumentEnterEventData`

<a id="event-focus">

### `focus( eventInfo, data )`

Fired when one of the editables gets focus.

Introduced by [`FocusObserver`](module_engine_view_observer_focusobserver-FocusObserver.md).

Note that because [`FocusObserver`](module_engine_view_observer_focusobserver-FocusObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/focusobserver.ts#L212)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<FocusEvent>`

  Event data.

#### Related:

* [FocusObserver](module_engine_view_observer_focusobserver-FocusObserver.md)

<a id="event-imageLoaded">

### `imageLoaded( eventInfo, data )`

Fired when an DOM element has been loaded in the DOM root.

Introduced by [`ImageLoadObserver`](module_image_image_imageloadobserver-ImageLoadObserver.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-image/src/image/imageloadobserver.ts#L71)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: Event`

  Event data.

#### Related:

* [ImageLoadObserver](module_image_image_imageloadobserver-ImageLoadObserver.md)

<a id="event-insertText">

### `insertText( eventInfo, data )`

Event fired when the user types text, for instance presses `A` or `?` in the editing view document.

**Note**: This event will **not** fire for keystrokes such as `Delete` or `Enter`. They have dedicated events, see [event-delete](#event-delete) and [event-enter](#event-enter) to learn more.

**Note**: This event is fired by the [input feature](module_typing_inserttextobserver-InsertTextObserver.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-typing/src/inserttextobserver.ts#L161)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: InsertTextEventData`

  The event data.

<a id="event-keydown">

### `keydown( eventInfo, data )`

Fired when a key has been pressed.

Introduced by [`KeyObserver`](module_engine_view_observer_keyobserver-KeyObserver.md).

Note that because [`KeyObserver`](module_engine_view_observer_keyobserver-KeyObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/keyobserver.ts#L58)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentKeyEventData`

#### Related:

* [KeyObserver](module_engine_view_observer_keyobserver-KeyObserver.md)

<a id="event-keyup">

### `keyup( eventInfo, data )`

Fired when a key has been released.

Introduced by [`KeyObserver`](module_engine_view_observer_keyobserver-KeyObserver.md).

Note that because [`KeyObserver`](module_engine_view_observer_keyobserver-KeyObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/keyobserver.ts#L74)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentKeyEventData`

#### Related:

* [KeyObserver](module_engine_view_observer_keyobserver-KeyObserver.md)

<a id="event-layoutChanged">

### `layoutChanged( eventInfo )`

Event fired whenever document content layout changes. It is fired whenever content is [rendered](module_engine_view_view-EditingView.md#event-render), but should be also fired by observers in case of other actions which may change layout, for instance when image loads.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/document.ts#L243)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

<a id="event-mousedown">

### `mousedown( eventInfo, data )`

Fired when the mouse button is pressed down on one of the editing roots of the editor.

Introduced by [`MouseObserver`](module_engine_view_observer_mouseobserver-MouseObserver.md).

Note that this event is not available by default. To make it available, [`MouseObserver`](module_engine_view_observer_mouseobserver-MouseObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/mouseobserver.ts#L45)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<MouseEvent>`

  The event data.

#### Related:

* [MouseObserver](module_engine_view_observer_mouseobserver-MouseObserver.md)

<a id="event-mouseleave">

### `mouseleave( eventInfo, data )`

Fired when the mouse is moved out of one of the editables.

Introduced by [`MouseEventsObserver`](module_table_tablemouse_mouseeventsobserver-MouseEventsObserver.md).

Note that this event is not available by default. To make it available, [`MouseEventsObserver`](module_table_tablemouse_mouseeventsobserver-MouseEventsObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tablemouse/mouseeventsobserver.ts#L71)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<MouseEvent>`

  Event data.

#### Related:

* [MouseEventsObserver](module_table_tablemouse_mouseeventsobserver-MouseEventsObserver.md)

<a id="event-mousemove">

### `mousemove( eventInfo, data )`

Fired when the mouse is moved over one of the editables.

Introduced by [`MouseEventsObserver`](module_table_tablemouse_mouseeventsobserver-MouseEventsObserver.md).

Note that this event is not available by default. To make it available, [`MouseEventsObserver`](module_table_tablemouse_mouseeventsobserver-MouseEventsObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-table/src/tablemouse/mouseeventsobserver.ts#L53)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<MouseEvent>`

  Event data.

#### Related:

* [MouseEventsObserver](module_table_tablemouse_mouseeventsobserver-MouseEventsObserver.md)

<a id="event-mouseout">

### `mouseout( eventInfo, data )`

Fired when the mouse is moved out of the one of the editing roots of the editor.

Introduced by [`MouseObserver`](module_engine_view_observer_mouseobserver-MouseObserver.md).

Note that this event is not available by default. To make it available, [`MouseObserver`](module_engine_view_observer_mouseobserver-MouseObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/mouseobserver.ts#L96)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<MouseEvent>`

  The event data.

#### Related:

* [MouseObserver](module_engine_view_observer_mouseobserver-MouseObserver.md)

<a id="event-mouseover">

### `mouseover( eventInfo, data )`

Fired when the mouse is over one of the editing roots of the editor.

Introduced by [`MouseObserver`](module_engine_view_observer_mouseobserver-MouseObserver.md).

Note that this event is not available by default. To make it available, [`MouseObserver`](module_engine_view_observer_mouseobserver-MouseObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/mouseobserver.ts#L79)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<MouseEvent>`

  The event data.

#### Related:

* [MouseObserver](module_engine_view_observer_mouseobserver-MouseObserver.md)

<a id="event-mouseup">

### `mouseup( eventInfo, data )`

Fired when the mouse button is released over one of the editing roots of the editor.

Introduced by [`MouseObserver`](module_engine_view_observer_mouseobserver-MouseObserver.md).

Note that this event is not available by default. To make it available, [`MouseObserver`](module_engine_view_observer_mouseobserver-MouseObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/mouseobserver.ts#L62)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<MouseEvent>`

  The event data.

#### Related:

* [MouseObserver](module_engine_view_observer_mouseobserver-MouseObserver.md)

<a id="event-mutations">

### `mutations( eventInfo, data )`

Event fired on DOM mutations detected.

This event is introduced by [`MutationObserver`](module_engine_view_observer_mutationobserver-MutationObserver.md) and available by default in all editor instances (attached by [`EditingView`](module_engine_view_view-EditingView.md)).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/mutationobserver.ts#L289)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentMutationEventData`

  Event data containing detailed information about the event.

<a id="event-paste">

### `paste( eventInfo, data )`

Fired when the user pasted the content into one of the editing roots of the editor.

Introduced by [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md).

**Note**: This event is not available by default. To make it available, [`ClipboardObserver`](module_clipboard_clipboardobserver-ClipboardObserver.md) needs to be added to the [`ViewDocument`](module_engine_view_document-ViewDocument.md) by using the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method. This is usually done by the [`Clipboard`](module_clipboard_clipboard-Clipboard.md) plugin, but if for some reason it is not loaded, the observer must be added manually.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-clipboard/src/clipboardobserver.ts#L254)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<ClipboardEvent> & ClipboardEventData`

  The event data.

#### Related:

* [ViewDocument#event:clipboardInput](#event-clipboardInput)

<a id="event-pointerdown">

### `pointerdown( eventInfo, data )`

Fired when a pointer is down on one of the editing roots of the editor.

Introduced by [`PointerObserver`](module_engine_view_observer_pointerobserver-PointerObserver.md).

Note that this event is not available by default. To make it available, [`PointerObserver`](module_engine_view_observer_pointerobserver-PointerObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/pointerobserver.ts#L46)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<PointerEvent>`

  The event data.

#### Related:

* [PointerObserver](module_engine_view_observer_pointerobserver-PointerObserver.md)

<a id="event-pointermove">

### `pointermove( eventInfo, data )`

Fired when a pointer is moved on one of the editing roots of the editor.

Introduced by [`PointerObserver`](module_engine_view_observer_pointerobserver-PointerObserver.md).

Note that this event is not available by default. To make it available, [`PointerObserver`](module_engine_view_observer_pointerobserver-PointerObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/pointerobserver.ts#L82)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<PointerEvent>`

  The event data.

#### Related:

* [PointerObserver](module_engine_view_observer_pointerobserver-PointerObserver.md)

<a id="event-pointerup">

### `pointerup( eventInfo, data )`

Fired when a pointer is up on one of the editing roots of the editor.

Introduced by [`PointerObserver`](module_engine_view_observer_pointerobserver-PointerObserver.md).

Note that this event is not available by default. To make it available, [`PointerObserver`](module_engine_view_observer_pointerobserver-PointerObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/pointerobserver.ts#L64)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<PointerEvent>`

  The event data.

#### Related:

* [PointerObserver](module_engine_view_observer_pointerobserver-PointerObserver.md)

<a id="event-selectionChange">

### `selectionChange( eventInfo, <anonymous> )`

Fired when a selection has changed. This event is fired only when the selection change was the only change that happened in the document, and the old selection is different then the new selection.

Introduced by [`SelectionObserver`](module_engine_view_observer_selectionobserver-SelectionObserver.md).

Note that because [`SelectionObserver`](module_engine_view_observer_selectionobserver-SelectionObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/selectionobserver.ts#L452)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: ViewDocumentObserverSelectionEventData`

#### Related:

* [SelectionObserver](module_engine_view_observer_selectionobserver-SelectionObserver.md)

<a id="event-selectionChangeDone">

### `selectionChangeDone( eventInfo, <anonymous> )`

Fired when selection stops changing.

Introduced by [`SelectionObserver`](module_engine_view_observer_selectionobserver-SelectionObserver.md).

Note that because [`SelectionObserver`](module_engine_view_observer_selectionobserver-SelectionObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md) this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/selectionobserver.ts#L468)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `<anonymous>: ViewDocumentObserverSelectionEventData`

#### Related:

* [SelectionObserver](module_engine_view_observer_selectionobserver-SelectionObserver.md)

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

### `set:isComposing( eventInfo, name, value, oldValue )`

Fired when the `isComposing` 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-engine/src/view/document.ts#L89)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isComposing`).

* `value: boolean`

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

* `oldValue: boolean`

  Old value of the `isComposing` property with given key or `null`, if property was not set before.

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

### `set:isFocused( eventInfo, name, value, oldValue )`

Fired when the `isFocused` 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-engine/src/view/document.ts#L67)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isFocused`).

* `value: boolean`

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

* `oldValue: boolean`

  Old value of the `isFocused` property with given key or `null`, if property was not set before.

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

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

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-engine/src/view/document.ts#L56)

#### 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:isSelecting">

### `set:isSelecting( eventInfo, name, value, oldValue )`

Fired when the `isSelecting` 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-engine/src/view/document.ts#L78)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `name: string`

  Name of the changed property (`isSelecting`).

* `value: boolean`

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

* `oldValue: boolean`

  Old value of the `isSelecting` 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.

<a id="event-tab">

### `tab( eventInfo, data )`

Event fired when the user presses a tab key.

Introduced by [`TabObserver`](module_engine_view_observer_tabobserver-TabObserver.md).

Note that because [`TabObserver`](module_engine_view_observer_tabobserver-TabObserver.md) is attached by the [`EditingView`](module_engine_view_view-EditingView.md), this event is available by default.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/tabobserver.ts#L74)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentKeyEventData`

<a id="event-todoCheckboxChange">

### `todoCheckboxChange( eventInfo, data )`

Fired when the to-do list checkbox is toggled.

Introduced by [`TodoCheckboxChangeObserver`](module_list_todolist_todocheckboxchangeobserver-TodoCheckboxChangeObserver.md).

Note that this event is not available by default. To make it available, [`TodoCheckboxChangeObserver`](module_list_todolist_todocheckboxchangeobserver-TodoCheckboxChangeObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/todolist/todocheckboxchangeobserver.ts#L58)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<Event>`

  The event data.

#### Related:

* [TodoCheckboxChangeObserver](module_list_todolist_todocheckboxchangeobserver-TodoCheckboxChangeObserver.md)

<a id="event-touchend">

### `touchend( eventInfo, data )`

Fired when a touch ends on one of the editing roots of the editor.

Introduced by [`TouchObserver`](module_engine_view_observer_touchobserver-TouchObserver.md).

Note that this event is not available by default. To make it available, [`TouchObserver`](module_engine_view_observer_touchobserver-TouchObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/touchobserver.ts#L62)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<TouchEvent>`

  The event data.

#### Related:

* [TouchObserver](module_engine_view_observer_touchobserver-TouchObserver.md)

<a id="event-touchmove">

### `touchmove( eventInfo, data )`

Fired when a touch is moved on one of the editing roots of the editor.

Introduced by [`TouchObserver`](module_engine_view_observer_touchobserver-TouchObserver.md).

Note that this event is not available by default. To make it available, [`TouchObserver`](module_engine_view_observer_touchobserver-TouchObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/touchobserver.ts#L79)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<TouchEvent>`

  The event data.

#### Related:

* [TouchObserver](module_engine_view_observer_touchobserver-TouchObserver.md)

<a id="event-touchstart">

### `touchstart( eventInfo, data )`

Fired when a touch is started on one of the editing roots of the editor.

Introduced by [`TouchObserver`](module_engine_view_observer_touchobserver-TouchObserver.md).

Note that this event is not available by default. To make it available, [`TouchObserver`](module_engine_view_observer_touchobserver-TouchObserver.md) needs to be added to [`EditingView`](module_engine_view_view-EditingView.md) by the [`addObserver`](module_engine_view_view-EditingView.md#function-addObserver) method.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-engine/src/view/observer/touchobserver.ts#L45)

#### Parameters

* `eventInfo: EventInfo`

  An object containing information about the fired event.

* `data: ViewDocumentDomEventData<TouchEvent>`

  The event data.

#### Related:

* [TouchObserver](module_engine_view_observer_touchobserver-TouchObserver.md)

---

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