Interface UiToastPayload

Payload of the ui:toast event. ui.showToast asks the calling page to show a toast. The host draws nothing; the page renders it from these fields.

interface UiToastPayload {
    duration: number;
    message: string;
    position: string;
    type: "error" | "info" | "warning" | "success";
}

Properties

duration: number

Display time in milliseconds as given, 3000 when omitted. It is not range-checked and can be 0 or negative.

message: string

Toast text; never empty.

position: string

Screen corner as given and not checked; bottom-right when omitted.

type: "error" | "info" | "warning" | "success"

Toast kind; info when omitted.