Model

Model's document.

Model's marker collection.

Model's schema.

The last created and currently used writer instance.

All callbacks added by change or enqueueChange methods waiting to be executed.

Decorated function for applying operations to the model.

This is a low-level way of changing the model. It is exposed for very specific use cases (like the undo feature). Normally, to modify the model, you will want to use Writer. See also Changing the model section of the Editing architecture guide.

Parameters

operation : Operation

The operation to apply.

Returns

void

Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:

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

or even shorter:

button.bind( 'isEnabled' ).to( command );

which works in the following way:

• button.isEnabled instantly equals command.isEnabled,
• whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

Note: To release the binding, use unbind.

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

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

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

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

which corresponds to:

button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

The binding can include more than one observable, combining multiple data sources in a custom callback:

button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

Using a custom callback allows processing the value before passing it to the target property:

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:

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

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

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

Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:

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

or even shorter:

button.bind( 'isEnabled' ).to( command );

which works in the following way:

• button.isEnabled instantly equals command.isEnabled,
• whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

Note: To release the binding, use unbind.

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

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

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

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

which corresponds to:

button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

The binding can include more than one observable, combining multiple data sources in a custom callback:

button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

Using a custom callback allows processing the value before passing it to the target property:

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:

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

Parameters

bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'change' | 'document' | 'destroy' | 'schema' | 'applyOperation' | 'markers' | 'enqueueChange' | 'insertContent' | 'insertObject' | 'deleteContent' | 'modifySelection' | 'getSelectedContent' | 'hasContent' | 'canEditAt' | 'createPositionFromPath' | 'createPositionAt' | 'createPositionAfter' | 'createPositionBefore' | 'createRange' | 'createRangeIn' | 'createRangeOn' | 'createSelection' | 'createBatch' | 'createOperationFromJSON'>

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

Returns

ObservableMultiBindChain

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

Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:

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

or even shorter:

button.bind( 'isEnabled' ).to( command );

which works in the following way:

• button.isEnabled instantly equals command.isEnabled,
• whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

Note: To release the binding, use unbind.

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

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

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

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

which corresponds to:

button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

The binding can include more than one observable, combining multiple data sources in a custom callback:

button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

Using a custom callback allows processing the value before passing it to the target property:

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:

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

Type parameters

K

Parameters

bindProperty : K

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

Returns

ObservableSingleBindChain<K, Model[ K ]>

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

Check whether given selectable is at a place in the model where it can be edited (returns true) or not (returns false).

Should be used instead of isReadOnly to check whether a user action can happen at given selectable. It may be decorated and used differently in different environment (e.g. multi-root editor can disable a particular root).

This method is decorated. Although this method accepts any parameter of Selectable type, the canEditAt event is fired with selectable normalized to an instance of ModelSelection or ModelDocumentSelection

Parameters

selectable : ModelSelectable

Returns

boolean

Fires

• canEditAt

The change() method is the primary way of changing the model. You should use it to modify all document nodes (including detached nodes – i.e. nodes not added to the model document), the document's selection, and model markers.

model.change( writer => {
	writer.insertText( 'foo', paragraph, 'end' );
} );

All changes inside the change block use the same Batch so they are combined into a single undo step.

model.change( writer => {
	writer.insertText( 'foo', paragraph, 'end' ); // foo.

	model.change( writer => {
		writer.insertText( 'bar', paragraph, 'end' ); // foobar.
	} );

	writer.insertText( 'bom', paragraph, 'end' ); // foobarbom.
} );

The callback of the change() block is executed synchronously.

You can also return a value from the change block.

const img = model.change( writer => {
	return writer.createElement( 'img' );
} );

Type parameters

TReturn

The return type of the provided callback.

Parameters

callback : ( writer: ModelWriter ) => TReturn

Callback function which may modify the model.

Returns

TReturn

Related:

• Model#enqueueChange

Creates a Batch instance.

Note: In most cases creating a batch instance is not necessary as they are created when using:

• change(),
• enqueueChange().

Parameters

[ type ] : BatchType

The type of the batch.

Returns

Batch

Creates an operation instance from a JSON object (parsed JSON string).

This is an alias for OperationFactory.fromJSON().

Parameters

json : unknown

Deserialized JSON object.

