ISnackbarGroupProps

interface
Component Props

Props contract for <OrigamSnackbarGroup> — a multi-toast container that orchestrates a queue of OrigamSnackbar instances driven through the useSnackbarGroup({ id }) composable.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

id
string
Identifier of the stack this container renders. Pair with useSnackbarGroup({ id }) to push items into the same stack. Defaults to "default".
location
TSnackbarGroupLocation
Anchor location on the viewport — drives both absolute positioning and the direction default. Defaults to "bottom-right".
max
number
Maximum number of items rendered concurrently. When exceeded, the oldest item is evicted FIFO. Defaults to 5.
defaultDuration
number
Default auto-dismiss timeout (ms) for items without their own duration. Pass 0 to make all items sticky. Defaults to 5000.
spacing
string | number
Gap between stacked items (CSS dimension). Defaults to "12px".
direction
TSnackbarGroupDirection
Stacking order. Defaults to "top-down" for top-* locations and "bottom-up" for bottom-* locations.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Global toast container at top-right

vue