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

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.

disabled
boolean
Disable all fields inside the form.
fastFail
boolean
Stop validation after the first field failure.
readonly
boolean
Render all fields in read-only mode.
modelValue
boolean | null
v-model for the overall form validity. null = untouched.
validateOn
TValidateOn
When to trigger validation: blur, input, submit, or combinations.
rules
Array<any>
Form-level validation rules applied on submit.
errorMessages
Array<string> | string
Form-level error messages displayed under the form.
hint
string
Helper text displayed below the form.
messages
Array<string> | string
Informational messages displayed below the form.
scrollToError
boolean | ScrollIntoViewOptions
Scroll to the first invalid field after a failed submission.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

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

Form with blur-triggered validation and scroll-to-error

vue