Returns

Operation

Creates a new position after the given model item.

Note: This method is also available as Writer#createPositionAfter().

Parameters

item : ModelItem

Item after which the position should be placed.

Returns

ModelPosition

Creates position at the given location. The location can be specified as:

• a position,
• a parent element and offset in that element,
• a parent element and 'end' (the position will be set at the end of that element),
• a model item and 'before' or 'after' (the position will be set before or after the given model item).

This method is a shortcut to other factory methods such as:

• createPositionBefore(),
• createPositionAfter().

Note: This method is also available as Writer#createPositionAt(),

Parameters

itemOrPosition : ModelDocumentFragment | ModelPosition | ModelItem

[ offset ] : ModelPositionOffset

Offset or one of the flags. Used only when first parameter is a model item.

Returns

ModelPosition

Creates a new position before the given model item.

Note: This method is also available as Writer#createPositionBefore().

Parameters

item : ModelItem

Item before which the position should be placed.

Returns

ModelPosition

Creates a position from the given root and path in that root.

Note: This method is also available as Writer#createPositionFromPath().

Parameters

root : ModelElement | ModelDocumentFragment

Root of the position.

path : readonly Array<number>

Position path. See path.

[ stickiness ] : ModelPositionStickiness

Position stickiness. See ModelPositionStickiness.

Returns

ModelPosition

Creates a range spanning from the start position to the end position.

Note: This method is also available as Writer#createRange():

model.change( writer => {
	const range = writer.createRange( start, end );
} );

Parameters

start : ModelPosition

Start position.

[ end ] : ModelPosition

End position. If not set, the range will be collapsed to the start position.

Returns

ModelRange

Creates a range inside the given element which starts before the first child of that element and ends after the last child of that element.

Note: This method is also available as Writer#createRangeIn():

model.change( writer => {
	const range = writer.createRangeIn( paragraph );
} );

Parameters

element : ModelElement | ModelDocumentFragment

Element which is a parent for the range.

Returns

ModelRange

Creates a range that starts before the given model item and ends after it.

Note: This method is also available on writer instance as Writer.createRangeOn():

model.change( writer => {
	const range = writer.createRangeOn( paragraph );
} );

Parameters

item : ModelItem

Returns

ModelRange

Creates a new selection instance based on the given selectable or creates an empty selection if no arguments were passed.

Note: This method is also available as Writer#createSelection().

// Creates empty selection without ranges.
const selection = writer.createSelection();

// Creates selection at the given range.
const range = writer.createRange( start, end );
const selection = writer.createSelection( range );

// Creates selection at the given ranges
const ranges = [ writer.createRange( start1, end2 ), writer.createRange( star2, end2 ) ];
const selection = writer.createSelection( ranges );

// Creates selection from the other selection.
// Note: It doesn't copies selection attributes.
const otherSelection = writer.createSelection();
const selection = writer.createSelection( otherSelection );

// Creates selection from the given document selection.
// Note: It doesn't copies selection attributes.
const documentSelection = model.document.selection;
const selection = writer.createSelection( documentSelection );

// Creates selection at the given position.
const position = writer.createPositionFromPath( root, path );
const selection = writer.createSelection( position );

// Additional options (`'backward'`) can be specified as the last argument.

// Creates backward selection.
const selection = writer.createSelection( range, { backward: true } );

See also: createSelection( node, placeOrOffset, options ).

Parameters

[ selectable ] : null | ModelPosition | ModelRange | ModelSelection | ModelDocumentSelection | Iterable<ModelRange>

[ options ] : object

Properties

[ options.backward ] : boolean

Returns

ModelSelection

Creates a new selection instance based on the given selectable or creates an empty selection if no arguments were passed.

Note: This method is also available as Writer#createSelection().

// Creates selection at the given offset in the given element.
const paragraph = writer.createElement( 'paragraph' );
const selection = writer.createSelection( paragraph, offset );

// Creates a range inside an element which starts before the
// first child of that element and ends after the last child of that element.
const selection = writer.createSelection( paragraph, 'in' );

// Creates a range on an item which starts before the item and ends
// just after the item.
const selection = writer.createSelection( paragraph, 'on' );

// Additional options (`'backward'`) can be specified as the last argument.

