Creates an instance of the decoupled editor UI view.
The module:core/editor/editor~Editor#locale instance.
The editing view instance this view is related to.
Optionaloptions: {Configuration options for the view instance.
OptionaleditableElement?: HTMLElementThe editable element. If not specified, it will be automatically created by module:ui/editableui/editableuiview~EditableUIView. Otherwise, the given element will be used.
Optionallabel?: string | Record<string, string>When set, this value will be used as an accessible aria-label of the
module:ui/editableui/editableuiview~EditableUIView editable view.
OptionalshouldToolbarGroupWhenFull?: booleanWhen set true enables automatic items grouping
in the main module:editor-decoupled/decouplededitoruiview~DecoupledEditorUIView#toolbar toolbar.
See module:ui/toolbar/toolbarview~ToolbarOptions#shouldGroupWhenFull to learn more.
Protected_A collection of view instances, which have been added directly into the module:ui/template~Template#children.
Protected_Collections registered with #createCollection.
ReadonlybodyCollection of the child views, detached from the DOM structure of the editor, like panels, icons etc.
ReadonlyeditableThe editable of the decoupled editor UI.
An HTML element of the view. null until #render rendered
from the #template.
class SampleView extends View {
constructor() {
super();
// A template instance the #element will be created from.
this.setTemplate( {
tag: 'p'
// ...
} );
}
}
const view = new SampleView();
// Renders the #template.
view.render();
// Append the HTML element of the view to <body>.
document.body.appendChild( view.element );
Note: The element of the view can also be assigned directly:
view.element = document.querySelector( '#my-container' );
ReadonlyisSet true when the view has already been module:ui/view~View#render rendered.
ReadonlylocaleA set of tools to localize the user interface.
Also see module:core/editor/editor~Editor#locale.
Menu bar view instance.
Shorthand for module:utils/locale~Locale#t.
Note: If #locale instance hasn't been passed to the view this method may not be available.
OptionaltemplateTemplate of this view. It provides the #element representing the view in DOM, which is #render rendered.
ReadonlytoolbarThe main toolbar of the decoupled editor UI.
OptionalviewShorthand for module:ui/template~Template.bind, a binding module:ui/template~BindChain interface pre–configured for the view instance.
It provides module:ui/template~BindChain#to to() and
module:ui/template~BindChain#if if() methods that initialize bindings with
observable attributes and attach DOM listeners.
class SampleView extends View {
constructor( locale ) {
super( locale );
const bind = this.bindTemplate;
// These {@link module:utils/observablemixin~Observable observable} attributes will control
// the state of the view in DOM.
this.set( {
elementClass: 'foo',
isEnabled: true
} );
this.setTemplate( {
tag: 'p',
attributes: {
// The class HTML attribute will follow elementClass
// and isEnabled view attributes.
class: [
bind.to( 'elementClass' )
bind.if( 'isEnabled', 'present-when-enabled' )
]
},
on: {
// The view will fire the "clicked" event upon clicking <p> in DOM.
click: bind.to( 'clicked' )
}
} );
}
}
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings 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,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#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 );
Observable property that will be bound to other observable(s).
The bind chain with the to() and toMany() methods.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings 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,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#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 );
The bind chain with the to() and toMany() methods.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings 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,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#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 );
Observable properties that will be bound to other observable(s).
The bind chain with the to() and toMany() methods.
Creates a new collection of views, which can be used as module:ui/template~Template#children of this view.
class SampleView extends View {
constructor( locale ) {
super( locale );
const child = new ChildView( locale );
this.items = this.createCollection( [ child ] );
this.setTemplate( {
tag: 'p',
// `items` collection will render here.
children: this.items
} );
}
}
const view = new SampleView( locale );
view.render();
// It will append <p><child#element></p> to the <body>.
document.body.appendChild( view.element );
A new collection of view instances.
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 {@glink framework/deep-dive/observables#decorating-object-methods 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 module:utils/eventinfo~EventInfo#stop 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 module:utils/priorities~PriorityString 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'
Name of the method to decorate.
Delegates selected events to another module:utils/emittermixin~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 );
Event names that will be delegated to another emitter.
The opposite of #registerChild. Removes a child view from this view instance. Once removed, the child is no longer managed by its parent, e.g. it can safely become a child of another parent view.
Child views to be removed.
Recursively destroys the view instance and child views added by #registerChild and residing in collections created by the #createCollection.
Destruction disables all event listeners:
view.on( 'event', () => {} ),module:ui/template~Template.extend Extends the #template of the view with with given definition.
A shorthand for:
Template.extend( view.template, definition );
Note: Is requires the #template to be already set. See #setTemplate.
Definition which extends the #template.
Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an module:utils/eventinfo~EventInfo object,
followed by the optional args provided in the fire() method call.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The name of the event or EventInfo object if event is delegated.
Additional arguments to be passed to the callbacks.
By default the method returns undefined. However, the return value can be changed by listeners
through modification of the module:utils/eventinfo~EventInfo#return evt.return's property (the event info
is the first param of every callback).
Registers a callback function to be executed when an event is fired in a specific Emitter or DOM Node. It is backwards compatible with module:utils/emittermixin~Emitter#listenTo.
The object that fires the event.
The name of the event.
The function to be called on event.
Optionaloptions: CallbackOptions & { useCapture?: boolean; usePassive?: boolean }Additional options.
Optional ReadonlyuseCapture?: booleanIndicates that events of this type will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree.
Optional ReadonlyusePassive?: booleanIndicates that the function specified by listener will never call preventDefault() and prevents blocking browser's main thread by this event handler.
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 module:utils/eventinfo~EventInfo#stop stop the event and set the module:utils/eventinfo~EventInfo#return return value of the #fire method.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The object that fires the event.
The name of the event.
The function to be called on event.
Optionaloptions: CallbackOptionsAdditional options.
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 module:utils/eventinfo~EventInfo#stop stop the event and set the module:utils/eventinfo~EventInfo#return return value of the #fire method.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The object that fires the event.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
Stops executing the callback on the given event.
Shorthand for #stopListening this.stopListening( this, event, callback ).
The name of the event.
The function to stop being called.
Registers a callback function to be executed when an event is fired.
Shorthand for #listenTo this.listenTo( this, event, callback, options ) (it makes the emitter
listen on itself).
The type descibing the event. See module:utils/emittermixin~BaseEvent.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
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.
The type descibing the event. See module:utils/emittermixin~BaseEvent.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including #render rendering and #destroy destruction.
To revert this, use #deregisterChild.
class SampleView extends View {
constructor( locale ) {
super( locale );
this.childA = new SomeChildView( locale );
this.childB = new SomeChildView( locale );
this.setTemplate( { tag: 'p' } );
// Register the children.
this.registerChild( [ this.childA, this.childB ] );
}
render() {
super.render();
this.element.appendChild( this.childA.element );
this.element.appendChild( this.childB.element );
}
}
const view = new SampleView( locale );
view.render();
// Will append <p><childA#element><b></b><childB#element></p>.
document.body.appendChild( view.element );
Note: There's no need to add child views if they're already referenced in the #template:
class SampleView extends View {
constructor( locale ) {
super( locale );
this.childA = new SomeChildView( locale );
this.childB = new SomeChildView( locale );
this.setTemplate( {
tag: 'p',
// These children will be added automatically. There's no
// need to call {@link #registerChild} for any of them.
children: [ this.childA, this.childB ]
} );
}
// ...
}
Children views to be registered.
Recursively renders the view.
Once the view is rendered:
true.Note: The children of the view:
In general, render() method is the right place to keep the code which refers to the
#element and should be executed at the very beginning of the view's life cycle.
It is possible to module:ui/template~Template.extend the #template before
the view is rendered. To allow an early customization of the view (e.g. by its parent),
such references should be done in render().
class SampleView extends View {
constructor() {
this.setTemplate( {
// ...
} );
},
render() {
// View#element becomes available.
super.render();
// The "scroll" listener depends on #element.
this.listenTo( window, 'scroll', () => {
// A reference to #element would render the #template and make it non-extendable.
if ( window.scrollY > 0 ) {
this.element.scrollLeft = 100;
} else {
this.element.scrollLeft = 0;
}
} );
}
}
const view = new SampleView();
// Let's customize the view before it gets rendered.
view.extendTemplate( {
attributes: {
class: [
'additional-class'
]
}
} );
// Late rendering allows customization of the view.
view.render();
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 );
}
The property's name.
The property's value.
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'
} );
}
An object with name=>value pairs.
Optionalbind?: unknownOptionalbindTemplate?: unknownOptional Readonlybody?: unknownCollection of the child views, detached from the DOM structure of the editor, like panels, icons etc.
OptionalcreateCollection?: unknownOptionaldecorate?: unknownOptionaldelegate?: unknownOptionalderegisterChild?: unknownOptionaldestroy?: unknownOptional Readonlyeditable?: unknownThe editable of the decoupled editor UI.
Optional Readonlyelement?: unknownAn HTML element of the view. null until #render rendered
from the #template.
class SampleView extends View {
constructor() {
super();
// A template instance the #element will be created from.
this.setTemplate( {
tag: 'p'
// ...
} );
}
}
const view = new SampleView();
// Renders the #template.
view.render();
// Append the HTML element of the view to <body>.
document.body.appendChild( view.element );
Note: The element of the view can also be assigned directly:
view.element = document.querySelector( '#my-container' );
OptionalextendTemplate?: unknownOptionalfire?: unknownOptional ReadonlyisRendered?: unknownSet true when the view has already been module:ui/view~View#render rendered.
OptionallistenTo?: unknownOptional Readonlylocale?: unknownA set of tools to localize the user interface.
Also see module:core/editor/editor~Editor#locale.
Optional ReadonlymenuBarView?: unknownMenu bar view instance.
Optionaloff?: unknownOptionalon?: unknownOptionalonce?: unknownOptionalregisterChild?: unknownOptionalrender?: unknownOptionalset?: unknownOptionalsetTemplate?: unknownOptionalstopDelegating?: unknownOptionalstopListening?: unknownOptional Readonlyt?: unknownShorthand for module:utils/locale~Locale#t.
Note: If #locale instance hasn't been passed to the view this method may not be available.
Optional Readonlytemplate?: unknownTemplate of this view. It provides the #element representing the view in DOM, which is #render rendered.
Optional Readonlytoolbar?: unknownThe main toolbar of the decoupled editor UI.
Optionalunbind?: unknownOptional ReadonlyviewUid?: unknownSets the #template of the view with with given definition.
A shorthand for:
view.setTemplate( definition );
Definition of view's template.
Stops delegating events. It can be used at different levels:
Optionalevent: stringThe name of the event to stop delegating. If omitted, stops it all delegations.
Optionalemitter: Emitter(requires event) The object to stop delegating a particular event to.
If omitted, stops delegation of event to all emitters.
Stops listening for events. It can be used at different levels: It is backwards compatible with module:utils/emittermixin~Emitter#listenTo.
Optionalemitter: Node | EventTarget | Emitter | WindowThe object to stop listening to. If omitted, stops it for all objects.
Optionalevent: string(Requires the emitter) The name of the event to stop listening to. If omitted, stops it
for all events from emitter.
Optionalcallback: Function(Requires the event) The function to be removed from the call list for the given
event.
Stops listening for events. It can be used at different levels:
Optionalemitter: EmitterThe object to stop listening to. If omitted, stops it for all objects.
Optionalevent: string(Requires the emitter) The name of the event to stop listening to. If omitted, stops it
for all events from emitter.
Optionalcallback: Function(Requires the event) The function to be removed from the call list for the given
event.
Removes the binding created with #bind.
// Removes the binding for the 'a' property.
A.unbind( 'a' );
// Removes bindings for all properties.
A.unbind();
Observable properties to be unbound. All the bindings will be released if no properties are provided.
The decoupled editor UI view. It is a virtual view providing an inline module:editor-decoupled/decouplededitoruiview~DecoupledEditorUIView#editable, module:editor-decoupled/decouplededitoruiview~DecoupledEditorUIView#toolbar, and a module:editor-decoupled/decouplededitoruiview~DecoupledEditorUIView#menuBarView but without any specific arrangement of the components in the DOM.
See module:editor-decoupled/decouplededitor~DecoupledEditor.create
DecoupledEditor.create()to learn more about this view.