DialogDefinition

The action buttons displayed in the dialog's footer.

An additional CSS class set on the outermost (.ck.ck-dialog) container element allowing for visual customization.

The content of the dialog. It can be a single View or an array of views.

A callback executed whenever the dialog is about to show up that returns the DOM root name that the dialog should be positioned relative to.

If not set, the dialog will be positioned relative to the DOM root the model selection is anchored to.

A flag indicating whether the dialog should have a close button in the header. true by default. Works when title is also set and the header is displayed.

Note: If you hide the close button, make sure that the dialog can be closed in another way.

The SVG string of an icon displayed in dialogs's header. Used only when title is also set and the header is displayed.

See more in content.

A unique identifier of the dialog. It allows for distinguishing between different dialogs and their visibility. For instance, when open, the ID of the currently visible dialog is stored in id.

The id is also passed along the DialogShowEvent and DialogHideEvent events.

When set to true, the dialog will become a modal, that is, it will block the UI until it is closed.

Options that will be passed to the keystroke handler of the dialog view.

See KeystrokeHandlerOptions to learn more about the available options.

A callback called when the dialog hides with a low priority. It allows for cleaning up (for example, resetting) the dialog's content.

A callback called when the dialog shows up with a low priority. It allows for setting up the dialog's content.

Available dialog positions. By default DialogViewPosition.EDITOR_CENTER is used for non-modals and DialogViewPosition.SCREEN_CENTER for modals.

If set to a function, it will be fed dialog and DOM root geometry as arguments and should return the coordinates of the dialog's position.

• Learn more about available positions.
• Learn more about which editor root the dialog is positioned relative to in the getRootName section.

A title displayed in the dialogs's header. It also works as an accessible name of the dialog used by assistive technologies.

When not set, the header is not displayed. Affects icon and hasCloseButton.