MultiRootEditor (editor-multi-root)

@ckeditor/ckeditor5-editor-multi-root/src/multirooteditor

class

The multi-root editor implementation.

The multi-root editor provides multiple inline editable elements and a toolbar. All editable areas are controlled by one editor instance, which means that they share common configuration, document ID, or undo stack.

This type of editor is dedicated to integrations which require a customized UI with an open structure, featuring multiple editable areas, allowing developers to have a control over the exact location of these editable areas.

In order to create a multi-root editor instance, use the static MultiRootEditor.create() method.

Note that you will need to attach the editor toolbar to your web page manually, in a desired place, after the editor is initialized.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

readonly inherited
accessibility : Accessibility

See source
A namespace for the accessibility features of the editor.
readonly inherited
commands : CommandCollection
See source
Commands registered to the editor.

Use the shorthand editor.execute() method to execute commands:
```
// Execute the bold command:
editor.execute( 'bold' );

// Check the state of the bold command:
editor.commands.get( 'bold' ).value;
```
readonly inherited
config : Config<EditorConfig>
See source
Stores all configurations specific to this editor instance.
```
editor.config.get( 'image.toolbar' );
// -> [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ]
```
readonly inherited
conversion : Conversion

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

See the Conversion documentation to learn how to add converters.
readonly inherited
data : DataController

See source
The data controller. Used e.g. for setting and retrieving the editor data.
readonly inherited
editing : EditingController

See source
The editing controller. Controls user input and rendering the content for editing.
readonly inherited
id : string

See source
inherited
isReadOnly : boolean
See source
Defines whether the editor is in the read-only mode.

In read-only mode the editor commands are disabled so it is not possible to modify the document by using them. Also, the editable element(s) become non-editable.

In order to make the editor read-only, you need to call the enableReadOnlyMode method:
```
editor.enableReadOnlyMode( 'feature-id' );
```
- Later, to turn off the read-only mode, call disableReadOnlyMode:
```
editor.disableReadOnlyMode( 'feature-id' );
```
Parameters

value : boolean
readonly inherited
keystrokes : EditingKeystrokeHandler
See source
An instance of the EditingKeystrokeHandler.

It allows setting simple keystrokes:
```
// Execute the bold command on Ctrl+E:
editor.keystrokes.set( 'Ctrl+E', 'bold' );

// Execute your own callback:
editor.keystrokes.set( 'Ctrl+E', ( data, cancel ) => {
	console.log( data.keyCode );

	// Prevent the default (native) action and stop the underlying keydown event
	// so no other editor feature will interfere.
	cancel();
} );
```
Note: Certain typing-oriented keystrokes (like Backspace or Enter) are handled by a low-level mechanism and trying to listen to them via the keystroke handler will not work reliably. To handle these specific keystrokes, see the events fired by the editing view document (editor.editing.view.document).
readonly inherited
locale : Locale

See source
The locale instance.
readonly inherited
model : Model

See source
The editor's model.

The central point of the editor's abstract data model.
readonly inherited
plugins : PluginCollection<Editor>
See source
The plugins loaded and in use by this editor instance.
```
editor.plugins.get( 'ClipboardPipeline' ); // -> An instance of the clipboard pipeline plugin.
```
readonly
sourceElements : Record<string, HTMLElement>

See source
The elements on which the editor has been initialized.
inherited observable
state : 'ready' | 'initializing' | 'destroyed'
See source
Indicates the editor life-cycle state.

The editor is in one of the following states:
- initializing – During the editor initialization (before Editor.create()) finished its job.
- ready – After the promise returned by the Editor.create() method is resolved.
- destroyed – Once the editor.destroy() method was called.
readonly inherited
t : LocaleTranslate
See source
Shorthand for t.

Related:
- Locale#t
readonly
ui : MultiRootEditorUI

See source
protected readonly inherited
_context : Context

See source
The editor context. When it is not provided through the configuration, the editor creates it.
protected readonly inherited
_readOnlyLocks : Set<string | symbol>

See source
A set of lock IDs for the isReadOnly getter.
private readonly
_readOnlyRootLocks : Map<string, Set<string | symbol>>

See source
A set of lock IDs for enabling or disabling particular root.
private readonly
_registeredRootsAttributesKeys : Set<string>

See source
Holds attributes keys that were passed in rootsAttributes config property and should be returned by getRootsAttributes.

Static properties

inherited static
Context : default

See source
The Context class.

Exposed as static editor field for easier access in editor builds.
inherited static
ContextWatchdog : default

See source
The ContextWatchdog class.

Exposed as static editor field for easier access in editor builds.
inherited static
EditorWatchdog : default

