IFormProvide

interface
Form & Input

Provide/inject contract exposed by OrigamForm to its descendant fields — lets fields register/unregister themselves and report validation state back to the parent form.

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

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.

register
requis
(item: { id: number | string vm: ComponentInternalInstance validate: () => Promise<Array<string>> reset: () => Promise<void> resetValidation: () => Promise<void> }) => void
Called by a field on mount to register itself with the parent form.
unregister
requis
(id: number | string) => void
Called by a field on unmount to deregister itself.
update
requis
(id: number | string, isValid: boolean | undefined, errorMessages: Array<string>) => void
Called by a field after validation to report its current valid state and error messages.
items
Ref<Array<IFormField>>
Reactive list of all registered fields.
isDisabled
requis
ComputedRef<boolean>
Whether the form is disabled.
isReadonly
requis
ComputedRef<boolean>
Whether the form is readonly.
isValidating
Ref<boolean>
True while form validation is running.
isValid
requis
Ref<boolean | null | undefined>
Overall form validity.
validateOn
requis
Ref<TValidateOn | undefined>
When validation should be triggered.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

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

Injecting IFormProvide inside a custom field

typescript