tanstack-form
Original:🇺🇸 English
Translated
TanStack Form best practices for type-safe form management, validation, field composition, and submission handling in React. Use when building forms with complex validation, integrating schema libraries (Zod/Valibot/ArkType), composing reusable form components, managing array/dynamic fields, or integrating with meta-frameworks (TanStack Start, Next.js, Remix).
1installs
Sourcefellipeutaka/leon
Added on
NPX Install
npx skill4agent add fellipeutaka/leon tanstack-formTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →TanStack Form
Version: @tanstack/react-form@latest
Requires: React 18.0+, TypeScript 5.0+
Quick Setup
bash
npm install @tanstack/react-formtsx
import { useForm } from '@tanstack/react-form'
function App() {
const form = useForm({
defaultValues: {
firstName: '',
lastName: '',
},
onSubmit: async ({ value }) => {
console.log(value)
},
})
return (
<form
onSubmit={(e) => {
e.preventDefault()
e.stopPropagation()
form.handleSubmit()
}}
>
<form.Field
name="firstName"
validators={{
onChange: ({ value }) =>
!value ? 'Required' : value.length < 3 ? 'Too short' : undefined,
}}
children={(field) => (
<>
<input
value={field.state.value}
onBlur={field.handleBlur}
onChange={(e) => field.handleChange(e.target.value)}
/>
{!field.state.meta.isValid && (
<em>{field.state.meta.errors.join(', ')}</em>
)}
</>
)}
/>
<form.Subscribe
selector={(state) => [state.canSubmit, state.isSubmitting]}
children={([canSubmit, isSubmitting]) => (
<button type="submit" disabled={!canSubmit}>
{isSubmitting ? '...' : 'Submit'}
</button>
)}
/>
</form>
)
}Production Setup (Recommended)
For production apps, use to pre-bind reusable UI components and reduce boilerplate:
createFormHooktsx
import { createFormHookContexts, createFormHook } from '@tanstack/react-form'
import { TextField, NumberField, SubmitButton } from '~/ui-library'
const { fieldContext, formContext } = createFormHookContexts()
export const { useAppForm } = createFormHook({
fieldComponents: { TextField, NumberField },
formComponents: { SubmitButton },
fieldContext,
formContext,
})Devtools
bash
npm install -D @tanstack/react-devtools @tanstack/react-form-devtoolstsx
import { TanStackDevtools } from '@tanstack/react-devtools'
import { formDevtoolsPlugin } from '@tanstack/react-form-devtools'
<TanStackDevtools
config={{ hideUntilHover: true }}
plugins={[formDevtoolsPlugin()]}
/>Rule Categories
| Priority | Category | Rule File | Impact |
|---|---|---|---|
| CRITICAL | Form Setup | | Correct form creation and type inference |
| CRITICAL | Validation | | Prevents invalid submissions and poor UX |
| CRITICAL | Schema Validation | | Type-safe validation with Zod/Valibot/ArkType |
| HIGH | Form Composition | | Reduces boilerplate, enables reusable components |
| HIGH | Field State | | Correct state access and reactivity |
| HIGH | Array Fields | | Dynamic list management |
| HIGH | Linked Fields | | Cross-field validation (e.g. confirm password) |
| MEDIUM | Listeners | | Side effects on field events |
| MEDIUM | Submission | | Correct submit handling and meta passing |
| MEDIUM | SSR / Meta-Frameworks | | Server validation with Start/Next.js/Remix |
| LOW | UI Libraries | | Headless integration with component libraries |
Critical Rules
Always Do
- Type from defaultValues — never pass generics to , let TS infer from
useForm<T>()defaultValues - Prevent default on submit —
e.preventDefault(); e.stopPropagation(); form.handleSubmit() - Use render prop —
childrenuses render props viaform.Fieldchildren={(field) => ...} - Use with selector — subscribe to specific state slices to avoid re-renders
form.Subscribe - Use with selector —
useStorenotuseStore(form.store, (s) => s.values.name)useStore(form.store) - Use in production — pre-bind components for consistency and less boilerplate
createFormHook - Debounce async validators — set or
onChangeAsyncDebounceMsasyncDebounceMs
Never Do
- Pass generics — breaks the design; use typed
useForm<MyType>()insteaddefaultValues - Skip — native form submission will bypass TanStack Form's handling
e.preventDefault() - Use for reactivity — use
useFieldoruseStore(form.store)insteadform.Subscribe - Omit selector in — causes full re-render on every state change
useStore - Use without
type="reset"— native reset bypasses TanStack Form; usee.preventDefault()explicitlyform.reset() - Expect transformed values in — Standard Schema transforms aren't applied; parse manually in
onSubmitonSubmit
Key Patterns
tsx
// Schema validation (form-level with Zod)
const form = useForm({
defaultValues: { age: 0, name: '' },
validators: {
onChange: z.object({ age: z.number().min(13), name: z.string().min(1) }),
},
onSubmit: ({ value }) => console.log(value),
})
// Array fields
<form.Field name="hobbies" mode="array" children={(field) => (
<div>
{field.state.value.map((_, i) => (
<form.Field key={i} name={`hobbies[${i}].name`} children={(sub) => (
<input value={sub.state.value} onChange={(e) => sub.handleChange(e.target.value)} />
)} />
))}
<button type="button" onClick={() => field.pushValue({ name: '' })}>Add</button>
</div>
)} />
// Linked fields (confirm password)
<form.Field name="confirm_password" validators={{
onChangeListenTo: ['password'],
onChange: ({ value, fieldApi }) =>
value !== fieldApi.form.getFieldValue('password') ? 'Passwords do not match' : undefined,
}} children={(field) => <input value={field.state.value} onChange={(e) => field.handleChange(e.target.value)} />} />
// Listeners (reset province when country changes)
<form.Field name="country" listeners={{
onChange: ({ value }) => { form.setFieldValue('province', '') },
}} children={(field) => <input value={field.state.value} onChange={(e) => field.handleChange(e.target.value)} />} />
// Form composition with withForm
const ChildForm = withForm({
defaultValues: { firstName: '', lastName: '' },
render: function Render({ form }) {
return <form.AppField name="firstName" children={(field) => <field.TextField label="First Name" />} />
},
})