See source
The EditorWatchdog class.

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

inherited static
`builtinPlugins : Array<PluginConstructor<Editor>> | undefined`

See source

An array of plugins built into this editor class.

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

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

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

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

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

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

inherited static
`defaultConfig : EditorConfig | undefined`

See source

The default configuration which is built into the editor class.

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

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

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

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

Methods

protected
constructor( sourceElementsOrData, config )

See source
Creates an instance of the multi-root editor.

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

Parameters

sourceElementsOrData : Record<string, string> | Record<string, HTMLElement>

The DOM elements that will be the source for the created editor or the editor's initial data. The editor will initialize multiple roots with names according to the keys in the passed object. For more information see MultiRootEditor.create().

config : EditorConfig

The editor configuration.

Defaults to {}
addRoot( rootName, options ) → void
See source
Adds a new root to the editor.
```
editor.addRoot( 'myRoot', { data: 'Initial root data.' } );
```
After a root is added, you will be able to modify and retrieve its data.

All root names must be unique. An error will be thrown if you will try to create a root with the name same as an already existing, attached root. However, you can call this method for a detached root. See also detachRoot.

Whenever a root is added, the editor instance will fire addRoot event. The event is also called when the root is added indirectly, e.g. by the undo feature or on a remote client during real-time collaboration.

Note, that this method only adds a root to the editor model. It does not create a DOM editable element for the new root. Until such element is created (and attached to the root), the root is "virtual": it is not displayed anywhere and its data can be changed only using the editor API.

To create a DOM editable element for the root, listen to addRoot event and call createEditable. Then, insert the DOM element in a desired place, that will depend on the integration with your application and your requirements.
```
editor.on( 'addRoot', ( evt, root ) => {
	const editableElement = editor.createEditable( root );

	// You may want to create a more complex DOM structure here.
	//
	// Alternatively, you may want to create a DOM structure before
	// calling `editor.addRoot()` and only append `editableElement` at
	// a proper place.

	document.querySelector( '#editors' ).appendChild( editableElement );
} );

// ...

editor.addRoot( 'myRoot' ); // Will create a root, a DOM editable element and append it to `#editors` container element.
```
You can set root attributes on the new root while you add it:
```
// Add a collapsed root at fourth position from top.
// Keep in mind that these are just examples of attributes. You need to provide your own features that will handle the attributes.
editor.addRoot( 'myRoot', { attributes: { isCollapsed: true, index: 4 } } );
```
Note that attributes added together with a root are automatically registered.

See also MultiRootEditor#registerRootAttribute() and config.rootsAttributes configuration option.

By setting isUndoable flag to true, you can allow for detaching the root using the undo feature.

Additionally, you can group adding multiple roots in one undo step. This can be useful if you add multiple roots that are combined into one, bigger UI element, and want them all to be undone together.
```
let rowId = 0;

