Skip to content

Commit eea2a42

Browse files
ci: apply automated fixes and generate docs
1 parent 05f3522 commit eea2a42

23 files changed

+284
-144
lines changed

docs/framework/react/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ title: "@tanstack/react-form"
2424
## Variables
2525

2626
- [Field](variables/Field.md)
27+
- [useIsomorphicLayoutEffect](variables/useIsomorphicLayoutEffect.md)
2728

2829
## Functions
2930

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
id: useIsomorphicLayoutEffect
3+
title: useIsomorphicLayoutEffect
4+
---
5+
6+
# Variable: useIsomorphicLayoutEffect()
7+
8+
```ts
9+
const useIsomorphicLayoutEffect: (effect, deps?) => void;
10+
```
11+
12+
Defined in: [packages/react-form/src/useIsomorphicLayoutEffect.ts:3](https://github.com/TanStack/form/blob/main/packages/react-form/src/useIsomorphicLayoutEffect.ts#L3)
13+
14+
The signature is identical to `useEffect`, but it fires synchronously after all DOM mutations.
15+
Use this to read layout from the DOM and synchronously re-render. Updates scheduled inside
16+
`useLayoutEffect` will be flushed synchronously, before the browser has a chance to paint.
17+
18+
Prefer the standard `useEffect` when possible to avoid blocking visual updates.
19+
20+
If you’re migrating code from a class component, `useLayoutEffect` fires in the same phase as
21+
`componentDidMount` and `componentDidUpdate`.
22+
23+
## Parameters
24+
25+
### effect
26+
27+
`EffectCallback`
28+
29+
### deps?
30+
31+
`DependencyList`
32+
33+
## Returns
34+
35+
`void`
36+
37+
## Version
38+
39+
16.8.0
40+
41+
## See
42+
43+
[https://react.dev/reference/react/useLayoutEffect](https://react.dev/reference/react/useLayoutEffect)

docs/reference/classes/FormApi.md

Lines changed: 37 additions & 37 deletions
Large diffs are not rendered by default.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
id: deepCopy
3+
title: deepCopy
4+
---
5+
6+
# Function: deepCopy()
7+
8+
```ts
9+
function deepCopy<T>(obj): T;
10+
```
11+
12+
Defined in: [packages/form-core/src/utils.ts:621](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L621)
13+
14+
## Type Parameters
15+
16+
### T
17+
18+
`T`
19+
20+
## Parameters
21+
22+
### obj
23+
24+
`T`
25+
26+
## Returns
27+
28+
`T`

docs/reference/functions/mergeForm.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,71 @@ title: mergeForm
66
# Function: mergeForm()
77

88
```ts
9-
function mergeForm<TFormData>(baseForm, state): FormApi<NoInfer<TFormData>, any, any, any, any, any, any, any, any, any, any, any>;
9+
function mergeForm<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(baseForm, state): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
1010
```
1111

12-
Defined in: [packages/form-core/src/mergeForm.ts:73](https://github.com/TanStack/form/blob/main/packages/form-core/src/mergeForm.ts#L73)
12+
Defined in: [packages/form-core/src/mergeForm.ts:77](https://github.com/TanStack/form/blob/main/packages/form-core/src/mergeForm.ts#L77)
1313

1414
## Type Parameters
1515

1616
### TFormData
1717

1818
`TFormData`
1919

20+
### TOnMount
21+
22+
`TOnMount` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
23+
24+
### TOnChange
25+
26+
`TOnChange` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
27+
28+
### TOnChangeAsync
29+
30+
`TOnChangeAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
31+
32+
### TOnBlur
33+
34+
`TOnBlur` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
35+
36+
### TOnBlurAsync
37+
38+
`TOnBlurAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
39+
40+
### TOnSubmit
41+
42+
`TOnSubmit` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
43+
44+
### TOnSubmitAsync
45+
46+
`TOnSubmitAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
47+
48+
### TOnDynamic
49+
50+
`TOnDynamic` *extends* `FormValidateOrFn`\<`TFormData`\> \| `undefined`
51+
52+
### TOnDynamicAsync
53+
54+
`TOnDynamicAsync` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
55+
56+
### TOnServer
57+
58+
`TOnServer` *extends* `FormAsyncValidateOrFn`\<`TFormData`\> \| `undefined`
59+
60+
### TSubmitMeta
61+
62+
`TSubmitMeta` = `never`
63+
2064
## Parameters
2165

2266
### baseForm
2367

24-
[`FormApi`](../classes/FormApi.md)\<`NoInfer`\<`TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>
68+
[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
2569

2670
### state
2771

28-
`Partial`\<[`FormApi`](../classes/FormApi.md)\<`TFormData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>\[`"state"`\]\>
72+
`Partial`\<[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>\[`"state"`\]\>
2973

3074
## Returns
3175

32-
[`FormApi`](../classes/FormApi.md)\<`NoInfer`\<`TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>
76+
[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>

docs/reference/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ title: "@tanstack/form-core"
3636

3737
- [AllObjectKeys](type-aliases/AllObjectKeys.md)
3838
- [AllTupleKeys](type-aliases/AllTupleKeys.md)
39+
- [AnyBaseFormState](type-aliases/AnyBaseFormState.md)
3940
- [AnyFieldApi](type-aliases/AnyFieldApi.md)
4041
- [AnyFieldGroupApi](type-aliases/AnyFieldGroupApi.md)
4142
- [AnyFieldMeta](type-aliases/AnyFieldMeta.md)
@@ -101,6 +102,7 @@ title: "@tanstack/form-core"
101102
## Functions
102103

103104
- [createFieldMap](functions/createFieldMap.md)
105+
- [deepCopy](functions/deepCopy.md)
104106
- [evaluate](functions/evaluate.md)
105107
- [formOptions](functions/formOptions.md)
106108
- [isGlobalFormValidationError](functions/isGlobalFormValidationError.md)

docs/reference/interfaces/BaseFormOptions.md

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

66
# Interface: BaseFormOptions\<TFormData, TSubmitMeta\>
77

8-
Defined in: [packages/form-core/src/FormApi.ts:361](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L361)
8+
Defined in: [packages/form-core/src/FormApi.ts:313](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L313)
99

1010
An object representing the base properties of a form, unrelated to any validators
1111

@@ -31,7 +31,7 @@ An object representing the base properties of a form, unrelated to any validator
3131
optional defaultValues: TFormData;
3232
```
3333

34-
Defined in: [packages/form-core/src/FormApi.ts:365](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L365)
34+
Defined in: [packages/form-core/src/FormApi.ts:317](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L317)
3535

3636
Set initial values for your form.
3737

@@ -43,6 +43,6 @@ Set initial values for your form.
4343
optional onSubmitMeta: TSubmitMeta;
4444
```
4545

46-
Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369)
46+
Defined in: [packages/form-core/src/FormApi.ts:321](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L321)
4747

4848
onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props

docs/reference/interfaces/FormListeners.md

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

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

8-
Defined in: [packages/form-core/src/FormApi.ts:270](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L270)
8+
Defined in: [packages/form-core/src/FormApi.ts:222](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L222)
99

1010
## Type Parameters
1111

@@ -65,7 +65,7 @@ Defined in: [packages/form-core/src/FormApi.ts:270](https://github.com/TanStack/
6565
optional onBlur: (props) => void;
6666
```
6767

68-
Defined in: [packages/form-core/src/FormApi.ts:303](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L303)
68+
Defined in: [packages/form-core/src/FormApi.ts:255](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L255)
6969

7070
#### Parameters
7171

@@ -91,7 +91,7 @@ Defined in: [packages/form-core/src/FormApi.ts:303](https://github.com/TanStack/
9191
optional onBlurDebounceMs: number;
9292
```
9393

94-
Defined in: [packages/form-core/src/FormApi.ts:320](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L320)
94+
Defined in: [packages/form-core/src/FormApi.ts:272](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L272)
9595

9696
***
9797

@@ -101,7 +101,7 @@ Defined in: [packages/form-core/src/FormApi.ts:320](https://github.com/TanStack/
101101
optional onChange: (props) => void;
102102
```
103103

104-
Defined in: [packages/form-core/src/FormApi.ts:284](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L284)
104+
Defined in: [packages/form-core/src/FormApi.ts:236](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L236)
105105

106106
#### Parameters
107107

@@ -127,7 +127,7 @@ Defined in: [packages/form-core/src/FormApi.ts:284](https://github.com/TanStack/
127127
optional onChangeDebounceMs: number;
128128
```
129129

130-
Defined in: [packages/form-core/src/FormApi.ts:301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L301)
130+
Defined in: [packages/form-core/src/FormApi.ts:253](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L253)
131131

132132
***
133133

@@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:301](https://github.com/TanStack/
137137
optional onMount: (props) => void;
138138
```
139139

140-
Defined in: [packages/form-core/src/FormApi.ts:322](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L322)
140+
Defined in: [packages/form-core/src/FormApi.ts:274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L274)
141141

142142
#### Parameters
143143

@@ -159,7 +159,7 @@ Defined in: [packages/form-core/src/FormApi.ts:322](https://github.com/TanStack/
159159
optional onSubmit: (props) => void;
160160
```
161161

162-
Defined in: [packages/form-core/src/FormApi.ts:339](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L339)
162+
Defined in: [packages/form-core/src/FormApi.ts:291](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L291)
163163

164164
#### Parameters
165165

0 commit comments

Comments
 (0)