IFormProps
interface
Form & Input
Props for OrigamForm — controls disabled/readonly state, validation timing (validateOn), fast-fail behaviour, error messages, hints, scroll-to-error, and the overall validity v-model.
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.
- disabledboolean
- Disable all fields inside the form.
- fastFailboolean
- Stop validation after the first field failure.
- readonlyboolean
- Render all fields in read-only mode.
- modelValueboolean | null
- v-model for the overall form validity. null = untouched.
- validateOnTValidateOn
- When to trigger validation: blur, input, submit, or combinations.
- rulesArray<any>
- Form-level validation rules applied on submit.
- errorMessagesArray<string> | string
- Form-level error messages displayed under the form.
- hintstring
- Helper text displayed below the form.
- messagesArray<string> | string
- Informational messages displayed below the form.
- scrollToErrorboolean | ScrollIntoViewOptions
- Scroll to the first invalid field after a failed submission.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Form with blur-triggered validation and scroll-to-error