Skip to content

ToastOptions

ToastOptions = object

Defined in: packages/ui/src/types.ts:880

Options for displaying a toast notification.

Passed to ToastApi.show for full control over the notification. The convenience methods (success, error, info, warning) set the type automatically.

  • ToastApi for the imperative notification API.
  • ToastType for the available severity levels.

optional description: string

Defined in: packages/ui/src/types.ts:888

Optional secondary description text.


optional duration: number

Defined in: packages/ui/src/types.ts:886

Auto-dismiss duration in milliseconds.


message: string

Defined in: packages/ui/src/types.ts:882

Primary message text.


optional type: ToastType

Defined in: packages/ui/src/types.ts:884

Notification type determining the visual style.