Skip to main content

Interface: ToastOptions

Presentation and persistence options for an addon notification.

Properties​

id?​

optional id?: string

Stable identifier used to update or dismiss an existing notification.

action?​

optional action?: "dismiss"

Set to dismiss to remove the notification identified by id.

message​

message: string

User-facing notification body.

optional header?: string

Optional short notification title.

duration?​

optional duration?: number

Display duration in milliseconds. Use 0 for a non-expiring update.

color?​

optional color?: "primary" | "secondary" | "success" | "warning" | "danger" | "light" | "medium" | "dark"

Semantic color selected from the host design system.

position?​

optional position?: "top" | "bottom" | "middle"

Preferred temporary-tooltip position.

showTooltip?​

optional showTooltip?: boolean

Display the temporary tooltip. Defaults to true.

saveInCenter?​

optional saveInCenter?: boolean

Keep the notification in the notification center. Defaults to false.