Interface Toast

A live toast.

interface Toast {
    actionLabel?: string;
    durationMs: number;
    id: number;
    message: string;
    onAction?: () => void;
    onSecondaryAction?: () => void;
    secondaryActionLabel?: string;
    tone: ToastTone;
}

Index

Properties

actionLabel? durationMs id message onAction? onSecondaryAction? secondaryActionLabel? tone

Properties

`Optional` `Readonly`actionLabel

actionLabel?: string

Primary action label + handler (e.g. Try again).

`Readonly`durationMs

durationMs: number

ms before auto-dismiss; 0 = sticky.

`Readonly`id

id: number

`Readonly`message

message: string

Already-resolved, user-facing text.

`Optional` `Readonly`onAction

onAction?: () => void

`Optional` `Readonly`onSecondaryAction

onSecondaryAction?: () => void

`Optional` `Readonly`secondaryActionLabel

secondaryActionLabel?: string

Secondary action label + handler (e.g. Report) — shown alongside the primary.

`Readonly`tone

tone: ToastTone