Skip to content

Commit a298ff3

Browse files
ci: apply automated fixes and generate docs
1 parent 4cd4068 commit a298ff3

File tree

10 files changed

+29
-59
lines changed

10 files changed

+29
-59
lines changed

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

Lines changed: 5 additions & 15 deletions
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:290](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L290)
14+
Defined in: [packages/react-form/src/createFormHook.tsx:293](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L293)
1515

1616
## Type Parameters
1717

@@ -74,7 +74,7 @@ useAppForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsy
7474
### withFieldGroup()
7575

7676
```ts
77-
withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters) => <TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TFormSubmitMeta>(params) => ReactNode;
77+
withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters) => <TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TFormSubmitMeta>(params) => ReactNode | Promise<ReactNode>;
7878
```
7979

8080
#### Type Parameters
@@ -133,12 +133,12 @@ withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters)
133133

134134
##### Returns
135135

136-
`ReactNode`
136+
`ReactNode` \| `Promise`\<`ReactNode`\>
137137

138138
### withForm()
139139

140140
```ts
141-
withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TRenderProps>(__namedParameters) => (props) => ReactNode;
141+
withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TRenderProps>(__namedParameters) => FunctionComponent<PropsWithChildren<NoInfer<UnwrapOrAny<TRenderProps>> & object>>;
142142
```
143143
144144
#### Type Parameters
@@ -177,14 +177,4 @@ withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync
177177
178178
#### Returns
179179
180-
`Function`
181-
182-
##### Parameters
183-
184-
###### props
185-
186-
`PropsWithChildren`\<`NoInfer`\<`UnwrapOrAny`\<`TRenderProps`\>\> & `object`\>
187-
188-
##### Returns
189-
190-
`ReactNode`
180+
`FunctionComponent`\<`PropsWithChildren`\<`NoInfer`\<`UnwrapOrAny`\<`TRenderProps`\>\> & `object`\>\>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Field
88
# Function: Field()
99

1010
```ts
11-
function Field<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TPatentSubmitMeta>(__namedParameters): ReactNode
11+
function Field<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TPatentSubmitMeta>(__namedParameters): ReactNode | Promise<ReactNode>
1212
```
1313

1414
Defined in: [packages/react-form/src/useField.tsx:594](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L594)
@@ -73,4 +73,4 @@ The `Field` component uses the `useField` hook internally to manage the field in
7373

7474
## Returns
7575

76-
`ReactNode`
76+
`ReactNode` \| `Promise`\<`ReactNode`\>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: useFieldGroup
1111
function useFieldGroup<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TComponents, TFormComponents, TSubmitMeta>(opts): AppFieldExtendedReactFieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>
1212
```
1313

14-
Defined in: [packages/react-form/src/useFieldGroup.tsx:91](https://github.com/TanStack/form/blob/main/packages/react-form/src/useFieldGroup.tsx#L91)
14+
Defined in: [packages/react-form/src/useFieldGroup.tsx:96](https://github.com/TanStack/form/blob/main/packages/react-form/src/useFieldGroup.tsx#L96)
1515

1616
## Type Parameters
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, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts?): ReactFormExtendedApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
1212
```
1313

14-
Defined in: [packages/react-form/src/useForm.tsx:158](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L158)
14+
Defined in: [packages/react-form/src/useForm.tsx:163](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L163)
1515

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

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

Lines changed: 5 additions & 5 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, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
99

10-
Defined in: [packages/react-form/src/useForm.tsx:23](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L23)
10+
Defined in: [packages/react-form/src/useForm.tsx:28](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L28)
1111

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

@@ -45,7 +45,7 @@ Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned
4545
Field: FieldComponent<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
4646
```
4747

48-
Defined in: [packages/react-form/src/useForm.tsx:40](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L40)
48+
Defined in: [packages/react-form/src/useForm.tsx:45](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L45)
4949

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

@@ -54,10 +54,10 @@ A React component to render form fields. With this, you can render and manage in
5454
### Subscribe()
5555

5656
```ts
57-
Subscribe: <TSelected>(props) => ReactNode;
57+
Subscribe: <TSelected>(props) => ReactNode | Promise<ReactNode>;
5858
```
5959

60-
Defined in: [packages/react-form/src/useForm.tsx:57](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L57)
60+
Defined in: [packages/react-form/src/useForm.tsx:62](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L62)
6161

6262
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.
6363

@@ -79,4 +79,4 @@ A `Subscribe` function that allows you to listen and react to changes in the for
7979

8080
#### Returns
8181

82-
`ReactNode`
82+
`ReactNode` \| `Promise`\<`ReactNode`\>

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

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: WithFieldGroupProps
77

88
# Interface: WithFieldGroupProps\<TFieldGroupData, TFieldComponents, TFormComponents, TSubmitMeta, TRenderProps\>
99

10-
Defined in: [packages/react-form/src/createFormHook.tsx:253](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L253)
10+
Defined in: [packages/react-form/src/createFormHook.tsx:256](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L256)
1111

1212
## Extends
1313

@@ -33,24 +33,14 @@ Defined in: [packages/react-form/src/createFormHook.tsx:253](https://github.com/
3333
optional props: TRenderProps;
3434
```
3535

