Skip to main content

Function: ToastRegion()

ToastRegion(props): Element

Defined in: components/Toast/Toast.tsx:627

The Toast host — place once near the root of your app and pass the queue created with createToastQueue. Renders each queued toast as a Toast surface.

Uses vars.elevation.raised — the first component in the system that lifts off the page plane without being a full overlay.

Placement is the theme's decision and not a prop (CONTRACT §4): a product whose toasts appear bottom-end on one screen and top-center on the next is a product with two notification systems. The reference exposes four placements; ours ships the one, at the trailing bottom corner, where a transient report is furthest from the content the user is reading and from the primary actions they are reaching for.

Parameters

ParameterType
propsToastRegionProps

Returns

Element

Example

<ToastRegion queue={toastQueue} />