Home/CKEditor 5/API

DialogView (ui/dialog)

@ckeditor/ckeditor5-ui/src/dialog/dialogview

class

Hierarchy

View
- DraggableView
  - DialogView

Implements

DraggableView

See source

A dialog view class.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

actionsView : DialogActionsView | undefined

See source
A view with the action buttons available to the user.
observable
ariaLabel : string

See source
A label for the view dialog element to be used by the assistive technologies.

readonly inherited
`bindTemplate : BindChain<this>`

See source

Shorthand for bind, a binding interface pre–configured for the view instance.

It provides to() and 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 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' )
			}
		} );
	}
}

observable
className : undefined | string

See source
A custom class name to be added to the dialog element.
closeButtonView : ButtonView | undefined

See source
A close button view. It is automatically added to the header view if present.
contentView : DialogContentView | undefined

See source
A view with the dialog content.
readonly
dragHandleElement : null | HTMLElement

See source
Returns the element that should be used as a drag handle.

inherited
`element : null | HTMLElement`

See source

An HTML element of the view. null until 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' );

readonly
focusTracker : FocusTracker

See source
A focus tracker instance.
headerView : FormHeaderView | undefined

See source
A header view of the dialog. It is also a drag handle of the dialog.
observable
isModal : boolean

See source
A flag indicating if this dialog view is a modal.
inherited
isRendered : boolean

See source
Set true when the view has already been rendered.
readonly
keystrokes : KeystrokeHandler

See source
A keystroke handler instance.
inherited
locale : undefined | Locale

See source
A set of tools to localize the user interface.

Also see locale.
readonly
parts : ViewCollection<View<HTMLElement>>

See source
A collection of the child views inside of the dialog. A dialog can have 3 optional parts: header, content, and actions.
observable
position : 'screen-center' | 'editor-center' | 'editor-top-side' | 'editor-top-center' | 'editor-bottom-center' | 'editor-above-center' | 'editor-below-center'

See source
The position of the dialog view.
inherited
t : undefined | LocaleTranslate
See source
Shorthand for t.

Note: If locale instance hasn't been passed to the view this method may not be available.

Related:
- Locale#t
inherited
template : Template | undefined

See source
Template of this view. It provides the element representing the view in DOM, which is rendered.
inherited
viewUid : string | undefined

See source
wasMoved : boolean

See source
A flag indicating if the dialog was moved manually. If so, its position will not be updated automatically upon window resize or document scroll.
internal observable
_isTransparent : boolean

See source
A flag indicating if a dialog is transparent. It is used to prevent the dialog from being visible before its position is calculated.
internal observable
_isVisible : boolean

See source
A flag indicating that the dialog should be shown. Once set to true, the dialog will be shown after its position is calculated. Until then, the dialog is transparent and not visible.

See _isTransparent property.
internal observable
_left : number

See source
The calculated dialog left CSS property used for positioning.
internal observable
_top : number

See source
The calculated dialog top CSS property used for positioning.
protected inherited
_unboundChildren : ViewCollection<View<HTMLElement>>

See source
A collection of view instances, which have been added directly into the children.
protected inherited
_viewCollections : Collection<ViewCollection<View<HTMLElement>>>

See source
Collections registered with createCollection.
private readonly
_focusCycler : FocusCycler

See source
The focus cycler instance.
private readonly
_focusables : ViewCollection<FocusableView>

See source
The list of the focusable elements inside the dialog view.
private
_getCurrentDomRoot : () => HTMLElement

See source
A callback returning the DOM root that requested the dialog.
private
_getViewportOffset : () => object

See source
A callback returning the configured editor viewport offset.

Static properties

static
defaultOffset : number

See source
A default dialog element offset from the reference element (e.g. editor editable area).

Methods

constructor( locale, __namedParameters = { __namedParameters.getCurrentDomRoot, __namedParameters.getViewportOffset } )

See source

Parameters

locale : Locale

__namedParameters : object

Properties

__namedParameters.getCurrentDomRoot : () => HTMLElement

