Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

getFormHookHelpers.md

45 lines1.2 KB

function getFormHookHelpers(): FormHookHelpers;

Defined in: packages/react-form/src/AppForm/getFormHookHelpers.public.ts:268

Creates helpers that make React field components value-aware for createFormHook.

fieldComponent injects the current App Form field API into a selected prop. fieldBrand only adds compile-time field-value compatibility and returns the original component at runtime.

Returns

FormHookHelpers

Example

import { createFormHook, getFormHookHelpers } from '@tanstack/react-form'
import type { FieldWithValue } from '@tanstack/react-form'

function TextInput({ field }: { field: FieldWithValue<string> }) {
  return (
    <input
      value={field.value}
      onChange={(event) => field.handleChange(event.target.value)}
    />
  )
}

const { fieldComponent } = getFormHookHelpers()
const TextField = fieldComponent.strict(TextInput, 'field')

export const { useAppForm } = createFormHook({
  fieldComponents: { TextField },
  formComponents: {},
})