Browse documentation

Runtime and views

v mount unmount update debouncedUpdate preventUpdate onCreate onUpdate onCleanup onRemove directive directives trust Vnode createElement current fragment hydrateDomToVnode isComponent isNodeJs isPOJOComponent isVnode isVnodeComponent reservedProps setAttribute setPropNameReserved updateAttributes updateVnode Properties DomElement Component POJOComponent ValyrianComponent VnodeComponentInterface Children Directive Fragment VnodeTag VnodeWithDom v-create v-update v-cleanup v-remove v-if v-show v-for v-html v-text v-class v-model v-keep key

Routing

Router RouterError mountRouter redirect beforeRoute afterRoute Request Middleware v-route

Data and async

request RequestPlugin RequestContext ResponseContext ErrorContext RequestInterface Suspense Task TaskStatus TaskStrategy TaskState TaskContext TaskOptions TaskHandler QueryClient QueryHandle MutationHandle QueryKey QueryStatus QueryState QueryConfig MutationConfig QueryClientOptions QueryChangeEvent

Network and offline

NetworkManager NetworkEvent SignalLevel NetworkError NetworkStatus NetworkListener NetworkManagerRuntime NetworkManagerOptions OfflineQueue RetryStrategy BackoffConfig OfflineOperation QueueState OfflineQueueOptions

State

createPulse createPulseStore createMutableStore createEffect Pulse PulseContext FluxStore

Forms

FormStore formSchemaShield FormState FormTransform FormTransformMap FormOptions v-form v-field

DevTools

connectPulse connectPulseStore connectFluxStore

Utilities

getLang getTranslations setLang setLog setStoreStrategy setTranslations t Money NumberFormatter formatMoney parseMoneyInput MoneyFormatOptions StorageType createNativeStore NativeStorageInterface v-t v-money deepCloneUnfreeze deepFreeze ensureIn get hasChanged hasLength hasLengthBetween hasMaxLength hasMinLength is isBetween isBoolean isEmpty isFiniteNumber isFunction isGreaterThan isLessThan isNumber isObject isString pick set

Server

Event ServerStorage document domToHtml domToHyperscript htmlToDom htmlToHyperscript icons inline render sw IconsOptions SwOptions

PWA

SwRuntimeManager registerSw SwRuntimeEvent SwRuntimeState SwRuntimeEnvironment CreateSwRuntimeOptions SwRuntime

Context

createContextScope getContext hasContext isServerContextActive runWithContext setContext ContextScope

API reference

Runtime and views

Routing

Router RouterError mountRouter redirect beforeRoute afterRoute Request Middleware v-route

Data and async

Network and offline

State

createPulse createPulseStore createMutableStore createEffect Pulse PulseContext FluxStore

Forms

FormStore formSchemaShield FormState FormTransform FormTransformMap FormOptions v-form v-field

DevTools

connectPulse connectPulseStore connectFluxStore

Utilities

Server

Event ServerStorage document domToHtml domToHyperscript htmlToDom htmlToHyperscript icons inline render sw IconsOptions SwOptions

PWA

SwRuntimeManager registerSw SwRuntimeEvent SwRuntimeState SwRuntimeEnvironment CreateSwRuntimeOptions SwRuntime

Context

createContextScope getContext hasContext isServerContextActive runWithContext setContext ContextScope

API reference FormsFormOptions

`FormOptions`

Type. FormStore state, schema, transforms and submit options.

Search the documentation

Enter a term to search Learn, documentation, APIs, guides and recipes.

Table of contents

Category Type import Public signature Type usage Related practice

Type import

ts

import type { FormOptions } from &quot;valyrian.js/forms&quot;;

Public signature

ts

type FormOptions&lt;TState extends FormState&gt; = { state: TState; schema: Record&lt;string, unknown&gt;; clean?: FormTransformMap&lt;TState&gt;; format?: FormTransformMap&lt;TState&gt;; onSubmit?: (values: TState) =&gt; Promise&lt;void&gt; | void; };

Type usage

FormOptions combines initial typed state, schema, optional transforms and submission.

Related practice

Continue with Manage form values and validation

PreviousFormTransformMap Nextv-form

On this pageCategory Type import Public signature Type usage Related practice