Skip to content

Commit b286f60

Browse files
ci: apply automated fixes and generate docs
1 parent d3883e9 commit b286f60

18 files changed

+44
-52
lines changed

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

Lines changed: 1 addition & 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:289](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L289)
14+
Defined in: [packages/react-form/src/createFormHook.tsx:290](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L290)
1515

1616
## Type Parameters
1717

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:67](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L67)
14+
Defined in: [packages/react-form/src/createFormHook.tsx:68](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L68)
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, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TPatentSubmitMeta>(__namedParameters): ReactNode
1212
```
1313

14-
Defined in: [packages/react-form/src/useField.tsx:583](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L583)
14+
Defined in: [packages/react-form/src/useField.tsx:585](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L585)
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/usefield.md

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

14-
Defined in: [packages/react-form/src/useField.tsx:135](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L135)
14+
Defined in: [packages/react-form/src/useField.tsx:137](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L137)
1515

1616
A hook for managing a field in a form.
1717

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:89](https://github.com/TanStack/form/blob/main/packages/react-form/src/useFieldGroup.tsx#L89)
14+
Defined in: [packages/react-form/src/useFieldGroup.tsx:91](https://github.com/TanStack/form/blob/main/packages/react-form/src/useFieldGroup.tsx#L91)
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:156](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L156)
14+
Defined in: [packages/react-form/src/useForm.tsx:158](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L158)
1515

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

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

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/framework/react/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ title: "@tanstack/react-form"
2020
- [FieldComponent](../type-aliases/fieldcomponent.md)
2121
- [LensFieldComponent](../type-aliases/lensfieldcomponent.md)
2222
- [ReactFormExtendedApi](../type-aliases/reactformextendedapi.md)
23+
- [ServerFormState](../type-aliases/serverformstate.md)
2324
- [UseField](../type-aliases/usefield.md)
2425

2526
## Functions
@@ -31,4 +32,3 @@ title: "@tanstack/react-form"
3132
- [useFieldGroup](../functions/usefieldgroup.md)
3233
- [useForm](../functions/useform.md)
3334
- [useStore](../functions/usestore.md)
34-
- [useTransform](../functions/usetransform.md)

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, TOnDynamic, TOnDynamicAsync, 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:23](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L23)
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:38](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L38)
48+
Defined in: [packages/react-form/src/useForm.tsx:40](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L40)
4949

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

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

60-
Defined in: [packages/react-form/src/useForm.tsx:55](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L55)
60+
Defined in: [packages/react-form/src/useForm.tsx:57](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L57)
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

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

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

88
# Interface: UseFieldOptions\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta\>
99

10-
Defined in: [packages/react-form/src/types.ts:19](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L19)
10+
Defined in: [packages/react-form/src/types.ts:20](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L20)
1111

1212
The field options.
1313

@@ -71,7 +71,7 @@ The field options.
7171
optional mode: "value" | "array";
7272
```
7373

74-
Defined in: [packages/react-form/src/types.ts:13](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L13)
74+
Defined in: [packages/react-form/src/types.ts:14](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L14)
7575

7676
#### Inherited from
7777

0 commit comments

Comments
 (0)