Confirm Dialog

Present a dialog to ask the user for confirmation.

Confirmation dialogs are used to ask the user for confirmation to complete some action and are presented as a center-aligned modal in the backoffice.

Extension authors do not need to register the dialog in their extension's manifest, instead these dialogs are opened by importing and calling the umbOpenModal function.

Extension authors can customize the dialog with configuration options such as headline, body content, colors, and button labels.

• headline - The headline of the modal.

• content - The content of the modal, which can be a TemplateResult or a string.

• color - (Optional) The color of the modal, can be positive or danger. Defaults to positive.

• confirmLabel - (Optional) The label of the confirmation button.

• cancelLabel - (Optional) The label of the cancel button.

To see all properties of the UMB_CONFIRM_MODAL token, see the API reference.

The onSubmit method returns a promise that resolves when the user confirms the dialog, and rejects when the user cancels the dialog.

Opening a Confirmation Dialog

my-element.ts

import {
    html,
    LitElement,
    customElement,
} from "@umbraco-cms/backoffice/external/lit";
import { UmbElementMixin } from "@umbraco-cms/backoffice/element-api";
import { umbOpenModal, UMB_CONFIRM_MODAL } from "@umbraco-cms/backoffice/modal";

@customElement("my-confirmation-modal")
export class MyConfirmationModal extends UmbElementMixin(LitElement) {
    #onRequestDisable() {
        umbOpenModal(this, UMB_CONFIRM_MODAL, {
            data: {
                headline: this.localize.term("actions_disable"),
                content: this.localize.term("defaultdialogs_confirmdisable"),
                color: "danger",
                confirmLabel: this.localize.term("actions_disable"),
            },
        })
            .then(() => {
                console.log("User has approved");
            })
            .catch(() => {
                console.log("User has rejected");
            });
    }

    render() {
        return html`<uui-button
      look="primary"
      color="danger"
      @click=${this.#onRequestDisable}
      label=${this.localize.term("actions_disable")}
    ></uui-button>`;
    }
}

Convenience Method

Confirmation dialogs can be opened using the umbConfirmModal method, which offers a slightly simplified API.

my-element.ts

import {
    html,
    LitElement,
    customElement,
} from "@umbraco-cms/backoffice/external/lit";
import { UmbElementMixin } from "@umbraco-cms/backoffice/element-api";
import { umbConfirmModal } from "@umbraco-cms/backoffice/modal";

@customElement("restart-services-modal")
export class RestartServicesModal extends UmbElementMixin(LitElement) {
    #onRequestDisable() {
        umbConfirmModal(this, {
            headline: this.localize.term("actions_disable"),
            content: this.localize.term("defaultdialogs_confirmdisable"),
            color: "danger",
            confirmLabel: this.localize.term("actions_disable"),
        })
            .then(() => {
                console.log("User has approved");
            })
            .catch(() => {
                console.log("User has rejected");
            });
    }

    render() {
        return html`<uui-button
      look="primary"
      color="positive"
      @click=${this.#onRequestDisable}
      label=${this.localize.term("actions_disable")}
    ></uui-button>`;
    }
}