// Creates backward selection.
const selection = writer.createSelection( element, 'in', { backward: true } );

See also: createSelection( selectable, options ).

Parameters

selectable : ModelNode

placeOrOffset : ModelPlaceOrOffset

[ options ] : object

Properties

[ options.backward ] : boolean

Returns

ModelSelection

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 guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be stopped:

class Foo 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 listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:

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

foo.method(); // -> 'Foo'

Finally, it is possible to access and modify the arguments the method is called with:

method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'

Parameters

methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'change' | 'document' | 'destroy' | 'schema' | 'applyOperation' | 'markers' | 'enqueueChange' | 'insertContent' | 'insertObject' | 'deleteContent' | 'modifySelection' | 'getSelectedContent' | 'hasContent' | 'canEditAt' | 'createPositionFromPath' | 'createPositionAt' | 'createPositionAfter' | 'createPositionBefore' | 'createRange' | 'createRangeIn' | 'createRangeOn' | 'createSelection' | 'createBatch' | 'createOperationFromJSON'

Name of the method to decorate.

Returns

void

Delegates selected events to another Emitter. For instance:

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

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

emitterA.fire( 'eventX', data );

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

emitterA.fire( 'eventY', data );

Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain

Deletes content of the selection and merge siblings. The resulting selection is always collapsed.

Note: For the sake of predictability, the resulting selection should always be collapsed. In cases where a feature wants to modify deleting behavior so selection isn't collapsed (e.g. a table feature may want to keep row selection after pressing Backspace), then that behavior should be implemented in the view's listener. At the same time, the table feature will need to modify this method's behavior too, e.g. to "delete contents and then collapse the selection inside the last selected cell" or "delete the row and collapse selection somewhere near". That needs to be done in order to ensure that other features which use deleteContent() will work well with tables.

Parameters

selection : ModelSelection | ModelDocumentSelection

Selection of which the content should be deleted.

[ options ] : object

Properties

[ options.direction ] : 'forward' | 'backward'

The direction in which the content is being consumed. Deleting backward corresponds to using the Backspace key, while deleting content forward corresponds to the Shift+Backspace keystroke.

[ options.doNotAutoparagraph ] : boolean

Whether to create a paragraph if after content deletion selection is moved to a place where text cannot be inserted.

For example <paragraph>x</paragraph>[<imageBlock src="foo.jpg"></imageBlock>] will become:

• <paragraph>x</paragraph><paragraph>[]</paragraph> with the option disabled (doNotAutoparagraph == false)
• <paragraph>x[]</paragraph> with the option enabled (doNotAutoparagraph == true).

Note: if there is no valid position for the selection, the paragraph will always be created:

[<imageBlock src="foo.jpg"></imageBlock>] -> <paragraph>[]</paragraph>.

[ options.doNotResetEntireContent ] : boolean

Whether to skip replacing the entire content with a paragraph when the entire content was selected.

For example <heading1>[x</heading1><paragraph>y]</paragraph> will become:

• <paragraph>^</paragraph> with the option disabled (doNotResetEntireContent == false)
• <heading1>^</heading1> with enabled (doNotResetEntireContent == true)

[ options.leaveUnmerged ] : boolean

Whether to merge elements after removing the content of the selection.

For example <heading1>x[x</heading1><paragraph>y]y</paragraph> will become:

• <heading1>x^y</heading1> with the option disabled (leaveUnmerged == false)
• <heading1>x^</heading1><paragraph>y</paragraph> with enabled (leaveUnmerged == true).

Note: object and limit elements will not be merged.

options.[i: string] : unknown

Returns

void

Fires

• deleteContent

Removes all events listeners set by model instance and destroys ModelDocument.

Returns

void

The enqueueChange() method performs similar task as the change() method, with two major differences.

First, the callback of enqueueChange() is executed when all other enqueued changes are done. It might be executed immediately if it is not nested in any other change block, but if it is nested in another (enqueue)change block, it will be delayed and executed after the outermost block.

model.change( new Batch(), writer => {
	console.log( 1 );

	model.enqueueChange( new Batch(), writer => {
		console.log( 2 );
	} );

	console.log( 3 );
} ); // Will log: 1, 3, 2.

