Skip to content

Commit 1ea8e9b

Browse files
ci: apply automated fixes and generate docs
1 parent 77c6ad1 commit 1ea8e9b

38 files changed

+1394
-115
lines changed

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

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: createFormHook
1111
function createFormHook<TComponents, TFormComponents>(__namedParameters): object
1212
```
1313

14-
Defined in: [packages/react-form/src/createFormHook.tsx:223](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L223)
14+
Defined in: [packages/react-form/src/createFormHook.tsx:266](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L266)
1515

1616
## Type Parameters
1717

@@ -67,6 +67,66 @@ useAppForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsy
6767

6868
`AppFieldExtendedReactFormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>
6969

70+
### withFieldGroup()
71+
72+
```ts
73+
withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters) => <TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TFormSubmitMeta>(params) => Element;
74+
```
75+
76+
#### Type Parameters
77+
78+
**TFieldGroupData**
79+
80+
**TSubmitMeta**
81+
82+
**TRenderProps** *extends* `Record`\<`string`, `unknown`\> = \{\}
83+
84+
#### Parameters
85+
86+
##### \_\_namedParameters
87+
88+
[`WithFormLensProps`](../../interfaces/withformlensprops.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\>
89+
90+
#### Returns
91+
92+
`Function`
93+
94+
##### Type Parameters
95+
96+
**TFormData**
97+
98+
**TFields** *extends*
99+
\| `string`
100+
\| \{ \[K in string \| number \| symbol\]: DeepKeysOfType\<TFormData, TFieldGroupData\[K\]\> \}
101+
102+
• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
103+
104+
• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
105+
106+
• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
107+
108+
• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
109+
110+
• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
111+
112+
• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
113+
114+
• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
115+
116+
• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
117+
118+
• **TFormSubmitMeta**
119+
120+
##### Parameters
121+
122+
###### params
123+
124+
`PropsWithChildren`\<`NoInfer`\<`TRenderProps`\> & `object`\>
125+
126+
##### Returns
127+
128+
`Element`
129+
70130
### withForm()
71131

72132
```ts

docs/framework/react/reference/functions/createformhookcontexts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: createFormHookContexts
1111
function createFormHookContexts(): object
1212
```
1313

14-
Defined in: [packages/react-form/src/createFormHook.tsx:53](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L53)
14+
Defined in: [packages/react-form/src/createFormHook.tsx:58](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L58)
1515

1616
## Returns
1717

docs/framework/react/reference/functions/field.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: Field
1111
function Field<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TPatentSubmitMeta>(__namedParameters): ReactNode
1212
```
1313

14-
Defined in: [packages/react-form/src/useField.tsx:428](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L428)
14+
Defined in: [packages/react-form/src/useField.tsx:477](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L477)
1515

1616
A function component that takes field options and a render function as children and returns a React component.
1717

docs/framework/react/reference/functions/useform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: useForm
1111
function useForm<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>(opts?): ReactFormExtendedApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>
1212
```
1313

14-
Defined in: [packages/react-form/src/useForm.tsx:142](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L142)
14+
Defined in: [packages/react-form/src/useForm.tsx:143](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L143)
1515

1616
A custom React Hook that returns an extended instance of the `FormApi` class.
1717

docs/framework/react/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ title: "@tanstack/react-form"
1010
## Interfaces
1111

1212
- [ReactFormApi](../interfaces/reactformapi.md)
13+
- [WithFormLensProps](../interfaces/withformlensprops.md)
1314
- [WithFormProps](../interfaces/withformprops.md)
1415

1516
## Type Aliases

docs/framework/react/reference/interfaces/reactformapi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: ReactFormApi
77

88
# Interface: ReactFormApi\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta\>
99

10-
Defined in: [packages/react-form/src/useForm.tsx:21](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L21)
10+
Defined in: [packages/react-form/src/useForm.tsx:22](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L22)
1111

1212
Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned from `useForm`
1313

@@ -41,7 +41,7 @@ Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned
4141
Field: FieldComponent<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>;
4242
```
4343

44-
Defined in: [packages/react-form/src/useForm.tsx:36](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L36)
44+
Defined in: [packages/react-form/src/useForm.tsx:37](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L37)
4545

4646
A React component to render form fields. With this, you can render and manage individual form fields.
4747

@@ -53,7 +53,7 @@ A React component to render form fields. With this, you can render and manage in
5353
Subscribe: <TSelected>(props) => ReactNode;
5454
```
5555

56-
Defined in: [packages/react-form/src/useForm.tsx:51](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L51)
56+
Defined in: [packages/react-form/src/useForm.tsx:52](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L52)
5757

5858
A `Subscribe` function that allows you to listen and react to changes in the form's state. It's especially useful when you need to execute side effects or render specific components in response to state updates.
5959

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
id: WithFormLensProps
3+
title: WithFormLensProps
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: WithFormLensProps\<TFieldGroupData, TFieldComponents, TFormComponents, TSubmitMeta, TRenderProps\>
9+
10+
Defined in: [packages/react-form/src/createFormHook.tsx:231](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L231)
11+
12+
## Extends
13+
14+
- `BaseFormOptions`\<`TFieldGroupData`, `TSubmitMeta`\>
15+
16+
## Type Parameters
17+
18+
**TFieldGroupData**
19+
20+
**TFieldComponents** *extends* `Record`\<`string`, `ComponentType`\<`any`\>\>
21+
22+
**TFormComponents** *extends* `Record`\<`string`, `ComponentType`\<`any`\>\>
23+
24+
**TSubmitMeta**
25+
26+
**TRenderProps** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `never`\>
27+
28+
## Properties
29+
30+
### props?
31+
32+
```ts
33+
optional props: TRenderProps;
34+
```
35+
36+
Defined in: [packages/react-form/src/createFormHook.tsx:239](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L239)
37+
38+
***
39+
40+
### render()
41+
42+
```ts
43+
render: (props) => Element;
44+
```
45+
46+
Defined in: [packages/react-form/src/createFormHook.tsx:240](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L240)
47+
48+
#### Parameters
49+
50+
##### props
51+
52+
`PropsWithChildren`\<`NoInfer`\<`TRenderProps`\> & `object`\>
53+
54+
#### Returns
55+
56+
`Element`

docs/framework/react/reference/interfaces/withformprops.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: WithFormProps
77

88
# Interface: WithFormProps\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta, TFieldComponents, TFormComponents, TRenderProps\>
99

10-
Defined in: [packages/react-form/src/createFormHook.tsx:173](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L173)
10+
Defined in: [packages/react-form/src/createFormHook.tsx:181](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L181)
1111

1212
## Extends
1313

@@ -49,7 +49,7 @@ Defined in: [packages/react-form/src/createFormHook.tsx:173](https://github.com/
4949
optional props: TRenderProps;
5050
```
5151

52-
Defined in: [packages/react-form/src/createFormHook.tsx:200](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L200)
52+
Defined in: [packages/react-form/src/createFormHook.tsx:208](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L208)
5353

5454
***
5555

@@ -59,7 +59,7 @@ Defined in: [packages/react-form/src/createFormHook.tsx:200](https://github.com/
5959
render: (props) => Element;
6060
```
6161

62-
Defined in: [packages/react-form/src/createFormHook.tsx:201](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L201)
62+
Defined in: [packages/react-form/src/createFormHook.tsx:209](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L209)
6363

6464
#### Parameters
6565

docs/framework/react/reference/type-aliases/reactformextendedapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: ReactFormExtendedApi
1111
type ReactFormExtendedApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta> = FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta> & ReactFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>;
1212
```
1313

14-
Defined in: [packages/react-form/src/useForm.tsx:88](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L88)
14+
Defined in: [packages/react-form/src/useForm.tsx:89](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L89)
1515

1616
An extended version of the `FormApi` class that includes React-specific functionalities from `ReactFormApi`
1717

0 commit comments

Comments
 (0)