36-
Defined in: [packages/react-form/src/createFormHook.tsx:261](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L261)
36+
Defined in: [packages/react-form/src/createFormHook.tsx:264](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L264)
3737

3838
***
3939

40-
### render()
40+
### render
4141

4242
```ts
43-
render: (props) => ReactNode;
43+
render: FunctionComponent<PropsWithChildren<NoInfer<TRenderProps> & object>>;
4444
```
4545

46-
Defined in: [packages/react-form/src/createFormHook.tsx:262](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L262)
47-
48-
#### Parameters
49-
50-
##### props
51-
52-
`PropsWithChildren`\<`NoInfer`\<`TRenderProps`\> & `object`\>
53-
54-
#### Returns
55-
56-
`ReactNode`
46+
Defined in: [packages/react-form/src/createFormHook.tsx:265](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L265)

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

Lines changed: 5 additions & 15 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, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TFieldComponents, TFormComponents, TRenderProps\>
99

10-
Defined in: [packages/react-form/src/createFormHook.tsx:197](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L197)
10+
Defined in: [packages/react-form/src/createFormHook.tsx:200](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L200)
1111

1212
## Extends
1313

@@ -53,24 +53,14 @@ Defined in: [packages/react-form/src/createFormHook.tsx:197](https://github.com/
5353
optional props: TRenderProps;
5454
```
5555

56-
Defined in: [packages/react-form/src/createFormHook.tsx:228](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L228)
56+
Defined in: [packages/react-form/src/createFormHook.tsx:231](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L231)
5757

5858
***
5959

60-
### render()
60+
### render
6161

6262
```ts
63-
render: (props) => ReactNode;
63+
render: FunctionComponent<PropsWithChildren<NoInfer<TRenderProps> & object>>;
6464
```
6565

66-
Defined in: [packages/react-form/src/createFormHook.tsx:229](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L229)
67-
68-
#### Parameters
69-
70-
##### props
71-
72-
`PropsWithChildren`\<`NoInfer`\<`TRenderProps`\> & `object`\>
73-
74-
#### Returns
75-
76-
`ReactNode`
66+
Defined in: [packages/react-form/src/createFormHook.tsx:232](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L232)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: FieldComponent
1111
type FieldComponent<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TPatentSubmitMeta, ExtendedApi> = <TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>({
1212
children,
1313
...fieldOptions
14-
}) => ReactNode;
14+
}) => ReturnType<FunctionComponent>;
1515
```
1616

1717
Defined in: [packages/react-form/src/useField.tsx:429](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L429)
@@ -81,4 +81,4 @@ A type alias representing a field component for a specific form data type.
8181

8282
## Returns
8383

84-
`ReactNode`
84+
`ReturnType`\<`FunctionComponent`\>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: LensFieldComponent
1111
type LensFieldComponent<TLensData, TParentSubmitMeta, ExtendedApi> = <TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>({
1212
children,
1313
...fieldOptions
14-
}) => ReactNode;
14+
}) => ReturnType<FunctionComponent>;
1515
```
1616

1717
Defined in: [packages/react-form/src/useField.tsx:504](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L504)
@@ -61,4 +61,4 @@ A type alias representing a field component for a form lens data type.
6161

6262
## Returns
6363

64-
`ReactNode`
64+
`ReturnType`\<`FunctionComponent`\>

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, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> = FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> & ReactFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
1212
```
1313

14-
Defined in: [packages/react-form/src/useForm.tsx:98](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L98)
14+
Defined in: [packages/react-form/src/useForm.tsx:103](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L103)
1515

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

0 commit comments

Comments
 (0)