editor.model.change( () => {
	editor.addRoot( 'left-row-' + rowId, { isUndoable: true } );
	editor.addRoot( 'center-row-' + rowId, { isUndoable: true } );
	editor.addRoot( 'right-row-' + rowId, { isUndoable: true } );

	rowId++;
} );
```
Parameters

rootName : string

Name of the root to add.

options : AddRootOptions

Additional options for the added root.

Defaults to {}

Returns

void
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, MultiRootEditor[ K1 ], K2, MultiRootEditor[ K2 ]>
See source
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

DualBindChain<K1, MultiRootEditor[ K1 ], K2, MultiRootEditor[ K2 ]>

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperties ) → MultiBindChain
See source
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' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'execute' | 'plugins' | 'ui' | 'isReadOnly' | 'addRoot' | 'detachRoot' | 'editing' | 'model' | 'keystrokes' | 'createEditable' | 'sourceElements' | 'detachEditable' | 'loadRoot' | 'getFullData' | 'getRootsAttributes' | 'getRootAttributes' | 'registerRootAttribute' | 'disableRoot' | 'enableRoot' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins'>

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

Returns

MultiBindChain

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperty ) → SingleBindChain<K, MultiRootEditor[ K ]>
See source
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

SingleBindChain<K, MultiRootEditor[ K ]>

The bind chain with the to() and toMany() methods.
createEditable( root, [ placeholder ], [ label ] ) → HTMLElement

See source
Creates and returns a new DOM editable element for the given root element.

The new DOM editable is attached to the model root and can be used to modify the root content.

Parameters

root : RootElement

Root for which the editable element should be created.

[ placeholder ] : string

Placeholder for the editable element. If not set, placeholder value from the editor configuration will be used (if it was provided).

[ label ] : string

The accessible label text describing the editable to the assistive technologies.

Returns

HTMLElement

The created DOM element. Append it in a desired place in your application.
inherited
decorate( methodName ) → void
See source
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' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'execute' | 'plugins' | 'ui' | 'isReadOnly' | 'addRoot' | 'detachRoot' | 'editing' | 'model' | 'keystrokes' | 'createEditable' | 'sourceElements' | 'detachEditable' | 'loadRoot' | 'getFullData' | 'getRootsAttributes' | 'getRootAttributes' | 'registerRootAttribute' | 'disableRoot' | 'enableRoot' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins'

Name of the method to decorate.

Returns

void
inherited
delegate( events ) → EmitterMixinDelegateChain
See source
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
destroy() → Promise<unknown>
See source
Destroys the editor instance, releasing all resources used by it.

Updates the original editor element with the data if the updateSourceElementOnDestroy configuration option is set to true.

Note: The multi-root editor does not remove the toolbar and editable when destroyed. You can do that yourself in the destruction chain, if you need to:
```
editor.destroy().then( () => {
	// Remove the toolbar from DOM.
	editor.ui.view.toolbar.element.remove();

	// Remove editable elements from DOM.
	for ( const editable of Object.values( editor.ui.view.editables ) ) {
	 editable.element.remove();
	}

	console.log( 'Editor was destroyed' );
} );
```
Returns

Promise<unknown>
detachEditable( root ) → HTMLElement

See source
Detaches the DOM editable element that was attached to the given root.

Parameters

root : RootElement

Root for which the editable element should be detached.

Returns

HTMLElement

The DOM element that was detached. You may want to remove it from your application DOM structure.
detachRoot( rootName, isUndoable ) → void
See source
Detaches a root from the editor.
```
editor.detachRoot( 'myRoot' );
```
A detached root is not entirely removed from the editor model, however it can be considered removed.

After a root is detached all its children are removed, all markers inside it are removed, and whenever something is inserted to it, it is automatically removed as well. Finally, a detached root is not returned by getRootNames by default.

It is possible to re-add a previously detached root calling addRoot.

Whenever a root is detached, the editor instance will fire detachRoot event. The event is also called when the root is detached indirectly, e.g. by the undo feature or on a remote client during real-time collaboration.

Note, that this method only detached a root in the editor model. It does not destroy the DOM editable element linked with the root and it does not remove the DOM element from the DOM structure of your application.

To properly remove a DOM editable element after a root was detached, listen to detachRoot event and call detachEditable. Then, remove the DOM element from your application.
```
editor.on( 'detachRoot', ( evt, root ) => {
	const editableElement = editor.detachEditable( root );

	// You may want to do an additional DOM clean-up here.

	editableElement.remove();
} );

// ...

editor.detachRoot( 'myRoot' ); // Will detach the root, and remove the DOM editable element.
```
By setting isUndoable flag to true, you can allow for re-adding the root using the undo feature.

Additionally, you can group detaching multiple roots in one undo step. This can be useful if the roots are combined into one, bigger UI element, and you want them all to be re-added together.
```
editor.model.change( () => {
	editor.detachRoot( 'left-row-3', true );
	editor.detachRoot( 'center-row-3', true );
	editor.detachRoot( 'right-row-3', true );
} );
```
Parameters

rootName : string

Name of the root to detach.

isUndoable : boolean

Whether detaching the root can be undone (using the undo feature) or not.

Defaults to false

Returns

void
inherited
disableReadOnlyMode( lockId ) → void

See source
Removes the read-only lock from the editor with given lock ID.

When no lock is present on the editor anymore, then the isReadOnly property will be set to false.

Parameters

lockId : string | symbol

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

Returns

void
disableRoot( rootName, lockId ) → void
See source
Switches given editor root to the read-only mode.

In contrary to enableReadOnlyMode(), which switches the whole editor to the read-only mode, this method turns only a particular root to the read-only mode. This can be useful when you want to prevent editing only a part of the editor content.

When you switch a root to the read-only mode, you need provide a unique identifier (lockId) that will identify this request. You will need to provide the same lockId when you will want to re-enable the root.
```
const model = editor.model;
const myRoot = model.document.getRoot( 'myRoot' );

editor.disableRoot( 'myRoot', 'my-lock' );
model.canEditAt( myRoot ); // `false`

editor.disableRoot( 'myRoot', 'other-lock' );
editor.disableRoot( 'myRoot', 'other-lock' ); // Multiple locks with the same ID have no effect.
model.canEditAt( myRoot ); // `false`

editor.enableRoot( 'myRoot', 'my-lock' );
model.canEditAt( myRoot ); // `false`

