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

FieldGroupApi.md

60 lines1.5 KB

1---
2id: FieldGroupApi
3title: FieldGroupApi
4---
5​
6Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:74](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L74)
7​
8## Extends
9​
10- `FormApiFieldMethods`\<`TFieldData`\>.`FormApiArrayMethods`\<`TFieldData`\>
11​
12## Type Parameters
13​
14### TFieldData
15​
16`TFieldData`
17​
18### TFieldComponents
19​
20`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> = `Record`\<`never`, `never`\>
21​
22## Properties
23​
24### ArrayField
25​
26```ts
27ArrayField: FieldGroupArrayFieldComponent<TFieldData, TFieldComponents>;
28```
29​
30Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L82)
31​
32***
33​
34### atom
35​
36```ts
37atom: ReadonlyAtom<TFieldData>;
38```
39​
40Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:80](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L80)
41​
42***
43​
44### Field
45​
46```ts
47Field: FieldGroupFieldComponent<TFieldData, TFieldComponents>;
48```
49​
50Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:81](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L81)
51​
52***
53​
54### Subscribe
55​
56```ts
57Subscribe: FieldGroupSubscribeComponent;
58```
59​
60Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:83](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L83)