Home/CKEditor 5/API

Dialog (ui/dialog)

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

class

See source

The dialog controller class. It is used to show and hide the DialogView.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

readonly inherited
editor : Editor
See source
The editor instance.

Note that most editors implement the ui property. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or throw an error when accessing it.

Because of above, to make plugins more universal, it is recommended to split features into:
- The "editing" part that uses the Editor class without ui property.
- The "UI" part that uses the Editor class and accesses ui property.
observable
id : null | string

See source
The name of the currently visible dialog view instance.
inherited observable
isEnabled : boolean
See source
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.

Plugin can be simply disabled like that:
```
// Disable the plugin so that no toolbars are visible.
editor.plugins.get( 'TextTransformation' ).isEnabled = false;
```
You can also use forceDisabled method.
observable
isOpen : boolean

See source
A flag indicating whether the dialog is currently visible.
view : DialogView | undefined

See source
The currently visible dialog view instance.
private
_onHide : undefined | ( Dialog ) => void

See source
A configurable callback called when the dialog is hidden.

Static properties

readonly inherited static
isContextPlugin : false

See source
readonly static
pluginName : 'Dialog'

See source
internal readonly static
isOfficialPlugin : true

See source
internal readonly inherited static
isPremiumPlugin : boolean

See source
private static
_visibleDialogPlugin : null | Dialog

See source
The Dialog plugin instance which most recently showed the dialog.

Only one dialog can be visible at once, even if there are many editor instances on the page. If an editor wants to show a dialog, it should first hide the dialog that is already opened. But only the Dialog instance that showed the dialog is able able to properly hide it. This is why we need to store it in a globally available space (static property). This way every Dialog plugin in every editor is able to correctly close any open dialog window.

Methods

constructor( editor )

See source

Parameters

editor : Editor
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Dialog[ K1 ], K2, Dialog[ 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, Dialog[ K1 ], K2, Dialog[ 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' | 'view' | 'id' | 'destroy' | 'isEnabled' | 'show' | 'hide' | 'isOpen' | 'editor' | 'forceDisabled' | 'clearForceDisabled'>

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

The bind chain with the to() and toMany() methods.
inherited
clearForceDisabled( id ) → void

See source
Clears forced disable previously set through forceDisabled. See forceDisabled.

Parameters

id : string

Unique identifier, equal to the one passed in forceDisabled call.

Returns

void
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' | 'view' | 'id' | 'destroy' | 'isEnabled' | 'show' | 'hide' | 'isOpen' | 'editor' | 'forceDisabled' | 'clearForceDisabled'

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

See source
Destroys the plugin.

Note: This method is optional. A plugin instance does not need to have it defined.

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).
inherited
forceDisabled( id ) → void
See source
Disables the plugin.

Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when enabling back the plugin. The plugin becomes enabled only after all features enabled it back.

Disabling and enabling a plugin:
```
plugin.isEnabled; // -> true
plugin.forceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Plugin disabled by multiple features:
```
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'OtherFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'OtherFeature' );
plugin.isEnabled; // -> true
```
Multiple disabling with the same identifier is redundant:
```
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'MyFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Note: some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after clearForceDisabled was used.

Parameters

id : string

Unique identifier for disabling. Use the same id when enabling back the plugin.

Returns

void
hide() → void

See source
Hides the dialog. This method is decorated to enable interacting on the hide event.

See show.

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
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
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 : Dialog[ K ]

The property's value.

Returns

void

`show( dialogDefinition ) → void`

See source

Displays a dialog window.

This method requires a DialogDefinition that defines the dialog's content, title, icon, action buttons, etc.

For example, the following definition will create a dialog with:

A header consisting of an icon, a title, and a "Close" button (it is added by default).
A content consisting of a view with a single paragraph.
A footer consisting of two buttons: "Yes" and "No".

// Create the view that will be used as the dialog's content.
const textView = new View( locale );

textView.setTemplate( {
	tag: 'div',
	attributes: {
		style: {
			padding: 'var(--ck-spacing-large)',
			whiteSpace: 'initial',
			width: '100%',
			maxWidth: '500px'
		},
		tabindex: -1
	},
	children: [
		'Lorem ipsum dolor sit amet...'
	]
} );

// Show the dialog.
editor.plugins.get( 'Dialog' ).show( {
	id: 'myDialog',
	icon: 'myIcon', // This should be an SVG string.
	title: 'My dialog',
	content: textView,
	actionButtons: [
		{
			label: t( 'Yes' ),
			class: 'ck-button-action',
			withText: true,
			onExecute: () => dialog.hide()
		},
		{
			label: t( 'No' ),
			withText: true,
			onExecute: () => dialog.hide()
		}
	]
} );

By specifying the onShow and onHide callbacks it is also possible to add callbacks that will be called when the dialog is shown or hidden.

For example, the callbacks in the following definition:

Disable the default behavior of the Esc key.
Fire a custom event when the dialog gets hidden.

editor.plugins.get( 'Dialog' ).show( {
	// ...
	onShow: dialog => {
		dialog.view.on( 'close', ( evt, data ) => {
			// Only prevent the event from the "Esc" key - do not affect the other ways of closing the dialog.
			if ( data.source === 'escKeyPress' ) {
				evt.stop();
			}
		} );
	},
	onHide: dialog => {
		dialog.fire( 'dialogDestroyed' );
	}
} );

Internally, calling this method:

Hides the currently visible dialog (if any) calling the hide method (fires the hide event).
Fires the show event which allows for adding callbacks that customize the behavior of the dialog.
Shows the dialog.

Parameters

dialogDefinition : DialogDefinition

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' | 'view' | 'id' | 'destroy' | 'isEnabled' | 'show' | 'hide' | 'isOpen' | 'editor' | 'forceDisabled' | 'clearForceDisabled'>

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

Returns

void
private
_hide() → void

See source
Destroys the DialogView and cleans up the stored dialog state.

Returns

void
private
_initFocusToggler() → void

See source
Initiates keystroke handler for toggling the focus between the editor and the dialog view.

Returns

void
private
_initMultiRootIntegration() → void

See source
Provides an integration between the root attaching and detaching and positioning of the view.

Returns

void
private
_initShowHideListeners() → void

See source
Initiates listeners for the show and hide events emitted by this plugin.

We could not simply decorate the show and hide methods to fire events, because they would be fired in the wrong order – first would be show and then hide (because showing the dialog actually starts with hiding the previously visible one). Hence, we added private methods _show and _hide which are called on events in the desired sequence.

Returns

void
private
_lockBodyScroll() → void

See source
Makes the unscrollable (e.g. when the modal shows up).

Returns

void
private
_show( __namedParameters ) → void

See source
Handles creating the DialogView instance and making it visible.

Parameters

__namedParameters : DialogDefinition

Returns

void
private
_unlockBodyScroll() → void

See source
Makes the scrollable again (e.g. once the modal hides).

Returns

void

Events

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

See source
Fired when the id property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (id).

value : null | string

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

oldValue : null | string

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

See source
Fired when the isEnabled property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isEnabled).

