Module / v1.0.0-beta.7

@typed/ui/Form

96 unique exports available through this public import path, including their members and aliases.

Learn this UI primitive →

import * as Form from "@typed/ui/Form";

Browser form data

  • FormDataRecord

    type-alias

    Object representation of native FormData, preserving repeated names as arrays.

  • FormDataValue

    type-alias

    Native value emitted by FormData.

  • decodeFormData

    function

    Decodes native FormData through an Effect Schema codec.

  • formDataToRecord

    function

    Converts native form data to a record, preserving repeated names as arrays.

Component options

Field relationships

  • Description

    function

    Renders visible explanatory content in a neutral div.

  • DescriptionOptions

    interface

    Options for descriptive form content.

  • Error

    function

    Renders the named field message with a generated ID and alert role.

  • ErrorOptions

    interface

    Options for a field validation alert.

  • Group

    function

    Renders an ARIA group with an optional accessible name.

  • GroupOptions

    interface

    Options for an accessible group of form controls.

  • Label

    function

    Renders a native label with an explicit control relationship.

  • LabelOptions

    interface

    Options for a native form label.

Field types

  • FieldNameFor

    type-alias

    Field names whose decoded value is assignable to Value.

  • SchemaFieldNameFor

    type-alias

    Struct field names matching both decoded and encoded control value types.

Form actions

  • Push

    function

    Renders a button that appends one item to an array field.

  • Remove

    function

    Renders a button that removes one array item by index.

  • Reset

    function

    Renders a native reset button that restores Typed form defaults.

  • Submit

    function

    Renders a native type=submit button.

Form context

  • CurrentForm

    variable

    Effect context service used by schema-bound form controls.

  • FormService

    interface

    Context service exposed to schema-bound descendant controls.

Form roots

  • BoundFormOptions

    interface

    Options accepted by a schema-bound form root.

  • Form

    function

    Renders a native form and provides its state to bound descendants.

  • FormOptions

    interface

    Options for the state-explicit form root.

  • ValidSubmitHandler

    type-alias

    Handler invoked only after whole-form Schema validation succeeds.

Hydration schemas

  • StateSchema

    function

    Builds the serializable schema for a form’s hydrated state.

Input codecs

  • MaskPart

    type-alias

    Literal or decoded segment of a mask.

  • MaskSlot

    interface

    Named decoded segment in a bidirectional text mask.

  • MaskedInput

    function

    Binds a native text input to a structured mask value.

  • MaskedInputOptions

    interface

    Options for an input decoded through a structured mask codec.

  • mask

    function

    Builds a bidirectional Schema codec from literal text and named slots.

  • slot

    function

    Creates a named, Schema-decoded mask slot.

Native controls

  • Checkbox

    function

    Binds a native checkbox to a boolean form field.

  • ColorInput

    variable

    Binds a native color input to a string field.

  • DateInput

    variable

    Binds a native date input to a Date field.

  • DateTimeLocalInput

    variable

    Binds a native local date-time input to a string field.

  • EmailInput

    variable

    Binds a native email input to a string field.

  • HiddenInput

    variable

    Binds a native hidden input to a string field.

  • InputComponent

    type-alias

    Public component contract shared by state-explicit native input factories.

  • MonthInput

    variable

    Binds a native month input to a string field.

  • NumberInput

    variable

    Binds a native number input to a finite number field.

  • PasswordInput

    variable

    Binds a native password input to a string field.

  • RangeInput

    variable

    Binds a native range input to a finite number field.

  • SearchInput

    variable

    Binds a native search input to a string field.

  • Select

    function

    Binds a native select element to a string form field.

  • TelInput

    variable

    Binds a native telephone input to a string field.

  • TextInput

    variable

    Binds a native input[type=text] to a string field.

  • TimeInput

    variable

    Binds a native time input to a string field.

  • UrlInput

    variable

    Binds a native URL input to a string field.

  • WeekInput

    variable

    Binds a native week input to a string field.

Schema-bound components

State construction

  • makeState

    function

    Creates a Scope-owned hydrated form RefSubject from a Struct codec.

State models

  • FieldMeta

    interface

    Metadata updated after a successful field mutation.

  • FormFields

    type-alias

    Schema field map accepted by the schema-bound form factory.

  • FormState

    type-alias

    Hydrated RefSubject carrying form state plus runtime schema metadata.

  • InitialState

    interface

    Input used to construct a hydrated form state.

  • State

    interface

    Serializable renderer-independent state of a form.

State transitions

  • pushValue

    function

    Appends one item to an array field and marks it dirty and touched.

  • removeValue

    function

    Removes one item by index from an array field and marks it dirty and touched.

  • reset

    function

    Restores default values and clears errors, metadata, and submitting.

  • setValue

    function

    Assigns one decoded field value and updates dirty/touched metadata.

Validation

  • validate

    function

    Checks retained decoded values against the form codec Type.

type-alias

  • ArrayFieldName

    type-alias

    Public type-alias exposed as ArrayFieldName from @typed/ui/Form.

  • ArrayFieldValue

    type-alias

    Public type-alias exposed as ArrayFieldValue from @typed/ui/Form.

  • BooleanFieldName

    type-alias

    Public type-alias exposed as BooleanFieldName from @typed/ui/Form.

  • MaskValue

    type-alias

    Public type-alias exposed as MaskValue from @typed/ui/Form.