Page Action | Toast

Use page.toast() to display a temporary toast notification to the user. This is particularly useful for displaying messages to the user that are not critical and do not require user interaction.

Node.js

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

    page.toast(`${companyName} was successfully deleted`);
}

Python

async def on_click_delete_company(company_id: str):
    company_name = companies[company_id]["name"]
    await db.company.delete_by_id(company_id)

    page.toast(f"{company_name} was successfully deleted")

API reference

Function signature

Node.js

page.toast(
    message: string,
    properties?: Partial<{
        title: string,
        appearance: "success" | "info" | "warning" | "error",
        duration: "shortest" | "short" | "medium" | "long" | "longest" | "infinite"
}>): void

Python

page.toast(
    message: str,
    *,
    title: str | None = None,
    appearance: Literal["success", "info", "warning", "error"] = "info",
    duration: Literal["shortest", "short", "medium", "long", "longest", "infinite"] = "medium",
) -> None

Parameters

Node.js

message

required string

The message to display in the toast notification.

Python

message

required str

The message to display in the toast notification.

---

Node.js

properties.title

optional string

An optional title for the toast notification. If provided, it will be displayed above the message.

Python

title

optional str

An optional title for the toast notification. If provided, it will be displayed above the message.

---

Node.js

properties.appearance

optional string literal

Sets the visual style of the toast. Defaults to "info".

Options:

• "success": Use for successful operations
• "info": Use for general information
• "warning": Use for warnings
• "error": Use for errors or destructive actions

Python

appearance

optional Literal

Sets the visual style of the toast. Defaults to "info".

Options:

• "success": Use for successful operations
• "info": Use for general information
• "warning": Use for warnings
• "error": Use for errors or destructive actions

---

Node.js

properties.duration

optional string literal

Determines how long the toast will be displayed before disappearing. Defaults to "medium".

Options:

• "shortest": 1.5 seconds
• "short": 3 seconds
• "medium": 5 seconds
• "long": 10 seconds
• "longest": 20 seconds
• "infinite": 1000 seconds

Python

duration

optional Literal

Determines how long the toast will be displayed before disappearing. Defaults to "medium".

Options:

• "shortest": 1.5 seconds
• "short": 3 seconds
• "medium": 5 seconds
• "long": 10 seconds
• "longest": 20 seconds
• "infinite": 1000 seconds

---

Returns

Node.js

void

Python

None