IMessagesProps
interface
Component Props
Props for <OrigamMessages> — a validation messages renderer used internally by form fields to display one or more inline error, warning or hint messages with animated transitions.
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.
- activeboolean
- When true the messages container is visible. Drives the transition in/out animation.
- messagesArray<string> | string
- One or more message strings to display. A single string is normalised internally to an array. Used by form fields to pass validation errors or hints.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Messages in a custom form field