ISnackbarItemProps
interface
Component Props
Props contract for <OrigamSnackbarItem> — the pure visual layer of a single toast notification. Owns intent theming, icon/title/message layout, action buttons, dismiss button, and ARIA semantics.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
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.
- intentTIntent
- Semantic intent — drives icon defaults and surface coloring. Defaults to "info".
- titlestring
- Optional title rendered as a bold first line.
- messagestring
- Body text rendered under the title (or as the sole line when title is absent).
- iconTIcon | false
- Prepend icon override. Pass false to suppress the icon entirely. Defaults to the per-intent icon.
- actionsReadonlyArray<ISnackbarGroupItemAction>
- Action buttons rendered inline after the text block.
- dismissibleboolean
- Whether to render the close dismiss button. Defaults to true.
- dismissLabelstring
- Accessible label for the dismiss button. Defaults to "Dismiss notification".
- role'status' | 'alert'
- ARIA role for the item element. Inferred from intent when not set: warning/danger → "alert", others → "status".
- ariaLive'polite' | 'assertive'
- ARIA live region politeness. Inferred from intent: warning/danger → "assertive", others → "polite".
- dataCystring
- data-cy attribute injected on the root item element for e2e test addressing.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Danger alert toast with custom icon