In addition to that, the changes enqueued with enqueueChange() will be converted separately from the changes done in the outer change() block.

Second, it lets you define the Batch into which you want to add your changes. If you want to use default batch type, use enqueueChange( callback ).

model.enqueueChange( { isUndoable: false }, writer => {
	writer.insertText( 'foo', paragraph, 'end' );
} );

When using the enqueueChange() block you can also add some changes to the batch you used before.

model.enqueueChange( batch, writer => {
	writer.insertText( 'foo', paragraph, 'end' );
} );

In order to make a nested enqueueChange() create a single undo step together with the changes done in the outer change() block, you can obtain the batch instance from the writer of the outer block.

Parameters

batchOrType : undefined | Batch | BatchType

A batch or a batch type that should be used in the callback. If not defined, a new batch with the default type will be created.

callback : ( writer: ModelWriter ) => unknown

Callback function which may modify the model.

Returns

void

The enqueueChange() method performs similar task as the change() method, with two major differences.

First, the callback of enqueueChange() is executed when all other enqueued changes are done. It might be executed immediately if it is not nested in any other change block, but if it is nested in another (enqueue)change block, it will be delayed and executed after the outermost block.

model.change( writer => {
	console.log( 1 );

	model.enqueueChange( writer => {
		console.log( 2 );
	} );

	console.log( 3 );
} ); // Will log: 1, 3, 2.

In addition to that, the changes enqueued with enqueueChange() will be converted separately from the changes done in the outer change() block.

By default, a new batch with the default batch type is created. To define the Batch into which you want to add your changes, use enqueueChange( batchOrType, callback ).

Parameters

callback : ( writer: ModelWriter ) => unknown

Callback function which may modify the model.

Returns

void

Fires an event, executing all callbacks registered for it.

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

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

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's property (the event info is the first param of every callback).

Gets a clone of the selected content.

For example, for the following selection:

<paragraph>x</paragraph>
<blockQuote>
	<paragraph>y</paragraph>
	<heading1>fir[st</heading1>
</blockQuote>
<paragraph>se]cond</paragraph>
<paragraph>z</paragraph>

It will return a document fragment with such a content:

<blockQuote>
	<heading1>st</heading1>
</blockQuote>
<paragraph>se</paragraph>

Parameters

selection : ModelSelection | ModelDocumentSelection

The selection of which content will be returned.

Returns

ModelDocumentFragment

Fires

• getSelectedContent

Checks whether the given range or element has any meaningful content.

Meaningful content is:

• any text node (options.ignoreWhitespaces allows controlling whether this text node must also contain any non-whitespace characters),
• or any content element,
• or any marker which affects data.

This means that a range containing an empty <paragraph></paragraph> is not considered to have a meaningful content. However, a range containing an <imageBlock></imageBlock> (which would normally be marked in the schema as an object element) is considered non-empty.

Parameters

rangeOrElement : ModelElement | ModelDocumentFragment | ModelRange

Range or element to check.

options : object

Properties

[ options.ignoreMarkers ] : boolean

Whether markers should be ignored.

[ options.ignoreWhitespaces ] : boolean

Whether text node with whitespaces only should be considered empty.

Defaults to {}

Returns

boolean

Inserts content at the position in the editor specified by the selection, as one would expect the paste functionality to work.

Note: If you want to insert an object element (e.g. a widget), see insertObject instead.

This is a high-level method. It takes the schema into consideration when inserting the content, clears the given selection's content before inserting nodes and moves the selection to its target position at the end of the process. It can split elements, merge them, wrap bare text nodes with paragraphs, etc. – just like the pasting feature should do.

For lower-level methods see Writer.

This method, unlike Writer's methods, does not have to be used inside a change() block.

Conversion and schema

Inserting elements and text nodes into the model is not enough to make CKEditor 5 render that content to the user. CKEditor 5 implements a model-view-controller architecture and what model.insertContent() does is only adding nodes to the model. Additionally, you need to define converters between the model and view and define those nodes in the schema.

So, while this method may seem similar to CKEditor 4 editor.insertHtml() (in fact, both methods are used for paste-like content insertion), the CKEditor 5 method cannot be use to insert arbitrary HTML unless converters are defined for all elements and attributes in that HTML.

Examples