__namedParameters.getViewportOffset : () => object
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, DialogView[ K1 ], K2, DialogView[ 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, DialogView[ K1 ], K2, DialogView[ 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' | 'element' | 'template' | 'focus' | 'moveBy' | 'moveTo' | 'className' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusTracker' | 'dragHandleElement' | 'position' | 'keystrokes' | 'parts' | 'headerView' | 'closeButtonView' | 'actionsView' | 'contentView' | 'wasMoved' | 'isModal' | '_isVisible' | '_isTransparent' | '_top' | '_left' | 'setupParts' | 'updatePosition'>

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, DialogView[ 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, DialogView[ K ]>

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

inherited
`createCollection( [ views ] ) → ViewCollection<T>`

See source

Creates a new collection of views, which can be used as 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 );

Type parameters

T : extends [object Object] = default

Parameters

[ views ] : Iterable<T>: Initial views of the collection.

Returns

ViewCollection<T>: A new collection of view instances.

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' | 'element' | 'template' | 'focus' | 'moveBy' | 'moveTo' | 'className' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusTracker' | 'dragHandleElement' | 'position' | 'keystrokes' | 'parts' | 'headerView' | 'closeButtonView' | 'actionsView' | 'contentView' | 'wasMoved' | 'isModal' | '_isVisible' | '_isTransparent' | '_top' | '_left' | 'setupParts' | 'updatePosition'

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

Parameters

children : View<HTMLElement> | Iterable<View<HTMLElement>>

Child views to be removed.

Returns

void

Related:
- DialogView#registerChild
inherited
destroy() → void
See source
Recursively destroys the view instance and child views added by registerChild and residing in collections created by the createCollection.

Destruction disables all event listeners:
- created on the view, e.g. view.on( 'event', () => {} ),
- defined in the template for DOM events.
Returns

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

Parameters

definition : Partial<TemplateDefinition>

Definition which extends the template.

Returns

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

See source
Focuses the first focusable element inside the dialog.

Returns

void
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 ] : CallbackOptions

Additional options.

Returns

void
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
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 or DOM Node. It is backwards compatible with listenTo.

Type parameters

K : extends keyof DomEventMap

Parameters

emitter : Window | Node

The object that fires the event.

event : K

The name of the event.

callback : ( DialogView, EventInfo<string, unknown>, DomEventMap[ K ] ) => void

The function to be called on event.

[ options ] : object

Additional options.

Returns

void
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

inherited
`registerChild( children ) → void`

See source

Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including rendering and 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 registerChild for any of them.
			children: [ this.childA, this.childB ]
		} );
	}

	// ...
}

Parameters

children : View<HTMLElement> | Iterable<View<HTMLElement>>: Children views to be registered.

Returns

void

render() → void
See source
Recursively renders the view.

