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

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

intent
TIntent
Semantic intent — drives icon defaults and surface coloring. Defaults to "info".
title
string
Optional title rendered as a bold first line.
message
string
Body text rendered under the title (or as the sole line when title is absent).
icon
TIcon | false
Prepend icon override. Pass false to suppress the icon entirely. Defaults to the per-intent icon.
actions
ReadonlyArray<ISnackbarGroupItemAction>
Action buttons rendered inline after the text block.
dismissible
boolean
Whether to render the close dismiss button. Defaults to true.
dismissLabel
string
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".
dataCy
string
data-cy attribute injected on the root item element for e2e test addressing.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Danger alert toast with custom icon

vue