Browser form data
FormDataRecordtype-alias
Object representation of native FormData, preserving repeated names as arrays.
FormDataValuetype-alias
Native value emitted by
FormData.decodeFormDatafunction
Decodes native FormData through an Effect Schema codec.
formDataToRecordfunction
Converts native form data to a record, preserving repeated names as arrays.
Component options
CheckboxOptionsinterface
Options for a state-explicit native checkbox.
DateInputOptionstype-alias
Date-valued native input options.
InputOptionsinterface
State-explicit native input binding with a compatible field name and optional string codec.
NumberInputOptionstype-alias
Finite-number native input options.
PushOptionsinterface
Options for an array-field append button.
RemoveOptionsinterface
Options for an array-field removal button.
ResetOptionsinterface
Options for a state-explicit reset button.
SchemaBoundCheckboxOptionsinterface
Options for a schema-bound boolean checkbox.
SchemaBoundErrorOptionsinterface
Options for a schema-bound field-error region.
SchemaBoundInputOptionsinterface
Options for a schema-bound native input.
SchemaBoundMaskedInputOptionsinterface
Options for a schema-bound masked text input.
SchemaBoundPushOptionsinterface
Options for a schema-bound array append button.
SchemaBoundRemoveOptionsinterface
Options for a schema-bound array removal button.
SchemaBoundResetOptionsinterface
Options for a schema-bound reset button.
SchemaBoundSelectOptionsinterface
Options for a schema-bound native select.
SchemaBoundStateOptionsinterface
Optional state metadata for
SchemaBoundForm.state.SelectOptionsinterface
Options for a state-explicit native select.
SubmitOptionsinterface
Options for a native submit button.
TextInputOptionstype-alias
String-valued native input options.
Field relationships
Descriptionfunction
Renders visible explanatory content in a neutral div.
DescriptionOptionsinterface
Options for descriptive form content.
Errorfunction
Renders the named field message with a generated ID and alert role.
ErrorOptionsinterface
Options for a field validation alert.
Groupfunction
Renders an ARIA group with an optional accessible name.
GroupOptionsinterface
Options for an accessible group of form controls.
Labelfunction
Renders a native label with an explicit control relationship.
LabelOptionsinterface
Options for a native form label.
Field types
FieldNameFortype-alias
Field names whose decoded value is assignable to
Value.SchemaFieldNameFortype-alias
Struct field names matching both decoded and encoded control value types.
Form actions
Form context
CurrentFormvariable
Effect context service used by schema-bound form controls.
FormServiceinterface
Context service exposed to schema-bound descendant controls.
Form roots
BoundFormOptionsinterface
Options accepted by a schema-bound form root.
Formfunction
Renders a native form and provides its state to bound descendants.
FormOptionsinterface
Options for the state-explicit form root.
ValidSubmitHandlertype-alias
Handler invoked only after whole-form Schema validation succeeds.
Hydration schemas
StateSchemafunction
Builds the serializable schema for a form’s hydrated state.
Input codecs
MaskParttype-alias
Literal or decoded segment of a mask.
MaskSlotinterface
Named decoded segment in a bidirectional text mask.
MaskedInputfunction
Binds a native text input to a structured mask value.
MaskedInputOptionsinterface
Options for an input decoded through a structured mask codec.
maskfunction
Builds a bidirectional Schema codec from literal text and named slots.
slotfunction
Creates a named, Schema-decoded mask slot.
Native controls
Checkboxfunction
Binds a native checkbox to a boolean form field.
ColorInputvariable
Binds a native color input to a string field.
DateInputvariable
Binds a native date input to a
Datefield.DateTimeLocalInputvariable
Binds a native local date-time input to a string field.
EmailInputvariable
Binds a native email input to a string field.
HiddenInputvariable
Binds a native hidden input to a string field.
InputComponenttype-alias
Public component contract shared by state-explicit native input factories.
MonthInputvariable
Binds a native month input to a string field.
NumberInputvariable
Binds a native number input to a finite number field.
PasswordInputvariable
Binds a native password input to a string field.
RangeInputvariable
Binds a native range input to a finite number field.
SearchInputvariable
Binds a native search input to a string field.
Selectfunction
Binds a native select element to a string form field.
TelInputvariable
Binds a native telephone input to a string field.
TextInputvariable
Binds a native
input[type=text]to a string field.TimeInputvariable
Binds a native time input to a string field.
UrlInputvariable
Binds a native URL input to a string field.
WeekInputvariable
Binds a native week input to a string field.
Schema-bound components
SchemaBoundCheckboxinterface
Callable schema-bound checkbox constructor.
SchemaBoundComponentResulttype-alias
Fx result of a schema-bound descendant control.
SchemaBoundErrorinterface
Callable schema-bound field-error constructor.
SchemaBoundForminterface
Schema-specialized form API returned by
make.SchemaBoundInputinterface
Callable schema-bound input constructor for fields with one decoded value type.
SchemaBoundMaskedInputinterface
Callable schema-bound input using its selected field’s string codec as a mask.
SchemaBoundPushinterface
Callable schema-bound array append-button constructor.
SchemaBoundRemoveinterface
Callable schema-bound array removal-button constructor.
SchemaBoundResetinterface
Callable schema-bound reset-button constructor.
SchemaBoundRootinterface
Callable root constructor supplied by a schema-bound form API.
SchemaBoundRootResulttype-alias
Fx result of a schema-bound root after it provides
CurrentForminternally.SchemaBoundSelectinterface
Callable schema-bound native select constructor.
makefunction
Binds a native form component family to one Struct codec.
State construction
makeStatefunction
Creates a Scope-owned hydrated form RefSubject from a Struct codec.
State models
FieldMetainterface
Metadata updated after a successful field mutation.
FormFieldstype-alias
Schema field map accepted by the schema-bound form factory.
FormStatetype-alias
Hydrated RefSubject carrying form state plus runtime schema metadata.
InitialStateinterface
Input used to construct a hydrated form state.
Stateinterface
Serializable renderer-independent state of a form.
State transitions
pushValuefunction
Appends one item to an array field and marks it dirty and touched.
removeValuefunction
Removes one item by index from an array field and marks it dirty and touched.
resetfunction
Restores default values and clears errors, metadata, and submitting.
setValuefunction
Assigns one decoded field value and updates dirty/touched metadata.
Validation
validatefunction
Checks retained decoded values against the form codec Type.
type-alias
ArrayFieldNametype-alias
Public type-alias exposed as ArrayFieldName from @typed/ui/Form.
ArrayFieldValuetype-alias
Public type-alias exposed as ArrayFieldValue from @typed/ui/Form.
BooleanFieldNametype-alias
Public type-alias exposed as BooleanFieldName from @typed/ui/Form.
MaskValuetype-alias
Public type-alias exposed as MaskValue from @typed/ui/Form.