Using insertContent() with a manually created model structure:

// Let's create a document fragment containing such content as:
//
// <paragraph>foo</paragraph>
// <blockQuote>
//    <paragraph>bar</paragraph>
// </blockQuote>
const docFrag = editor.model.change( writer => {
	const p1 = writer.createElement( 'paragraph' );
	const p2 = writer.createElement( 'paragraph' );
	const blockQuote = writer.createElement( 'blockQuote' );
	const docFrag = writer.createDocumentFragment();

	writer.append( p1, docFrag );
	writer.append( blockQuote, docFrag );
	writer.append( p2, blockQuote );
	writer.insertText( 'foo', p1 );
	writer.insertText( 'bar', p2 );

	return docFrag;
} );

// insertContent() does not have to be used in a change() block. It can, though,
// so this code could be moved to the callback defined above.
editor.model.insertContent( docFrag );

Using insertContent() with an HTML string converted to a model document fragment (similar to the pasting mechanism):

// You can create your own HtmlDataProcessor instance or use editor.data.processor
// if you have not overridden the default one (which is the HtmlDataProcessor instance).
const htmlDP = new HtmlDataProcessor( viewDocument );

// Convert an HTML string to a view document fragment:
const viewFragment = htmlDP.toView( htmlString );

// Convert the view document fragment to a model document fragment
// in the context of $root. This conversion takes the schema into
// account so if, for example, the view document fragment contained a bare text node,
// this text node cannot be a child of $root, so it will be automatically
// wrapped with a <paragraph>. You can define the context yourself (in the second parameter),
// and e.g. convert the content like it would happen in a <paragraph>.
// Note: The clipboard feature uses a custom context called $clipboardHolder
// which has a loosened schema.
const modelFragment = editor.data.toModel( viewFragment );

editor.model.insertContent( modelFragment );

By default this method will use the document selection but it can also be used with a position, range or selection instance.

// Insert text at the current document selection position.
editor.model.change( writer => {
	editor.model.insertContent( writer.createText( 'x' ) );
} );

// Insert text at a given position - the document selection will not be modified.
editor.model.change( writer => {
	editor.model.insertContent( writer.createText( 'x' ), doc.getRoot(), 2 );

	// Which is a shorthand for:
	editor.model.insertContent( writer.createText( 'x' ), writer.createPositionAt( doc.getRoot(), 2 ) );
} );

If you want the document selection to be moved to the inserted content, use the setSelection() method of the writer after inserting the content:

editor.model.change( writer => {
	const paragraph = writer.createElement( 'paragraph' );

	// Insert an empty paragraph at the beginning of the root.
	editor.model.insertContent( paragraph, writer.createPositionAt( editor.model.document.getRoot(), 0 ) );

	// Move the document selection to the inserted paragraph.
	writer.setSelection( paragraph, 'in' );
} );

If an instance of the model selection is passed as selectable, the new content will be inserted at the passed selection (instead of document selection):

editor.model.change( writer => {
	// Create a selection in a paragraph that will be used as a place of insertion.
	const selection = writer.createSelection( paragraph, 'in' );

	// Insert the new text at the created selection.
	editor.model.insertContent( writer.createText( 'x' ), selection );

	// insertContent() modifies the passed selection instance so it can be used to set the document selection.
	// Note: This is not necessary when you passed the document selection to insertContent().
	writer.setSelection( selection );
} );

Parameters

content : ModelDocumentFragment | ModelItem

The content to insert.

[ selectable ] : ModelSelectable

The selection into which the content should be inserted. If not provided the current model document selection will be used.

[ placeOrOffset ] : ModelPlaceOrOffset

To be used when a model item was passed as selectable. This param defines a position in relation to that item. at the insertion position.

rest : Array<unknown>

Returns

ModelRange

Fires

• insertContent

Inserts an object element at a specific position in the editor content.

This is a high-level API:

• It takes the schema into consideration,
• It clears the content of passed selectable before inserting,
• It can move the selection at the end of the process,
• It will copy the selected block's attributes to preserve them upon insertion,
• It can split elements or wrap inline objects with paragraphs if they are not allowed in target position,
• etc.

Notes