value : boolean

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

oldValue : boolean

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

See source
Fired when the isOpen property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isOpen).

value : boolean

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

oldValue : boolean

Old value of the isOpen 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.
hide( eventInfo )
See source
An event fired after hide is called. You can use it to customize the behavior of any dialog.
```
// Logs after the "Find and Replace" dialog gets hidden
editor.plugins.get( 'Dialog' ).on( 'hide:findAndReplace', () => {
	console.log( 'The "Find and Replace" dialog was hidden.' );
} );
```
Parameters

eventInfo : EventInfo

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

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

value : null | string

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

oldValue : null | string

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

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

value : boolean

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

oldValue : boolean

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

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

value : boolean

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

oldValue : boolean

Old value of the isOpen 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.
show( eventInfo, dialogDefinition )
See source
An event fired after show is called. You can use it to customize the behavior of any dialog.
```
import { DialogViewPosition } from 'ckeditor5/src/ui.js';

// ...

// Changes the position of the "Find and Replace" dialog.
editor.plugins.get( 'Dialog' ).on( 'show:findAndReplace', ( evt, data ) => {
	Object.assign( data, { position: DialogViewPosition.EDITOR_BOTTOM_CENTER } );
}, { priority: 'high' } );
```
Parameters

eventInfo : EventInfo

An object containing information about the fired event.

dialogDefinition : DialogDefinition

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.

Dialog (ui/dialog)

Filtering

Properties

readonly inherited editor : Editormodule:ui/dialog/dialog~Dialog#editor

observable id : null | stringmodule:ui/dialog/dialog~Dialog#id

inherited observable isEnabled : booleanmodule:ui/dialog/dialog~Dialog#isEnabled

observable isOpen : booleanmodule:ui/dialog/dialog~Dialog#isOpen