editor.enableRoot( 'myRoot', 'other-lock' );
model.canEditAt( myRoot ); // `true`
```
See also Editor#enableReadOnlyMode() and MultiRootEditor#enableRoot().

Parameters

rootName : string

Name of the root to switch to read-only mode.

lockId : string | symbol

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

Returns

void
inherited
enableReadOnlyMode( lockId ) → void
See source
Turns on the read-only mode in the editor.

Editor can be switched to or out of the read-only mode by many features, under various circumstances. The editor supports locking mechanism for the read-only mode. It enables easy control over the read-only mode when many features wants to turn it on or off at the same time, without conflicting with each other. It guarantees that you will not make the editor editable accidentally (which could lead to errors).

Each read-only mode request is identified by a unique id (also called "lock"). If multiple plugins requested to turn on the read-only mode, then, the editor will become editable only after all these plugins turn the read-only mode off (using the same ids).

Note, that you cannot force the editor to disable the read-only mode if other plugins set it.

After the first enableReadOnlyMode() call, the isReadOnly property will be set to true:
```
editor.isReadOnly; // `false`.
editor.enableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `true`.
```
You can turn off the read-only mode ("clear the lock") using the disableReadOnlyMode() method:
```
editor.enableReadOnlyMode( 'my-feature-id' );
// ...
editor.disableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `false`.
```
All "locks" need to be removed to enable editing:
```
editor.enableReadOnlyMode( 'my-feature-id' );
editor.enableReadOnlyMode( 'my-other-feature-id' );
// ...
editor.disableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `true`.
editor.disableReadOnlyMode( 'my-other-feature-id' );
editor.isReadOnly; // `false`.
```
Parameters

lockId : string | symbol

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

Returns

void
enableRoot( rootName, lockId ) → void

See source
Removes given read-only lock from the given root.

See disableRoot().

Parameters

rootName : string

Name of the root to switch back from the read-only mode.

lockId : string | symbol

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

Returns

void
inherited
execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>
See source
Executes the specified command with given parameters.

Shorthand for:
```
editor.commands.get( commandName ).execute( ... );
```
Type parameters

TName : extends string

Parameters

commandName : TName

The name of the command to execute.

commandParams : Parameters<CommandsMap[ TName ][ 'execute' ]>

Command parameters.

Returns

ReturnType<CommandsMap[ TName ][ 'execute' ]>

The value returned by the commands.execute().
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

See source
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).
inherited
focus() → void

See source
Focuses the editor.

Note To explicitly focus the editing area of the editor, use the editor.editing.view.focus() method of the editing view.

Check out the Focus in the editor UI section of the Deep dive into focus tracking guide to learn more.

Returns

void
inherited
getData( [ options ] = { [options.rootName], [options.trim], options[key: string] } ) → string
See source
Gets the data from the editor.
```
editor.getData(); // -> 'This is editor!'
```
If your editor implementation uses multiple roots, you should pass root name as one of the options:
```
editor.getData( { rootName: 'header' } ); // -> 'Content for header part.'
```
By default, the editor outputs HTML. This can be controlled by injecting a different data processor. See the Markdown output guide for more details.

A warning is logged when you try to retrieve data for a detached root, as most probably this is a mistake. A detached root should be treated like it is removed, and you should not save its data. Note, that the detached root data is always an empty string.

Parameters

[ options ] : object

Additional configuration for the retrieved data. Editor features may introduce more configuration options that can be set through this parameter.

Properties

[ options.rootName ] : string

Root name. Defaults to 'main'.

[ options.trim ] : 'none' | 'empty'

Whether returned data should be trimmed. This option is set to 'empty' by default, which means that whenever editor content is considered empty, an empty string is returned. To turn off trimming use 'none'. In such cases exact content will be returned (for example ' ' for an empty editor).

options[key: string] : unknown

Returns

string

Output data.
getFullData( [ options ] ) → Record<string, string>

See source
Returns the document data for all attached roots.

Parameters

[ options ] : Record<string, unknown>

Additional configuration for the retrieved data. Editor features may introduce more configuration options that can be set through this parameter.

Returns

Record<string, string>

The full document data.
getRootAttributes( rootName ) → RootAttributes

See source
Returns attributes for the specified root.

Note: all and only registered roots attributes will be returned. If a registered root attribute is not set for a given root, null will be returned.

Parameters

rootName : string

Returns

RootAttributes
getRootsAttributes() → Record<string, RootAttributes>

See source
Returns attributes for all attached roots.

Note: all and only registered roots attributes will be returned. If a registered root attribute is not set for a given root, null will be returned.

Returns

Record<string, RootAttributes>

Object with roots attributes. Keys are roots names, while values are attributes set on given root.
inherited
initPlugins() → Promise<LoadedPlugins>

See source
Loads and initializes plugins specified in the configuration.

Returns

Promise<LoadedPlugins>

A promise which resolves once the initialization is completed, providing an array of loaded plugins.
inherited
listenTo( emitter, event, callback, [ options ] ) → void
See source
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
loadRoot( rootName, options ) → void
See source
Loads a root that has previously been declared in lazyRoots configuration option.

Only roots specified in the editor config can be loaded. A root cannot be loaded multiple times. A root cannot be unloaded and loading a root cannot be reverted using the undo feature.

When a root becomes loaded, it will be treated by the editor as though it was just added. This, among others, means that all related events and mechanisms will be fired, including addRoot event, model.Document change event, model post-fixers and conversion.

Until the root becomes loaded, all above mechanisms are suppressed.

This method is decorated.

Note that attributes loaded together with a root are automatically registered.

See also MultiRootEditor#registerRootAttribute() and config.rootsAttributes configuration option.

When this method is used in real-time collaboration environment, its effects become asynchronous as the editor will first synchronize with the remote editing session, before the root is added to the editor.

If the root has been already loaded by any other client, the additional data passed in loadRoot() parameters will be ignored.

Parameters

rootName : string

Name of the root to load.

options : LoadRootOptions

Additional options for the loaded root.

Defaults to {}

Returns

void

Fires
- loadRoot
inherited
off( event, callback ) → void

See source
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
inherited
on( event, callback, [ options ] ) → void

See source
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
inherited
once( event, callback, [ options ] ) → void

See source
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
registerRootAttribute( key ) → void

See source
Registers given string as a root attribute key. Registered root attributes are added to schema, and also returned by getRootAttributes() and getRootsAttributes().

Note: attributes passed in config.rootsAttributes are automatically registered as the editor is initialized. However, registering the same attribute twice does not have any negative impact, so it is recommended to use this method in any feature that uses roots attributes.

Parameters

key : string

Returns

void
inherited
set( values ) → void
See source
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
inherited
set( name, value ) → void
See source
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 : MultiRootEditor[ K ]

The property's value.

Returns

void
inherited
setData( data ) → void
See source
Sets the data in the editor.
```
editor.setData( 'This is editor!' );
```
If your editor implementation uses multiple roots, you should pass an object with keys corresponding to the editor root names and values equal to the data that should be set in each root:
```
editor.setData( {
 header: 'Content for header part.',
 content: 'Content for main part.',
 footer: 'Content for footer part.'
} );
```
By default the editor accepts HTML. This can be controlled by injecting a different data processor. See the Markdown output guide for more details.

Parameters

data : string | Record<string, string>

Input data.

Returns

void
inherited
stopDelegating( [ event ], [ emitter ] ) → void
See source
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
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
See source
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
inherited
unbind( unbindProperties ) → void
See source
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' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'execute' | 'plugins' | 'ui' | 'isReadOnly' | 'addRoot' | 'detachRoot' | 'editing' | 'model' | 'keystrokes' | 'createEditable' | 'sourceElements' | 'detachEditable' | 'loadRoot' | 'getFullData' | 'getRootsAttributes' | 'getRootAttributes' | 'registerRootAttribute' | 'disableRoot' | 'enableRoot' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins'>

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

Returns

void
internal
_verifyRootsWithInitialData() → void

See source

Returns

void

Static methods

static
create( sourceElementsOrData, config ) → Promise<MultiRootEditor>
See source
Creates a new multi-root editor instance.

Note: remember that MultiRootEditor does not append the toolbar element to your web page, so you have to do it manually after the editor has been initialized.

There are a few different ways to initialize the multi-root editor.

Using existing DOM elements:
```
MultiRootEditor.create( {
	intro: document.querySelector( '#editor-intro' ),
	content: document.querySelector( '#editor-content' ),
	sidePanelLeft: document.querySelector( '#editor-side-left' ),
	sidePanelRight: document.querySelector( '#editor-side-right' ),
	outro: document.querySelector( '#editor-outro' )
} )
.then( editor => {
	console.log( 'Editor was initialized', editor );

	// Append the toolbar inside a provided DOM element.
	document.querySelector( '#toolbar-container' ).appendChild( editor.ui.view.toolbar.element );
} )
.catch( err => {
	console.error( err.stack );
} );
```
The elements' content will be used as the editor data and elements will become editable elements.

Creating a detached editor

Alternatively, you can initialize the editor by passing the initial data directly as strings. In this case, you will have to manually append both the toolbar element and the editable elements to your web page.
```
MultiRootEditor.create( {
	intro: 'Exciting intro text to an article.',
	content: 'Lorem ipsum dolor sit amet.',
	sidePanelLeft: '<blockquote>Strong quotation from article.</blockquote>',
	sidePanelRight: 'List of similar articles...',
	outro: 'Closing text.'
} )
.then( editor => {
	console.log( 'Editor was initialized', editor );

	// Append the toolbar inside a provided DOM element.
	document.querySelector( '#toolbar-container' ).appendChild( editor.ui.view.toolbar.element );

	// Append DOM editable elements created by the editor.
	const editables = editor.ui.view.editables;
	const container = document.querySelector( '#editable-container' );

	container.appendChild( editables.intro.element );
	container.appendChild( editables.content.element );
	container.appendChild( editables.outro.element );
} )
.catch( err => {
	console.error( err.stack );
} );
```
This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.

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

You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
```
MultiRootEditor.create( {
	intro: document.querySelector( '#editor-intro' ),
	content: document.querySelector( '#editor-content' ),
	sidePanelLeft: document.querySelector( '#editor-side-left' ),
	sidePanelRight: document.querySelector( '#editor-side-right' ),
	outro: document.querySelector( '#editor-outro' )
}, {
	initialData: {
		intro: 'Exciting intro text to an article.',
		content: 'Lorem ipsum dolor sit amet.',
		sidePanelLeft '<blockquote>Strong quotation from article.</blockquote>':
		sidePanelRight 'List of similar articles...':
		outro: 'Closing text.'
	}
} )
.then( editor => {
	console.log( 'Editor was initialized', editor );

	// Append the toolbar inside a provided DOM element.
	document.querySelector( '#toolbar-container' ).appendChild( editor.ui.view.toolbar.element );
} )
.catch( err => {
	console.error( err.stack );
} );
```
This method can be used to initialize the editor on an existing element with the specified content in case if your integration makes it difficult to set the content of the source element.

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

Configuring the editor

See the editor configuration documentation to learn more about customizing plugins, toolbar and more.

Parameters

sourceElementsOrData : Record<string, string> | Record<string, HTMLElement>

The DOM elements that will be the source for the created editor or the editor's initial data. The editor will initialize multiple roots with names according to the keys in the passed object.

If DOM elements are passed, their content will be automatically loaded to the editor upon initialization and the elements will be used as the editor's editable areas. The editor data will be set back to the original element once the editor is destroyed if the updateSourceElementOnDestroy option is set to true.

If the initial data is passed, a detached editor will be created. For each entry in the passed object, one editor root and one editable DOM element will be created. You will need to attach the editable elements into the DOM manually. The elements are available through the editor.ui.getEditableElement() method.

config : EditorConfig

The editor configuration.

Defaults to {}

Returns

Promise<MultiRootEditor>

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

Events

addRoot( eventInfo, root )

See source
Fired whenever a root is added or re-added to the editor model.

Use this event to create a DOM editable for the added root and append the DOM element in a desired place in your application.

The event is fired after all changes from a given batch are applied. The event is not fired, if the root was added and detached in the same batch.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

root : RootElement

The root that was added.
inherited
change:isReadOnly( eventInfo, name, value, oldValue )

See source
Fired when the isReadOnly property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isReadOnly).

value : boolean

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

oldValue : boolean

Old value of the isReadOnly property with given key or null, if property was not set before.
inherited
change:state( eventInfo, name, value, oldValue )

See source
Fired when the state property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (state).

value : 'ready' | 'initializing' | 'destroyed'

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

oldValue : 'ready' | 'initializing' | 'destroyed'

Old value of the state property with given key or null, if property was not set before.
inherited
change:{property}( eventInfo, name, value, oldValue )
See source
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.
inherited
destroy( eventInfo )

See source
Fired when this editor instance is destroyed. The editor at this point is not usable and this event should be used to perform the clean-up in any plugin.

See also the editor.state property.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
detachRoot( eventInfo, root )

See source
Fired whenever a root is detached from the editor model.

Use this event to destroy a DOM editable for the detached root and remove the DOM element from your application.

The event is fired after all changes from a given batch are applied. The event is not fired, if the root was detached and re-added in the same batch.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

root : RootElement

The root that was detached.
loadRoot( eventInfo, args )

See source
Event fired when loadRoot 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.
inherited
ready( eventInfo )

See source
Fired when the data and all additional editor components are ready.

Note: This event is most useful for plugin developers. When integrating the editor with your website or application, you do not have to listen to editor#ready because when the promise returned by the static Editor.create() event is resolved, the editor is already ready. In fact, since the first moment when the editor instance is available to you is inside then()'s callback, you cannot even add a listener to the editor#ready event.

See also the editor.state property.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
inherited
set:isReadOnly( eventInfo, name, value, oldValue )

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

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.
inherited
set:state( eventInfo, name, value, oldValue )

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

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (state).

value : 'ready' | 'initializing' | 'destroyed'

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

oldValue : 'ready' | 'initializing' | 'destroyed'

Old value of the state property with given key or null, if property was not set before.
inherited
set:{property}( eventInfo, name, value, oldValue )
See source
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.

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.

MultiRootEditor (editor-multi-root)

Filtering

Properties

readonly inherited accessibility : Accessibilitymodule:editor-multi-root/multirooteditor~MultiRootEditor#accessibility

readonly inherited commands : CommandCollectionmodule:editor-multi-root/multirooteditor~MultiRootEditor#commands

readonly inherited config : Config<EditorConfig>module:editor-multi-root/multirooteditor~MultiRootEditor#config

readonly inherited conversion : Conversionmodule:editor-multi-root/multirooteditor~MultiRootEditor#conversion

readonly inherited data : DataControllermodule:editor-multi-root/multirooteditor~MultiRootEditor#data

readonly inherited editing : EditingControllermodule:editor-multi-root/multirooteditor~MultiRootEditor#editing

readonly inherited id : stringmodule:editor-multi-root/multirooteditor~MultiRootEditor#id

inherited isReadOnly : booleanmodule:editor-multi-root/multirooteditor~MultiRootEditor#isReadOnly

Parameters

readonly inherited keystrokes : EditingKeystrokeHandlermodule:editor-multi-root/multirooteditor~MultiRootEditor#keystrokes

readonly inherited locale : Localemodule:editor-multi-root/multirooteditor~MultiRootEditor#locale

readonly inherited model : Modelmodule:editor-multi-root/multirooteditor~MultiRootEditor#model

readonly inherited plugins : PluginCollection<Editor>module:editor-multi-root/multirooteditor~MultiRootEditor#plugins

readonly sourceElements : Record<string, HTMLElement>module:editor-multi-root/multirooteditor~MultiRootEditor#sourceElements

inherited observable state : 'ready' | 'initializing' | 'destroyed'module:editor-multi-root/multirooteditor~MultiRootEditor#state

readonly inherited t : LocaleTranslatemodule:editor-multi-root/multirooteditor~MultiRootEditor#t

Related:

readonly ui : MultiRootEditorUImodule:editor-multi-root/multirooteditor~MultiRootEditor#ui

protected readonly inherited _context : Contextmodule:editor-multi-root/multirooteditor~MultiRootEditor#_context

protected readonly inherited _readOnlyLocks : Set<string | symbol>module:editor-multi-root/multirooteditor~MultiRootEditor#_readOnlyLocks

private readonly _readOnlyRootLocks : Map<string, Set<string | symbol>>module:editor-multi-root/multirooteditor~MultiRootEditor#_readOnlyRootLocks

private readonly _registeredRootsAttributesKeys : Set<string>module:editor-multi-root/multirooteditor~MultiRootEditor#_registeredRootsAttributesKeys

Static properties

inherited static Context : defaultmodule:editor-multi-root/multirooteditor~MultiRootEditor.Context

inherited static ContextWatchdog : defaultmodule:editor-multi-root/multirooteditor~MultiRootEditor.ContextWatchdog

inherited static EditorWatchdog : defaultmodule:editor-multi-root/multirooteditor~MultiRootEditor.EditorWatchdog

inherited static builtinPlugins : Array<PluginConstructor<Editor>> | undefinedmodule:editor-multi-root/multirooteditor~MultiRootEditor.builtinPlugins

inherited static defaultConfig : EditorConfig | undefinedmodule:editor-multi-root/multirooteditor~MultiRootEditor.defaultConfig

Methods

protected constructor( sourceElementsOrData, config )module:editor-multi-root/multirooteditor~MultiRootEditor#constructor

Parameters

addRoot( rootName, options ) → voidmodule:editor-multi-root/multirooteditor~MultiRootEditor#addRoot

Parameters

Returns

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, MultiRootEditor[ K1 ], K2, MultiRootEditor[ K2 ]>module:editor-multi-root/multirooteditor~MultiRootEditor#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperties ) → MultiBindChainmodule:editor-multi-root/multirooteditor~MultiRootEditor#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, MultiRootEditor[ K ]>module:editor-multi-root/multirooteditor~MultiRootEditor#bind:SINGLE_BIND

Type parameters

Parameters

Returns

createEditable( root, [ placeholder ], [ label ] ) → HTMLElementmodule:editor-multi-root/multirooteditor~MultiRootEditor#createEditable

Parameters

Returns

inherited decorate( methodName ) → voidmodule:editor-multi-root/multirooteditor~MultiRootEditor#decorate

Parameters

Returns

inherited delegate( events ) → EmitterMixinDelegateChainmodule:editor-multi-root/multirooteditor~MultiRootEditor#delegate

Parameters

Returns

destroy() → Promise<unknown>module:editor-multi-root/multirooteditor~MultiRootEditor#destroy

Returns

detachEditable( root ) → HTMLElementmodule:editor-multi-root/multirooteditor~MultiRootEditor#detachEditable

Parameters

Returns

detachRoot( rootName, isUndoable ) → voidmodule:editor-multi-root/multirooteditor~MultiRootEditor#detachRoot

Parameters

Returns

inherited disableReadOnlyMode( lockId ) → voidmodule:editor-multi-root/multirooteditor~MultiRootEditor#disableReadOnlyMode

Parameters

Returns

disableRoot( rootName, lockId ) → voidmodule:editor-multi-root/multirooteditor~MultiRootEditor#disableRoot

Parameters

Returns

inherited enableReadOnlyMode( lockId ) → voidmodule:editor-multi-root/multirooteditor~MultiRootEditor#enableReadOnlyMode

Parameters

Returns

enableRoot( rootName, lockId ) → voidmodule:editor-multi-root/multirooteditor~MultiRootEditor#enableRoot

Parameters

Returns

inherited execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>module:editor-multi-root/multirooteditor~MultiRootEditor#execute

Type parameters

Parameters

readonly inherited
`accessibility : Accessibility`

readonly inherited
`commands : CommandCollection`

readonly inherited
`config : Config<EditorConfig>`

readonly inherited
`conversion : Conversion`

readonly inherited
`data : DataController`

readonly inherited
`editing : EditingController`

readonly inherited
`id : string`

inherited
`isReadOnly : boolean`

readonly inherited
`keystrokes : EditingKeystrokeHandler`

readonly inherited
`locale : Locale`

readonly inherited
`model : Model`

readonly inherited
`plugins : PluginCollection<Editor>`

readonly
`sourceElements : Record<string, HTMLElement>`

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

readonly inherited
`t : LocaleTranslate`

readonly
`ui : MultiRootEditorUI`

protected readonly inherited
`_context : Context`

protected readonly inherited
`_readOnlyLocks : Set<string | symbol>`

private readonly
`_readOnlyRootLocks : Map<string, Set<string | symbol>>`

private readonly
`_registeredRootsAttributesKeys : Set<string>`

inherited static
`Context : default`

inherited static
`ContextWatchdog : default`

inherited static
`EditorWatchdog : default`

inherited static
`builtinPlugins : Array<PluginConstructor<Editor>> | undefined`

inherited static
`defaultConfig : EditorConfig | undefined`

protected
`constructor( sourceElementsOrData, config )`

`addRoot( rootName, options ) → void`

inherited
`bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, MultiRootEditor[ K1 ], K2, MultiRootEditor[ K2 ]>`

inherited
`bind( bindProperties ) → MultiBindChain`

inherited
`bind( bindProperty ) → SingleBindChain<K, MultiRootEditor[ K ]>`

`createEditable( root, [ placeholder ], [ label ] ) → HTMLElement`

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → Promise<unknown>`

