Page Action | Confirm Modal

Use page.confirm() to display a confirmation modal to the user. This is particularly useful for actions that require user verification before proceeding, such as deletions or other irreversible operations.

Node.js

async function onClickDeleteCompany(companyId) {
    const companyName = companies[companyId].name;

    const confirmed = await page.confirm({
        message: `Are you sure you want to delete ${companyName}?`
        typeToConfirmText: companyName,
        appearance: "danger",
    });

    if (confirmed === true) {
        await db.company.deleteById(companyId);
        page.add(() => ui.text(`${companyName} was successfully deleted`))
    }
}

Python

async def on_click_delete_company(company_id: str):
    company_name = companies[company_id]["name"]

    confirmed = await page.confirm(
        message=f"Are you sure you want to delete {company_name}?",
        type_to_confirm_text=company_name,
        appearance="danger",
    )

    if confirmed:
        await db.company.delete_by_id(company_id)
        page.add(lambda: ui.text(f"{company_name} was successfully deleted"))

API reference

Function signature

Node.js

page.confirm(properties?: Partial<{
    title: string,
    message: string,
    appearance: "primary" | "outline" | "warning" | "danger",
    typeToConfirmText: string,
    confirmButtonLabel: string,
    cancelButtonLabel: string,
}>): Promise<boolean>

Python

page.confirm(
    *,
    title: str = "Confirm",
    message: str = "Are you sure you want to do this?",
    appearance: Literal["primary", "outline", "warning", "danger"] = "primary",
    type_to_confirm_text: str | None = None,
    confirm_button_label: str = "Yes",
    cancel_button_label: str = "No",
) -> Awaitable[bool]

Parameters

Node.js

properties.title

optional string

The title of the confirmation dialog. Defaults to "Confirm".

Python

title

optional str

The title of the confirmation dialog. Defaults to "Confirm".

---

Node.js

properties.message

optional string

The main message or question presented to the user. Defaults to "Are you sure you want to do this?".

Python

message

optional str

The main message or question presented to the user. Defaults to "Are you sure you want to do this?".

---

Node.js

properties.appearance

optional string literal

Sets the visual style of the dialog. For example, use "danger" for destructive actions. Defaults to "primary".

Options:

• "primary"
• "outline"
• "warning"
• "danger"

Python

appearance

optional Literal

Sets the visual style of the dialog. For example, use "danger" for destructive actions. Defaults to "primary".

Options:

• "primary"
• "outline"
• "warning"
• "danger"

---

Node.js

properties.typeToConfirmText

optional string

If provided, the user must type this text to enable the confirm button.

Python

type_to_confirm_text

optional str

If provided, the user must type this text to enable the confirm button.

---

Node.js

properties.confirmButtonLabel

optional string

Custom label for the confirm button. Defaults to 'Yes'.

Python

confirm_button_label

optional str

Custom label for the confirm button. Defaults to 'Yes'.

---

Node.js

properties.cancelButtonLabel

optional string

Custom label for the cancel button. Defaults to 'No'.

Python

cancel_button_label

optional str

Custom label for the cancel button. Defaults to 'No'.

---

Returns

Node.js

Promise<boolean>

A promise that resolves to true if the user confirms the action, or false if they cancel.

Python

Awaitable<boolean>

An awaitable that resolves to True if the user confirms the action, or False if they cancel.