Skip to content

Commit 7d19027

Browse files
ci: apply automated fixes and generate docs
1 parent 8afbfc3 commit 7d19027

File tree

8 files changed

+10
-10
lines changed

8 files changed

+10
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: useField
99
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>;
1010
```
1111

12-
Defined in: [packages/react-form/src/useField.tsx:137](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L137)
12+
Defined in: [packages/react-form/src/useField.tsx:139](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L139)
1313

1414
A hook for managing a field in a form.
1515

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: useForm
99
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>;
1010
```
1111

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

1414
A custom React Hook that returns an extended instance of the `FormApi` class.
1515

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

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

66
# Interface: ReactFormApi\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta\>
77

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

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

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

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

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

@@ -79,7 +79,7 @@ A React component to render form fields. With this, you can render and manage in
7979
Subscribe: <TSelected>(props) => ReactNode | Promise<ReactNode>;
8080
```
8181

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

8484
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.
8585

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ type FieldComponent<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync
1212
}) => ReturnType<FunctionComponent>;
1313
```
1414

15-
Defined in: [packages/react-form/src/useField.tsx:429](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L429)
15+
Defined in: [packages/react-form/src/useField.tsx:522](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L522)
1616

1717
A type alias representing a field component for a specific form data type.
1818

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ type LensFieldComponent<TLensData, TParentSubmitMeta, ExtendedApi> = <TName, TDa
1212
}) => ReturnType<FunctionComponent>;
1313
```
1414

15-
Defined in: [packages/react-form/src/useField.tsx:504](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L504)
15+
Defined in: [packages/react-form/src/useField.tsx:597](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L597)
1616

1717
A type alias representing a field component for a form lens data type.
1818

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: ReactFormExtendedApi
99
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>;
1010
```
1111

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

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: UseField
99
type UseField<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TPatentSubmitMeta> = <TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>(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>;
1010
```
1111

12-
Defined in: [packages/react-form/src/useField.tsx:57](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L57)
12+
Defined in: [packages/react-form/src/useField.tsx:59](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L59)
1313

1414
A type representing a hook for using a field in a form with the given form data type.
1515

docs/framework/react/reference/variables/Field.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: Field
99
const 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>;
1010
```
1111

12-
Defined in: [packages/react-form/src/useField.tsx:594](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L594)
12+
Defined in: [packages/react-form/src/useField.tsx:687](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L687)
1313

1414
A function component that takes field options and a render function as children and returns a React component.
1515

0 commit comments

Comments
 (0)