Skip to content

Commit cc0aee9

Browse files
autofix-ci[bot]autofix-ci[bot]
authored
ci: apply automated fixes and generate docs
1 parent 26921bb commit cc0aee9

File tree

16 files changed

+436
-10
lines changed

16 files changed

+436
-10
lines changed

‎docs/framework/react/reference/functions/createformhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters)
8585

8686
##### \_\_namedParameters
8787

88-
[`WithFormLensProps`](../../interfaces/withformlensprops.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\>
88+
[`WithFieldGroupProps`](../../interfaces/withfieldgroupprops.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\>
8989

9090
#### Returns
9191

‎docs/framework/react/reference/functions/usefield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ A hook for managing a field in a form.
5959

6060
### opts
6161

62-
`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`\>
62+
[`UseFieldOptions`](../../interfaces/usefieldoptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`\>
6363

6464
An object with field options.
6565

‎docs/framework/react/reference/functions/usefieldgroup.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
id: useFieldGroup
3+
title: useFieldGroup
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Function: useFieldGroup()
9+
10+
```ts
11+
function useFieldGroup<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TComponents, TFormComponents, TSubmitMeta>(opts): AppFieldExtendedReactFieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>
12+
```
13+
14+
Defined in: [packages/react-form/src/useFieldGroup.tsx:85](https://github.com/TanStack/form/blob/main/packages/react-form/src/useFieldGroup.tsx#L85)
15+
16+
## Type Parameters
17+
18+
• **TFormData**
19+
20+
• **TFieldGroupData**
21+
22+
• **TFields** *extends*
23+
\| `string`
24+
\| \{ \[K in string \| number \| symbol\]: DeepKeysOfType\<TFormData, TFieldGroupData\[K\]\> \}
25+
26+
• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
27+
28+
• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
29+
30+
• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
31+
32+
• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
33+
34+
• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
35+
36+
• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
37+
38+
• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
39+
40+
• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
41+
42+
• **TComponents** *extends* `Record`\<`string`, `ComponentType`\<`any`\>\>
43+
44+
• **TFormComponents** *extends* `Record`\<`string`, `ComponentType`\<`any`\>\>
45+
46+
• **TSubmitMeta** = `never`
47+
48+
## Parameters
49+
50+
### opts
51+
52+
#### defaultValues?
53+
54+
`TFieldGroupData`
55+
56+
#### fields
57+
58+
`TFields`
59+
60+
#### form
61+
62+
\| `AppFieldExtendedReactFormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>
63+
\| `AppFieldExtendedReactFieldGroupApi`\<`unknown`, `TFormData`, `string` \| `FieldsMap`\<`unknown`, `TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>
64+
65+
#### formComponents
66+
67+
`TFormComponents`
68+
69+
#### onSubmitMeta?
70+
71+
`TSubmitMeta`
72+
73+
## Returns
74+
75+
`AppFieldExtendedReactFieldGroupApi`\<`TFormData`, `TFieldGroupData`, `TFields`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>

‎docs/framework/react/reference/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@ title: "@tanstack/react-form"
1010
## Interfaces
1111

1212
- [ReactFormApi](../interfaces/reactformapi.md)
13-
- [WithFormLensProps](../interfaces/withformlensprops.md)
13+
- [UseFieldOptions](../interfaces/usefieldoptions.md)
14+
- [UseFieldOptionsBound](../interfaces/usefieldoptionsbound.md)
15+
- [WithFieldGroupProps](../interfaces/withfieldgroupprops.md)
1416
- [WithFormProps](../interfaces/withformprops.md)
1517

1618
## Type Aliases
1719

1820
- [FieldComponent](../type-aliases/fieldcomponent.md)
21+
- [LensFieldComponent](../type-aliases/lensfieldcomponent.md)
1922
- [ReactFormExtendedApi](../type-aliases/reactformextendedapi.md)
2023
- [UseField](../type-aliases/usefield.md)
2124

@@ -25,6 +28,7 @@ title: "@tanstack/react-form"
2528
- [createFormHookContexts](../functions/createformhookcontexts.md)
2629
- [Field](../functions/field.md)
2730
- [useField](../functions/usefield.md)
31+
- [useFieldGroup](../functions/usefieldgroup.md)
2832
- [useForm](../functions/useform.md)
2933
- [useStore](../functions/usestore.md)
3034
- [useTransform](../functions/usetransform.md)

‎docs/framework/react/reference/interfaces/usefieldoptions.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
id: UseFieldOptions
3+
title: UseFieldOptions
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: UseFieldOptions\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta\>
9+
10+
Defined in: [packages/react-form/src/types.ts:19](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L19)
11+
12+
The field options.
13+
14+
## Extends
15+
16+
- `FieldApiOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\>.`FieldOptionsMode`
17+
18+
## Type Parameters
19+
20+
• **TParentData**
21+
22+
• **TName** *extends* `DeepKeys`\<`TParentData`\>
23+
24+
• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\>
25+
26+
• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
27+
28+
• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
29+
30+
• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
31+
32+
• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
33+
34+
• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
35+
36+
• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
37+
38+
• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
39+
40+
• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
41+
42+
• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
43+
44+
• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
45+
46+
• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
47+
48+
• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
49+
50+
• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
51+
52+
• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
53+
54+
• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
55+
56+
• **TSubmitMeta**
57+
58+
## Properties
59+
60+
### mode?
61+
62+
```ts
63+
optional mode: "value" | "array";
64+
```
65+
66+
Defined in: [packages/react-form/src/types.ts:13](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L13)
67+
68+
#### Inherited from
69+
70+
```ts
71+
FieldOptionsMode.mode
72+
```

‎docs/framework/react/reference/interfaces/usefieldoptionsbound.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
id: UseFieldOptionsBound
3+
title: UseFieldOptionsBound
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: UseFieldOptionsBound\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync\>
9+
10+
Defined in: [packages/react-form/src/types.ts:68](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L68)
11+
12+
## Extends
13+
14+
- `FieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`\>.`FieldOptionsMode`
15+
16+
## Type Parameters
17+
18+
• **TParentData**
19+
20+
• **TName** *extends* `DeepKeys`\<`TParentData`\>
21+
22+
• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\>
23+
24+
• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
25+
26+
• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
27+
28+
• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
29+
30+
• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
31+
32+
• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
33+
34+
• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
35+
36+
• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
37+
38+
## Properties
39+
40+
### mode?
41+
42+
```ts
43+
optional mode: "value" | "array";
44+
```
45+
46+
Defined in: [packages/react-form/src/types.ts:13](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L13)
47+
48+
#### Inherited from
49+
50+
```ts
51+
FieldOptionsMode.mode
52+
```

‎docs/framework/react/reference/interfaces/withformlensprops.md renamed to ‎docs/framework/react/reference/interfaces/withfieldgroupprops.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
id: WithFormLensProps
3-
title: WithFormLensProps
2+
id: WithFieldGroupProps
3+
title: WithFieldGroupProps
44
---
55

66
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
77

8-
# Interface: WithFormLensProps\<TFieldGroupData, TFieldComponents, TFormComponents, TSubmitMeta, TRenderProps\>
8+
# Interface: WithFieldGroupProps\<TFieldGroupData, TFieldComponents, TFormComponents, TSubmitMeta, TRenderProps\>
99

1010
Defined in: [packages/react-form/src/createFormHook.tsx:229](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L229)
1111

‎docs/framework/react/reference/type-aliases/lensfieldcomponent.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
id: LensFieldComponent
3+
title: LensFieldComponent
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Type Alias: LensFieldComponent()\<TLensData, TParentSubmitMeta, ExtendedApi\>
9+
10+
```ts
11+
type LensFieldComponent<TLensData, TParentSubmitMeta, ExtendedApi> = <TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>({
12+
children,
13+
...fieldOptions
14+
}) => ReactNode;
15+
```
16+
17+
Defined in: [packages/react-form/src/useField.tsx:426](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L426)
18+
19+
A type alias representing a field component for a form lens data type.
20+
21+
## Type Parameters
22+
23+
• **TLensData**
24+
25+
• **TParentSubmitMeta**
26+
27+
• **ExtendedApi** = \{\}
28+
29+
## Type Parameters
30+
31+
• **TName** *extends* `DeepKeys`\<`TLensData`\>
32+
33+
• **TData** *extends* `DeepValue`\<`TLensData`, `TName`\>
34+
35+
• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`unknown`, `string`, `TData`\>
36+
37+
• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`unknown`, `string`, `TData`\>
38+
39+
• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`unknown`, `string`, `TData`\>
40+
41+
• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`unknown`, `string`, `TData`\>
42+
43+
• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`unknown`, `string`, `TData`\>
44+
45+
• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`unknown`, `string`, `TData`\>
46+
47+
• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`unknown`, `string`, `TData`\>
48+
49+
## Parameters
50+
51+
### \{
52+
children,
53+
...fieldOptions
54+
\}
55+
56+
`FieldComponentBoundProps`\<`unknown`, `string`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `undefined` \| `FormValidateOrFn`\<`unknown`\>, `undefined` \| `FormValidateOrFn`\<`unknown`\>, `undefined` \| `FormAsyncValidateOrFn`\<`unknown`\>, `undefined` \| `FormValidateOrFn`\<`unknown`\>, `undefined` \| `FormAsyncValidateOrFn`\<`unknown`\>, `undefined` \| `FormValidateOrFn`\<`unknown`\>, `undefined` \| `FormAsyncValidateOrFn`\<`unknown`\>, `undefined` \| `FormAsyncValidateOrFn`\<`unknown`\>, `TParentSubmitMeta`, `ExtendedApi`\> & `object`
57+
58+
## Returns
59+
60+
`ReactNode`

‎docs/framework/react/reference/type-aliases/usefield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ A function that takes an optional object with a `name` property and field option
6363

6464
### opts
6565

66-
`UseFieldOptionsBound`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`\>
66+
[`UseFieldOptionsBound`](../../interfaces/usefieldoptionsbound.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`\>
6767

6868
## Returns
6969

‎docs/framework/solid/reference/functions/createfield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Defined in: [packages/solid-form/src/createField.tsx:222](https://github.com/Tan
5757

5858
### opts
5959

60-
() => `CreateFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>
60+
() => [`CreateFieldOptions`](../../interfaces/createfieldoptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>
6161

6262
## Returns
6363

0 commit comments

Comments
 (0)