Open History to see the last commit
1---
2id: FieldApiOptions
3title: FieldApiOptions
4---
5β
6Defined in: [FieldApi/FieldApi.public.ts:221](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L221)
7β
8## Type Parameters
9β
10### TFieldData
11β
12`TFieldData`
13β
14### TFieldName
15β
16`TFieldName`
17β
18### TFieldValue
19β
20`TFieldValue`
21β
22### TFieldValidators
23β
24`TFieldValidators` *extends* [`FieldValidators`](../type-aliases/FieldValidators.md)\<`TFieldData`, `TFieldName`, `TFieldValue`\>
25β
26### TGroupFieldError
27β
28`TGroupFieldError`
29β
30### TFormData
31β
32`TFormData`
33β
34### TFormErrorTypes
35β
36`TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md)
37β
38## Properties
39β
40### errorBoundary?
41β
42```ts
43optional errorBoundary?: boolean;
44```
45β
46Defined in: [FieldApi/FieldApi.public.ts:239](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L239)
47β
48Route descendant field errors from form and form group validators to this field.
49β
50***
51β
52### errorVisibility?
53β
54```ts
55optional errorVisibility?: ErrorVisibility<TFormData, TFormErrorTypes>;
56```
57β
58Defined in: [FieldApi/FieldApi.public.ts:235](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L235)
59β
60***
61β
62### listeners?
63β
64```ts
65optional listeners?: FieldListeners<TFieldData, TFieldName, TFieldValue, FallbackToValidationIssue<
66 | ExtractValidatorFieldError<NoInfer<TFieldValidators>, FieldValidators<any, any, any>>
67 | unknown extends TGroupFieldError ? never : TGroupFieldError
68| ExtractFormFieldError<TFormErrorTypes>>, TFormData, TFormErrorTypes>;
69```
70β
71Defined in: [FieldApi/FieldApi.public.ts:241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L241)
72β
73***
74β
75### name
76β
77```ts
78name: TFieldName;
79```
80β
81Defined in: [FieldApi/FieldApi.public.ts:234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L234)
82β
83***
84β
85### validators?
86β
87```ts
88optional validators?: TFieldValidators;
89```
90β
91Defined in: [FieldApi/FieldApi.public.ts:240](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L240)