IAlertProps
interface
Component Props
Full props contract for <OrigamAlert> — closable banner with optional icon, title, text, v-model visibility and the full design surface (color, border, spacing, elevation, position).
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.
- closableboolean
- Shows a close button on the alert. Triggers the click:close emit when pressed.
- closeIconTIcon
- Custom icon for the close button. Defaults to the DS close icon.
- closeLabelstring
- Accessible label for the close button (aria-label). Defaults to "Close".
- modelValueboolean
- Controls the visibility of the alert via v-model. When false the alert is hidden.
- titlestring
- Bold heading rendered above the alert body.
- textstring
- Body text of the alert. Rendered inside the default slot when the slot is not used.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Closable danger alert with v-model