`detachEditable( root ) → HTMLElement`

`detachRoot( rootName, isUndoable ) → void`

inherited
`disableReadOnlyMode( lockId ) → void`

`disableRoot( rootName, lockId ) → void`

inherited
`enableReadOnlyMode( lockId ) → void`

`enableRoot( rootName, lockId ) → void`

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

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

inherited
`focus() → void`

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

`getFullData( [ options ] ) → Record<string, string>`

`getRootAttributes( rootName ) → RootAttributes`

`getRootsAttributes() → Record<string, RootAttributes>`

inherited
`initPlugins() → Promise<LoadedPlugins>`

inherited
`listenTo( emitter, event, callback, [ options ] ) → void`

`loadRoot( rootName, options ) → void`

inherited
`off( event, callback ) → void`

inherited
`on( event, callback, [ options ] ) → void`

inherited
`once( event, callback, [ options ] ) → void`

`registerRootAttribute( key ) → void`

inherited
`set( values ) → void`

inherited
`set( name, value ) → void`

inherited
`setData( data ) → void`

inherited
`stopDelegating( [ event ], [ emitter ] ) → void`

inherited
`stopListening( [ emitter ], [ event ], [ callback ] ) → void`

inherited
`unbind( unbindProperties ) → void`

internal
`_verifyRootsWithInitialData() → void`

static
`create( sourceElementsOrData, config ) → Promise<MultiRootEditor>`

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