open-warning-modal

Type: Operation

A modal that warns the user. This can be used to check if the user really wants to finish the operation.

Is registered under the name WarningModal.

Use this modal in an operation. If the modal is canceled, the operation is canceled as well. If the modal is confirmed, the operation is continued.

Example:

JSON

{
    "document-remove": {
        "label": "Remove",
        "description": "Remove the document.",
        "icon": "times",
        "steps": [
            {
                "type": "operation/open-warning-modal",
                "data": {
                    "warningModalBody": "Are you sure you want to remove this document?",
                    "warningModalConfirmButtonLabel": "Remove",
                    "warningModalTitle": "Remove document"
                }
            },
            ⋮
        ]
    }
}

Imported operation data

  1. warningModalBody

    (Required)

    Type: String

    The text that is shown in the body of the modal

  2. [warningModalCancelButtonLabel]

    (Required)

    Type: String

    The label for the button that will cancel the operation.

  3. [warningModalConfirmButtonLabel]

    (Required)

    Type: String

    The label for the button that will continue the operation.

  4. warningModalTitle

    (Required)

    Type: String

    The text that will be shown in the header of the modal.