ISnackbarGroupItemOptions

interface
Data Shapes

Options accepted by useSnackbarGroup().notify(opts) — every field is optional except that the resulting item must surface either a title, a message, or both to the user.

TypeScript

Definition

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

typescript

API

Properties

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

title
string
Bold first line. Useful for short labels (e.g. "Saved").
message
string
Body text under the title (or sole line when title is absent).
intent
TIntent
Semantic intent driving icon defaults, role=status|alert, and surface coloring. Defaults to "info".
duration
number
Auto-dismiss timeout in ms. Overrides the stack-level defaultDuration. Pass 0 to make the item sticky.
icon
TIcon
Prepend icon override. Defaults to the per-intent icon (mdiCheckCircle for success, mdiAlertCircle for danger, …).
actions
ReadonlyArray<ISnackbarGroupItemAction>
Optional action buttons rendered in the snackbar footer.
dismissible
boolean
Whether to show the close (X) button. Default true.
onDismiss
() => void
Callback fired once the item leaves the stack.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

notify() with full options

typescript