HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket


The Optimizely Content Management System (CMS) user interface uses dialog boxes in many places to communicate information or perform tasks within the current view.

All the following examples can be seen on our [Optimizely's GitHub](🔗). You can clone the CMS repository: see **doc/how-to-use-dialogs **branch and run the site to see working examples.

### Alert dialog box

The **Alert** dialog box displays information that a user acknowledges but is not required to perform any action.





### Confirmation dialog box

The **Confirmation** dialog displays information for which a user must make a decision. It returns a promise that will be either resolved after clicking **OK** or rejected after clicking **Cancel**.





### Standard dialog box

The standard **Dialog** displays custom content. You should create a widget that displays and manages the business logic of the component and use the standard dialog as a display container.

You can either create a Dialog widget instance manually:



Or use another `dialogService` method:



## Callbacks

CMS dialog boxes are based on [Dojo Dialog](🔗). You can read the [Dojo dialog box documentation](🔗) for further information about events or other properties that can be passed as dialog parameters.

## Action labels

Each dialog box has properties that define the labels to be displayed. You can customize the default labels for actions when you construct the dialog box using `acknowledgeActionText` for the alert dialog box and `confirmActionText` and `cancelActionText` for the confirmation and standard dialogs. There are common action labels localized in `epi.resources.acti`on.

## Change available actions (Legacy)

Note

While existing solutions will continue to work, you should not build new solutions on this API. It will be phased out in the future.

When you use the standard dialog, there are times when the displayed widget needs to add actions to the action pane; a provider and consumer pattern is implemented to facilitate this in a decoupled fashion. The standard dialog is an `epi.shell.widget.\_ActionConsume`r and your widget inside the dialog implements the e`pi.shell.widget.\_ActionProviderWidget` and supply its actions using the `addActions` method.



You can register a provider with a consumer manually, by supplying it to the constructor arguments of the consumer.



If you do not have any use for the default dialog buttons, you can remove them by setting `defaultActionsVisible` to false when constructing the dialog box.

### Change the state of actions

To change the state of an action during the lifetime of a dialog box, such as enabling or disabling an action, call  `\_ActionProvider.setActionProperty()`.