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

useForm.md

44 lines1010 Bytes

const useForm: UseFormHook<DefaultReactFormComponentMap>;

Defined in: packages/react-form/src/ReactForm/useForm.public.ts:62

Creates a React form whose instance and lifecycle are owned by the current component.

defaultValues establish the initial state and inferred form value type. Later renders apply changed options to the same form instance, and unmounting the component cleans it up.

Call this hook at the top level of a React component or custom hook.

Example

function ProfileForm() {
  const form = useForm({
    defaultValues: { name: '' },
    onSubmit: ({ value }) => saveProfile(value),
  })

  return (
    <form
      onSubmit={(event) => {
        event.preventDefault()
        void form.handleSubmit()
      }}
    />
  )
}

Returns

The React form API with typed field, subscription, and form-group components attached.