createForm API

API reference for the createForm composable.

Explore these related pages for additional context and usage patterns.

Page	Category
createForm	Forms
Form	Forms
createInput	Forms
createValidation	Forms
useRules	Plugins
createRegistry	Registration

Functions

createForm

(options?: FormOptions) => FormContext<FormTicketInput, FormTicket<FormTicketInput>>

Creates a new form instance. A form is a pure registry of validation contexts. Validations register themselves via `useForm()` injection. The form coordinates submit, reset, and aggregate state across all registered validations.

createFormContext

(_options?: FormContextOptions) => ContextTrinity<FormContext<FormTicketInput, FormTicket<FormTicketInput>>>

Creates a new form context using the Trinity pattern.

useForm

(namespace?: string) => R | undefined

Returns the current form instance.

Options

events

boolean | undefined

Enable event emission for registry operations

Default: false

reactive

boolean | undefined

Enable reactive behavior for registry operations

Default: false

disabled

MaybeRefOrGetter<boolean> | undefined

Whether the form starts disabled.

readonly

MaybeRefOrGetter<boolean> | undefined

Whether the form starts readonly.

Properties

collection

ReadonlyMap<ID, E>

The collection of tickets in the registry

size

number

The number of tickets in the registry

disabled

MaybeRefOrGetter<boolean>

Whether the form is disabled. Components can read this to conditionally disable inputs.

readonly

MaybeRefOrGetter<boolean>

Whether the form is readonly. Components can read this to conditionally disable inputs.

isValid

ComputedRef<boolean | null>

Aggregate: true if all validations valid, false if any invalid, null if any unvalidated.

isValidating

ComputedRef<boolean>

Aggregate: true if any validation is in progress.

Methods

clear

() => void

Clear the entire registry

has

(id: ID) => boolean

Check if a ticket exists by ID

keys

() => readonly ID[]

Get all registered IDs

browse

(value: E["value"]) => ID[] | undefined

Browse for an ID(s) by value

lookup

(index: number) => ID | undefined

lookup a ticket by index number

get

(id: ID) => E | undefined

Get a ticket by ID

upsert

(id: ID, ticket?: Partial<Z>, event?: string) => E

Update or insert a ticket by ID

values

() => readonly E[]

Get all values of registered tickets

entries

() => readonly [ID, E][]

Get all entries of registered tickets

unregister

(id: ID) => void

Unregister a ticket by ID

reindex

() => void

Reset the index directory and update all tickets

move

(id: ID, toIndex: number) => E | undefined

Seek for a ticket based on direction and optional predicate

seek

(direction?: "first" | "last", from?: number, predicate?: (ticket) => boolean) => E | undefined

on

<K extends Extensible<RegistryEventName>>(event: K, cb: EventHandler<E, K>) => void

Listen for registry events

off

<K extends Extensible<RegistryEventName>>(event: K, cb: EventHandler<E, K>) => void

Stop listening for registry events

emit

<K extends Extensible<RegistryEventName>>(event: K, data: EventPayload<E, K>) => void

Emit an event with data

dispose

() => void

Clears the registry and removes all listeners

offboard

(ids: ID[]) => void

Offboard multiple tickets at once

batch

<R>(fn: () => R) => R

Execute operations in a batch, deferring cache invalidation and event emission until complete

register

(registration: Partial<Z> & { value) => E

submit

(id?: ID | ID[]) => Promise<boolean>

Submit: validate specific fields or all.

reset

() => void

Reset all registered validations.