ISnackbarProps
interface
Component Props
Full props contract for <OrigamSnackbar> — a positioned notification surface with auto-dismiss timer, optional progress bar, multi-line and vertical layout modes, and the full design surface (color, border, elevation, spacing).
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.
- multiLineboolean
- Allows the snackbar text to wrap across multiple lines.
- textstring
- Body text of the snackbar. Can be used instead of the default slot.
- timerboolean | string
- Shows a progress bar indicating the remaining auto-dismiss time. Pass a color string to tint it.
- timeoutnumber | string
- Auto-dismiss delay in ms. Defaults to 5000. Pass -1 to disable auto-dismiss.
- verticalboolean
- Stacks the text and action vertically instead of inline.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Auto-dismiss snackbar with timer