Open History to see the last commit
1---
2id: quick-start
3title: Quick Start
4---
5
6TanStack Form is a headless, type-safe form library. It owns form state and
7validation while leaving markup, styling, and component choice to you.
8
9Install the Solid adapter:
10
11```bash
12npm install @tanstack/solid-form
13```
14
15## Create a form
16
17`createForm` requires an options accessor and form-level `defaultValues`. Their
18shape becomes the form's inferred value type.
19
20```tsx
21import { For } from 'solid-js'
22import { createForm } from '@tanstack/solid-form'
23
24export function ProfileForm() {
25 const form = createForm(() => ({
26 defaultValues: {
27 fullName: '',
28 age: 0,
29 },
30 onSubmit: async ({ value }) => {
31 console.log(value)
32 },
33 }))
34
35 return (
36 <form
37 onSubmit={(event) => {
38 event.preventDefault()
39 form.handleSubmit()
40 }}
41 >
42 <form.Field
43 name="fullName"
44 validators={[
45 {
46 triggers: ['change', 'blur'],
47 run: ({ value }) =>
48 value.trim() ? undefined : 'Enter your full name',
49 },
50 ]}
51 >
52 {(field) => (
53 <label>
54 Full name
55 <input
56 name={field().name}
57 value={field().value}
58 onBlur={field().handleBlur}
59 onInput={(event) =>
60 field().handleChange(event.currentTarget.value)
61 }
62 aria-invalid={field().meta.isInvalid}
63 />
64 <For each={field().errors}>
65 {(error) => <span role="alert">{error.message}</span>}
66 </For>
67 </label>
68 )}
69 </form.Field>
70
71 <form.Field
72 name="age"
73 validators={[
74 {
75 triggers: ['change'],
76 run: ({ value }) =>
77 value >= 13 ? undefined : 'You must be at least 13',
78 },
79 ]}
80 >
81 {(field) => (
82 <label>
83 Age
84 <input
85 name={field().name}
86 type="number"
87 value={field().value}
88 onBlur={field().handleBlur}
89 onInput={(event) =>
90 field().handleChange(event.currentTarget.valueAsNumber)
91 }
92 aria-invalid={field().meta.isInvalid}
93 />
94 </label>
95 )}
96 </form.Field>
97
98 <form.Subscribe
99 selector={(state) => [state.canSubmit, state.isSubmitting] as const}
100 >
101 {(state) => (
102 <button type="submit" disabled={!state()[0] || state()[1]}>
103 {state()[1] ? 'Saving…' : 'Save'}
104 </button>
105 )}
106 </form.Subscribe>
107 </form>
108 )
109}
110```
111
112The important pieces are:
113
114- `defaultValues` define the complete initial value and drive type inference.
115- `form.Field` subscribes to one field. Its child receives an accessor that
116 exposes `field().value`, `field().meta`, and event handlers.
117- Validators are ordered objects with a `run` function and explicit `triggers`.
118- `form.Subscribe` exposes the selected form state as a Solid accessor.
119- `form.handleSubmit()` validates the form before calling `onSubmit`.