• If you want to insert a non-object content, see insertContent instead.
• For lower-level API, see Writer.
• Unlike Writer, this method does not have to be used inside a change() block.
• Inserting object into the model is not enough to make CKEditor 5 render that content to the user. CKEditor 5 implements a model-view-controller architecture and what model.insertObject() does is only adding nodes to the model. Additionally, you need to define converters between the model and view and define those nodes in the schema.

Examples

Use the following code to insert an object at the current selection and keep the selection on the inserted element:

const rawHtmlEmbedElement = writer.createElement( 'rawHtml' );

model.insertObject( rawHtmlEmbedElement, null, null, {
	setSelection: 'on'
} );

Use the following code to insert an object at the current selection and nudge the selection after the inserted object:

const pageBreakElement = writer.createElement( 'pageBreak' );
 *
model.insertObject( pageBreakElement, null, null, {
	setSelection: 'after'
} );

Use the following code to insert an object at the current selection and avoid splitting the content (non-destructive insertion):

const tableElement = writer.createElement( 'table' );
 *
model.insertObject( tableElement, null, null, {
	findOptimalPosition: 'auto'
} );

Use the following code to insert an object at the specific range (also: replace the content of the range):

const tableElement = writer.createElement( 'table' );
const range = model.createRangeOn( model.document.getRoot().getChild( 1 ) );
 *
model.insertObject( tableElement, range );

Parameters

element : ModelElement

An object to be inserted into the model document.

[ selectable ] : ModelSelectable

A selectable where the content should be inserted. If not specified, the current document selection will be used instead.

[ placeOrOffset ] : null | ModelPlaceOrOffset

Specifies the exact place or offset for the insertion to take place, relative to selectable.

[ options ] : object

Additional options.

Properties

[ options.findOptimalPosition ] : 'auto' | 'after' | 'before'

An option that, when set, adjusts the insertion position (relative to selectable and placeOrOffset) so that the content of selectable is not split upon insertion (a.k.a. non-destructive insertion).

• When 'auto', the algorithm will decide whether to insert the object before or after selectable to avoid content splitting.
• When 'before', the closest position before selectable will be used that will not result in content splitting.
• When 'after', the closest position after selectable will be used that will not result in content splitting.

Note that this option only works for block objects. Inline objects are inserted into text and do not split blocks.

[ options.setSelection ] : 'on' | 'after'

An option that, when set, moves the document selection after inserting the object.

• When 'on', the document selection will be set on the inserted object.
• When 'after', the document selection will move to the closest text node after the inserted object. If there is no such text node, a paragraph will be created and the document selection will be moved inside it. at the insertion position.

rest : Array<unknown>

Returns

ModelRange

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

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );

An event callback can stop the event and set the return value of the fire method.

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

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

Modifies the selection. Currently, the supported modifications are:

• Extending. The selection focus is moved in the specified options.direction with a step specified in options.unit. Possible values for unit are:
• 'character' (default) - moves selection by one user-perceived character. In most cases this means moving by one character in String sense. However, unicode also defines "combing marks". These are special symbols, that combines with a symbol before it ("base character") to create one user-perceived character. For example, q̣̇ is a normal letter q with two "combining marks": upper dot (Ux0307) and lower dot (Ux0323). For most actions, i.e. extending selection by one position, it is correct to include both "base character" and all of it's "combining marks". That is why 'character' value is most natural and common method of modifying selection.
• 'codePoint' - moves selection by one unicode code point. In contrary to, 'character' unit, this will insert selection between "base character" and "combining mark", because "combining marks" have their own unicode code points. However, for technical reasons, unicode code points with values above UxFFFF are represented in native String by two characters, called "surrogate pairs". Halves of "surrogate pairs" have a meaning only when placed next to each other. For example 𨭎 is represented in String by \uD862\uDF4E. Both \uD862 and \uDF4E do not have any meaning outside the pair (are rendered as ? when alone). Position between them would be incorrect. In this case, selection extension will include whole "surrogate pair".
• 'word' - moves selection by a whole word.

Note: if you extend a forward selection in a backward direction you will in fact shrink it.

Parameters

selection : ModelSelection | ModelDocumentSelection

The selection to modify.

[ options ] : object

Properties

[ options.direction ] : 'forward' | 'backward'

The direction in which the selection should be modified.