view : DialogView | undefinedmodule:ui/dialog/dialog~Dialog#view

private _onHide : undefined | ( Dialog ) => voidmodule:ui/dialog/dialog~Dialog#_onHide

Static properties

readonly inherited static isContextPlugin : falsemodule:ui/dialog/dialog~Dialog.isContextPlugin

readonly static pluginName : 'Dialog'module:ui/dialog/dialog~Dialog.pluginName

internal readonly static isOfficialPlugin : truemodule:ui/dialog/dialog~Dialog.isOfficialPlugin

internal readonly inherited static isPremiumPlugin : booleanmodule:ui/dialog/dialog~Dialog.isPremiumPlugin

private static _visibleDialogPlugin : null | Dialogmodule:ui/dialog/dialog~Dialog._visibleDialogPlugin

Methods

constructor( editor )module:ui/dialog/dialog~Dialog#constructor

Parameters

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

Type parameters

Parameters

Returns

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

Parameters

Returns

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

Type parameters

Parameters

Returns

inherited clearForceDisabled( id ) → voidmodule:ui/dialog/dialog~Dialog#clearForceDisabled

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

destroy() → voidmodule:ui/dialog/dialog~Dialog#destroy

Returns

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

Type parameters

Parameters

Returns

inherited forceDisabled( id ) → voidmodule:ui/dialog/dialog~Dialog#forceDisabled

Parameters

Returns

hide() → voidmodule:ui/dialog/dialog~Dialog#hide

Returns

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

Type parameters

Parameters

Returns

inherited off( event, callback ) → voidmodule:ui/dialog/dialog~Dialog#off

Parameters

Returns

inherited on( event, callback, [ options ] ) → voidmodule:ui/dialog/dialog~Dialog#on

Type parameters

Parameters

Returns

inherited once( event, callback, [ options ] ) → voidmodule:ui/dialog/dialog~Dialog#once

Type parameters

Parameters

Returns

inherited set( values ) → voidmodule:ui/dialog/dialog~Dialog#set:OBJECT

Parameters

Returns

inherited set( name, value ) → voidmodule:ui/dialog/dialog~Dialog#set:KEY_VALUE

Type parameters

Parameters

Returns

show( dialogDefinition ) → voidmodule:ui/dialog/dialog~Dialog#show

Parameters

Returns

inherited stopDelegating( [ event ], [ emitter ] ) → voidmodule:ui/dialog/dialog~Dialog#stopDelegating

Parameters

Returns

inherited stopListening( [ emitter ], [ event ], [ callback ] ) → voidmodule:ui/dialog/dialog~Dialog#stopListening:BASE_STOP

Parameters

Returns

readonly inherited
`editor : Editor`

observable
`id : null | string`

inherited observable
`isEnabled : boolean`

observable
`isOpen : boolean`

`view : DialogView | undefined`

private
`_onHide : undefined | ( Dialog ) => void`

readonly inherited static
`isContextPlugin : false`

readonly static
`pluginName : 'Dialog'`

internal readonly static
`isOfficialPlugin : true`

internal readonly inherited static
`isPremiumPlugin : boolean`

private static
`_visibleDialogPlugin : null | Dialog`

`constructor( editor )`

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

inherited
`bind( bindProperties ) → MultiBindChain`

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

inherited
`clearForceDisabled( id ) → void`

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → void`

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

inherited
`forceDisabled( id ) → void`

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

inherited
`set( name, value ) → void`

`show( dialogDefinition ) → void`

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

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

inherited
`unbind( unbindProperties ) → void`

private
`_hide() → void`

private
`_initFocusToggler() → void`

private
`_initMultiRootIntegration() → void`

private
`_initShowHideListeners() → void`

private
`_lockBodyScroll() → void`

private
`_show( __namedParameters ) → void`

private
`_unlockBodyScroll() → void`

`change:id( eventInfo, name, value, oldValue )`

inherited
`change:isEnabled( eventInfo, name, value, oldValue )`

`change:isOpen( eventInfo, name, value, oldValue )`

inherited
`change:{property}( eventInfo, name, value, oldValue )`

`hide( eventInfo )`

`set:id( eventInfo, name, value, oldValue )`

inherited
`set:isEnabled( eventInfo, name, value, oldValue )`

`set:isOpen( eventInfo, name, value, oldValue )`

inherited
`set:{property}( eventInfo, name, value, oldValue )`

`show( eventInfo, dialogDefinition )`