Once the view is rendered:
- the element becomes an HTML element out of template,
- the isRendered flag is set true.
Note: The children of the view:
- defined directly in the template
- residing in collections created by the createCollection method,
- and added by registerChild are also rendered in the process.
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 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();
```
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 : DialogView[ K ]

The property's value.

Returns

void
inherited
setTemplate( definition ) → void
See source
Sets the template of the view with with given definition.

A shorthand for:
```
view.setTemplate( definition );
```
Parameters

definition : TemplateDefinition

Definition of view's template.

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
stopListening( [ emitter ], [ event ], [ callback ] ) → void
See source
Stops listening for events. It can be used at different levels: It is backwards compatible with listenTo.
- 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 ] : Window | Node | 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' | 'element' | 'template' | 'focus' | 'moveBy' | 'moveTo' | 'className' | 'ariaLabel' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'focusTracker' | 'dragHandleElement' | 'position' | 'keystrokes' | 'parts' | 'headerView' | 'closeButtonView' | 'actionsView' | 'contentView' | 'wasMoved' | 'isModal' | '_isVisible' | '_isTransparent' | '_top' | '_left' | 'setupParts' | 'updatePosition'>

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

Returns

void
updatePosition() → void

See source
Recalculates the dialog according to the set position and viewport, and moves it to the new position.

Returns

void
internal
moveBy( left, top ) → void

See source
Moves the dialog by the specified offset.

Parameters

left : number

top : number

Returns

void
internal
moveTo( left, top ) → void

See source
Normalizes the passed coordinates to make sure the dialog view is displayed within the visible viewport and moves it there.

Parameters

left : number

top : number

Returns

void
internal
setupParts( __namedParameters = { [__namedParameters.actionButtons], [__namedParameters.content], [__namedParameters.hasCloseButton], [__namedParameters.icon], [__namedParameters.title] } ) → void

See source
Creates the dialog parts. Which of them are created depends on the arguments passed to the method. There are no rules regarding the dialog construction, that is, no part is mandatory. Each part can only be created once.

Parameters

__namedParameters : object

Properties

[ __namedParameters.actionButtons ] : Array<DialogActionButtonDefinition>

[ __namedParameters.content ] : View<HTMLElement> | Array<View<HTMLElement>>

[ __namedParameters.hasCloseButton ] : boolean

[ __namedParameters.icon ] : string

[ __namedParameters.title ] : string

Returns

void
private
_createCloseButton() → ButtonView

See source
Creates the close button view that is displayed in the header view corner.

Returns

ButtonView
private
_getDialogRect() → Rect

See source
Calculates the dialog element rect.

Returns

Rect
private
_getViewportRect() → Rect

See source
Returns a viewport Rect shrunk by the viewport offset config from all sides.

TODO: This is a duplicate from position.ts module. It should either be exported there or land somewhere in utils.

Returns

Rect
private
_getVisibleDomRootRect( viewportRect ) → null | Rect

See source
Calculates the visible DOM root part.

Parameters

viewportRect : Rect

Returns

null | Rect
private
_moveOffScreen() → void

See source
Moves the dialog view to the off-screen position. Used when there is no space to display the dialog.

Returns

void
private
_moveTo( left, top ) → void

See source
Moves the dialog to the specified coordinates.

Parameters

left : number

top : number

Returns

void
private
_updateFocusCyclableItems() → void

See source
Collects all focusable elements inside the dialog parts and adds them to the focus tracker and focus cycler.

Returns

void

Events

change:_isTransparent( eventInfo, name, value, oldValue )

See source
Fired when the _isTransparent property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (_isTransparent).

value : boolean

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

oldValue : boolean

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

See source
Fired when the _isVisible property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (_isVisible).

value : boolean

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

oldValue : boolean

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

See source
Fired when the _left property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (_left).

value : number

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

oldValue : number

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

See source
Fired when the _top property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (_top).

value : number

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

oldValue : number

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

See source
Fired when the ariaLabel property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabel).

value : string

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

oldValue : string

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

See source
Fired when the className property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (className).

value : undefined | string

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

oldValue : undefined | string

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

See source
Fired when the isModal property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isModal).

value : boolean

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

oldValue : boolean

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

See source
Fired when the position property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (position).

value : 'screen-center' | 'editor-center' | 'editor-top-side' | 'editor-top-center' | 'editor-bottom-center' | 'editor-above-center' | 'editor-below-center'

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

oldValue : 'screen-center' | 'editor-center' | 'editor-top-side' | 'editor-top-center' | 'editor-bottom-center' | 'editor-above-center' | 'editor-below-center'

Old value of the position 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.
close( eventInfo, <anonymous> = { .source } )

See source
An event fired when the dialog is closed.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : object

Properties

<anonymous>.source : 'closeButton' | 'escKeyPress'
moveTo( eventInfo, <anonymous> )

See source
An event fired when the dialog is moved.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<TObservable[ TName ]>
inherited
render( eventInfo, <anonymous> )

See source
Event fired by the render method. Actual rendering is executed as a listener to this event with the default priority.

See decorate for more information and samples.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<TObservable[ TName ]>
set:_isTransparent( eventInfo, name, value, oldValue )

See source
Fired when the _isTransparent 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 (_isTransparent).

value : boolean

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

oldValue : boolean

Old value of the _isTransparent property with given key or null, if property was not set before.
set:_isVisible( eventInfo, name, value, oldValue )

See source
Fired when the _isVisible 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 (_isVisible).

value : boolean

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

oldValue : boolean

Old value of the _isVisible property with given key or null, if property was not set before.
set:_left( eventInfo, name, value, oldValue )

See source
Fired when the _left 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 (_left).

value : number

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

oldValue : number

Old value of the _left property with given key or null, if property was not set before.
set:_top( eventInfo, name, value, oldValue )

See source
Fired when the _top 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 (_top).

value : number

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

oldValue : number

Old value of the _top property with given key or null, if property was not set before.
set:ariaLabel( eventInfo, name, value, oldValue )

See source
Fired when the ariaLabel 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 (ariaLabel).

value : string

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

oldValue : string

Old value of the ariaLabel property with given key or null, if property was not set before.
set:className( eventInfo, name, value, oldValue )

See source
Fired when the className 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 (className).

value : undefined | string

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

oldValue : undefined | string

Old value of the className property with given key or null, if property was not set before.
set:isModal( eventInfo, name, value, oldValue )

See source
Fired when the isModal 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 (isModal).

value : boolean

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

oldValue : boolean

Old value of the isModal property with given key or null, if property was not set before.
set:position( eventInfo, name, value, oldValue )

See source
Fired when the position 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 (position).

value : 'screen-center' | 'editor-center' | 'editor-top-side' | 'editor-top-center' | 'editor-bottom-center' | 'editor-above-center' | 'editor-below-center'

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

oldValue : 'screen-center' | 'editor-center' | 'editor-top-side' | 'editor-top-center' | 'editor-bottom-center' | 'editor-above-center' | 'editor-below-center'

Old value of the position 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.
inherited
submit( eventInfo )

See source
Fired by submitHandler helper.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

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.

DialogView (ui/dialog)

Filtering

Properties

actionsView : DialogActionsView | undefinedmodule:ui/dialog/dialogview~DialogView#actionsView

observable ariaLabel : stringmodule:ui/dialog/dialogview~DialogView#ariaLabel

readonly inherited bindTemplate : BindChain<this>module:ui/dialog/dialogview~DialogView#bindTemplate

observable className : undefined | stringmodule:ui/dialog/dialogview~DialogView#className

closeButtonView : ButtonView | undefinedmodule:ui/dialog/dialogview~DialogView#closeButtonView

contentView : DialogContentView | undefinedmodule:ui/dialog/dialogview~DialogView#contentView

readonly dragHandleElement : null | HTMLElementmodule:ui/dialog/dialogview~DialogView#dragHandleElement

inherited element : null | HTMLElementmodule:ui/dialog/dialogview~DialogView#element

readonly focusTracker : FocusTrackermodule:ui/dialog/dialogview~DialogView#focusTracker

headerView : FormHeaderView | undefinedmodule:ui/dialog/dialogview~DialogView#headerView

observable isModal : booleanmodule:ui/dialog/dialogview~DialogView#isModal

inherited isRendered : booleanmodule:ui/dialog/dialogview~DialogView#isRendered

readonly keystrokes : KeystrokeHandlermodule:ui/dialog/dialogview~DialogView#keystrokes

inherited locale : undefined | Localemodule:ui/dialog/dialogview~DialogView#locale

readonly parts : ViewCollection<View<HTMLElement>>module:ui/dialog/dialogview~DialogView#parts

observable position : 'screen-center' | 'editor-center' | 'editor-top-side' | 'editor-top-center' | 'editor-bottom-center' | 'editor-above-center' | 'editor-below-center'module:ui/dialog/dialogview~DialogView#position

inherited t : undefined | LocaleTranslatemodule:ui/dialog/dialogview~DialogView#t

Related:

inherited template : Template | undefinedmodule:ui/dialog/dialogview~DialogView#template

inherited viewUid : string | undefinedmodule:ui/dialog/dialogview~DialogView#viewUid

wasMoved : booleanmodule:ui/dialog/dialogview~DialogView#wasMoved

internal observable _isTransparent : booleanmodule:ui/dialog/dialogview~DialogView#_isTransparent

internal observable _isVisible : booleanmodule:ui/dialog/dialogview~DialogView#_isVisible

internal observable _left : numbermodule:ui/dialog/dialogview~DialogView#_left

internal observable _top : numbermodule:ui/dialog/dialogview~DialogView#_top

protected inherited _unboundChildren : ViewCollection<View<HTMLElement>>module:ui/dialog/dialogview~DialogView#_unboundChildren

protected inherited _viewCollections : Collection<ViewCollection<View<HTMLElement>>>module:ui/dialog/dialogview~DialogView#_viewCollections

private readonly _focusCycler : FocusCyclermodule:ui/dialog/dialogview~DialogView#_focusCycler

private readonly _focusables : ViewCollection<FocusableView>module:ui/dialog/dialogview~DialogView#_focusables

private _getCurrentDomRoot : () => HTMLElementmodule:ui/dialog/dialogview~DialogView#_getCurrentDomRoot

private _getViewportOffset : () => objectmodule:ui/dialog/dialogview~DialogView#_getViewportOffset

Static properties

static defaultOffset : numbermodule:ui/dialog/dialogview~DialogView.defaultOffset

Methods

constructor( locale, __namedParameters = { __namedParameters.getCurrentDomRoot, __namedParameters.getViewportOffset } )module:ui/dialog/dialogview~DialogView#constructor

Parameters

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, DialogView[ K1 ], K2, DialogView[ K2 ]>module:ui/dialog/dialogview~DialogView#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperties ) → MultiBindChainmodule:ui/dialog/dialogview~DialogView#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, DialogView[ K ]>module:ui/dialog/dialogview~DialogView#bind:SINGLE_BIND

Type parameters

Parameters

Returns

inherited createCollection( [ views ] ) → ViewCollection<T>module:ui/dialog/dialogview~DialogView#createCollection

Type parameters

Parameters

Returns

inherited decorate( methodName ) → voidmodule:ui/dialog/dialogview~DialogView#decorate

Parameters

Returns

inherited delegate( events ) → EmitterMixinDelegateChainmodule:ui/dialog/dialogview~DialogView#delegate

Parameters

Returns

inherited deregisterChild( children ) → voidmodule:ui/dialog/dialogview~DialogView#deregisterChild

Parameters

Returns

Related:

inherited destroy() → voidmodule:ui/dialog/dialogview~DialogView#destroy

Returns

inherited extendTemplate( definition ) → voidmodule:ui/dialog/dialogview~DialogView#extendTemplate

Parameters

Returns

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:ui/dialog/dialogview~DialogView#fire

Type parameters

Parameters

Returns

focus() → voidmodule:ui/dialog/dialogview~DialogView#focus

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:ui/dialog/dialogview~DialogView#listenTo:DOM_EMITTER

Type parameters

Parameters

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:ui/dialog/dialogview~DialogView#listenTo:BASE_EMITTER

`actionsView : DialogActionsView | undefined`

observable
`ariaLabel : string`

readonly inherited
`bindTemplate : BindChain<this>`

observable
`className : undefined | string`

`closeButtonView : ButtonView | undefined`

`contentView : DialogContentView | undefined`

readonly
`dragHandleElement : null | HTMLElement`

inherited
`element : null | HTMLElement`

readonly
`focusTracker : FocusTracker`

`headerView : FormHeaderView | undefined`

observable
`isModal : boolean`

inherited
`isRendered : boolean`

readonly
`keystrokes : KeystrokeHandler`

inherited
`locale : undefined | Locale`

readonly
`parts : ViewCollection<View<HTMLElement>>`

observable
`position : 'screen-center' | 'editor-center' | 'editor-top-side' | 'editor-top-center' | 'editor-bottom-center' | 'editor-above-center' | 'editor-below-center'`

inherited
`t : undefined | LocaleTranslate`

inherited
`template : Template | undefined`

inherited
`viewUid : string | undefined`

`wasMoved : boolean`

internal observable
`_isTransparent : boolean`

internal observable
`_isVisible : boolean`

internal observable
`_left : number`

internal observable
`_top : number`

protected inherited
`_unboundChildren : ViewCollection<View<HTMLElement>>`

protected inherited
`_viewCollections : Collection<ViewCollection<View<HTMLElement>>>`

private readonly
`_focusCycler : FocusCycler`

private readonly
`_focusables : ViewCollection<FocusableView>`

private
`_getCurrentDomRoot : () => HTMLElement`

private
`_getViewportOffset : () => object`

static
`defaultOffset : number`

`constructor( locale, namedParameters = { namedParameters.getCurrentDomRoot, __namedParameters.getViewportOffset } )`

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

inherited
`bind( bindProperties ) → MultiBindChain`

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

inherited
`createCollection( [ views ] ) → ViewCollection<T>`

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

inherited
`deregisterChild( children ) → void`

inherited
`destroy() → void`

inherited
`extendTemplate( definition ) → void`

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

`focus() → void`

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

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

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

inherited
`off( event, callback ) → void`

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

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

inherited
`registerChild( children ) → void`

`render() → void`

inherited
`set( values ) → void`

inherited
`set( name, value ) → void`

inherited
`setTemplate( definition ) → void`

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

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

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

inherited
`unbind( unbindProperties ) → void`

`updatePosition() → void`

internal
`moveBy( left, top ) → void`

internal
`moveTo( left, top ) → void`

internal
`setupParts( namedParameters = { [namedParameters.actionButtons], [namedParameters.content], [namedParameters.hasCloseButton], [namedParameters.icon], [namedParameters.title] } ) → void`

private
`_createCloseButton() → ButtonView`

private
`_getDialogRect() → Rect`

private
`_getViewportRect() → Rect`

private
`_getVisibleDomRootRect( viewportRect ) → null | Rect`

private
`_moveOffScreen() → void`

private
`_moveTo( left, top ) → void`