[ options.treatEmojiAsSingleUnit ] : boolean

Whether multi-characer emoji sequences should be handled as single unit.

[ options.unit ] : 'character' | 'codePoint' | 'word'

The unit by which selection should be modified.

Returns

void

Fires

• modifySelection

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

Parameters

event : string

The name of the event.

callback : Function

The function to stop being called.

Returns

void

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

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

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

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

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

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

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:

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

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

Parameters

values : object

An object with name=>value pairs.

Returns

void

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:

public declare myProp: number;

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

Type parameters

K

Parameters

name : K

The property's name.

value : Model[ K ]

The property's value.

Returns

void

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

• To stop delegating all events.
• To stop delegating a specific event to all emitters.
• To stop delegating a specific event to a specific emitter.

Parameters

[ event ] : string

The name of the event to stop delegating. If omitted, stops it all delegations.

[ emitter ] : Emitter

(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

Returns

void

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

• To stop listening to a specific callback.
• To stop listening to a specific event.
• To stop listening to all events fired by a specific object.
• To stop listening to all events fired by all objects.

Parameters

[ emitter ] : Emitter

The object to stop listening to. If omitted, stops it for all objects.

[ event ] : string

(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

[ callback ] : Function

(Requires the event) The function to be removed from the call list for the given event.

Returns

void

Removes the binding created with bind.

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

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

Parameters

unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'change' | 'document' | 'destroy' | 'schema' | 'applyOperation' | 'markers' | 'enqueueChange' | 'insertContent' | 'insertObject' | 'deleteContent' | 'modifySelection' | 'getSelectedContent' | 'hasContent' | 'canEditAt' | 'createPositionFromPath' | 'createPositionAt' | 'createPositionAfter' | 'createPositionBefore' | 'createRange' | 'createRangeIn' | 'createRangeOn' | 'createSelection' | 'createBatch' | 'createOperationFromJSON'>

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

Returns

void

Common part of change and enqueueChange which calls callbacks and returns array of values returned by these callbacks.

Returns

Array<any>

Fired when leaving the outermost enqueueChange or change block.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

Fired when entering the outermost enqueueChange or change block.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

Fired every time any operation is applied on the model using applyOperation.

Note that this event is suitable only for very specific use-cases. Use it if you need to listen to every single operation applied on the document. However, in most cases event-change should be used.

A few callbacks are already added to this event by engine internal classes:

• with highest priority operation is validated,
• with normal priority operation is executed,
• with low priority the ModelDocument updates its version,
• with low priority ModelLivePosition and ModelLiveRange update themselves.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

args : Parameters<TObservable[ TName ]>

Arguments of the applyOperation which is an array with a single element - applied operation.

Event fired when canEditAt method is called.

The default action of that method is implemented as a listener to this event, so it can be fully customized by the features.

Although the original method accepts any parameter of Selectable type, this event is fired with selectable normalized to an instance of ModelSelection or ModelDocumentSelection.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

args : tuple

The arguments passed to the original method.

Fired when a property changed value.

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'

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.

Event fired when deleteContent method is called.

The default action of that method is implemented as a listener to this event, so it can be fully customized by the features.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

args : Parameters<TObservable[ TName ]>

The arguments passed to the original method.

Event fired when getSelectedContent method is called.

The default action of that method is implemented as a listener to this event, so it can be fully customized by the features.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

args : Parameters<TObservable[ TName ]>

The arguments passed to the original method.

Event fired when insertContent method is called.

The default action of that method is implemented as a listener to this event so it can be fully customized by the features.

Note The selectable parameter for the insertContent is optional. When undefined value is passed the method uses document selection.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

args : tuple

The arguments passed to the original method.

Event fired when the insertObject method is called.

The default action of that method is implemented as a listener to this event so it can be fully customized by the features.

Note The selectable parameter for the insertObject is optional. When undefined value is passed the method uses document selection.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

args : tuple

The arguments passed to the original method.

Event fired when modifySelection method is called.

The default action of that method is implemented as a listener to this event, so it can be fully customized by the features.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

args : Parameters<TObservable[ TName ]>

The arguments passed to the original method.

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

You can control the final value of the property by using the event's return property.

observable.set( 'prop', 1 );

observable.on<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.

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.