Skip to content

Commit 582386b

Browse files
ci: apply automated fixes and generate docs
1 parent 3076d0d commit 582386b

20 files changed

Lines changed: 85 additions & 107 deletions

docs/framework/preact/reference/functions/createFormHook.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createFormHook
99
function createFormHook<TComponents, TFormComponents>(__namedParameters): object;
1010
```
1111

12-
Defined in: [packages/react-form/src/createFormHook.tsx:293](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L293)
12+
Defined in: [packages/preact-form/src/createFormHook.tsx:294](https://github.com/TanStack/form/blob/main/packages/preact-form/src/createFormHook.tsx#L294)
1313

1414
## Type Parameters
1515

@@ -168,7 +168,7 @@ Gets a typed form from the `<form.AppForm />` context.
168168
### withFieldGroup()
169169

170170
```ts
171-
withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters) => <TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TFormSubmitMeta>(params) => ReactNode | Promise<ReactNode>;
171+
withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters) => <TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TFormSubmitMeta>(params) => ComponentChildren;
172172
```
173173

174174
#### Type Parameters
@@ -195,7 +195,7 @@ withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters)
195195
#### Returns
196196

197197
```ts
198-
<TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TFormSubmitMeta>(params): ReactNode | Promise<ReactNode>;
198+
<TFormData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TFormSubmitMeta>(params): ComponentChildren;
199199
```
200200

201201
##### Type Parameters
@@ -258,11 +258,11 @@ withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters)
258258

259259
###### params
260260

261-
`PropsWithChildren`\<`NoInfer`\<`TRenderProps`\> & `object`\>
261+
[`PropsWithChildren`](../type-aliases/PropsWithChildren.md)\<`NoInfer`\<`TRenderProps`\> & `object`\>
262262

263263
##### Returns
264264

265-
`ReactNode` \| `Promise`\<`ReactNode`\>
265+
`ComponentChildren`
266266

267267
### withForm()
268268

@@ -333,4 +333,4 @@ withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync
333333

334334
#### Returns
335335

336-
`FunctionComponent`\<`PropsWithChildren`\<`NoInfer`\<`UnwrapOrAny`\<`TRenderProps`\>\> & `object`\>\>
336+
`FunctionComponent`\<[`PropsWithChildren`](../type-aliases/PropsWithChildren.md)\<`NoInfer`\<`UnwrapOrAny`\<`TRenderProps`\>\> & `object`\>\>

docs/framework/preact/reference/functions/createFormHookContexts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createFormHookContexts
99
function createFormHookContexts(): object;
1010
```
1111

12-
Defined in: [packages/react-form/src/createFormHook.tsx:95](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L95)
12+
Defined in: [packages/preact-form/src/createFormHook.tsx:91](https://github.com/TanStack/form/blob/main/packages/preact-form/src/createFormHook.tsx#L91)
1313

1414
## Returns
1515

@@ -18,13 +18,13 @@ Defined in: [packages/react-form/src/createFormHook.tsx:95](https://github.com/T
1818
### fieldContext
1919

2020
```ts
21-
fieldContext: Context<AnyFieldApi>;
21+
fieldContext: Context<AnyFieldApi> = FieldContext;
2222
```
2323

2424
### formContext
2525

2626
```ts
27-
formContext: Context<AnyFormApi>;
27+
formContext: Context<AnyFormApi> = FormContext;
2828
```
2929

3030
### useFieldContext()

docs/framework/preact/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:139](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L139)
12+
Defined in: [packages/preact-form/src/useField.tsx:137](https://github.com/TanStack/form/blob/main/packages/preact-form/src/useField.tsx#L137)
1313

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

docs/framework/preact/reference/functions/useFieldGroup.md

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

12-
Defined in: [packages/react-form/src/useFieldGroup.tsx:96](https://github.com/TanStack/form/blob/main/packages/react-form/src/useFieldGroup.tsx#L96)
12+
Defined in: [packages/preact-form/src/useFieldGroup.tsx:90](https://github.com/TanStack/form/blob/main/packages/preact-form/src/useFieldGroup.tsx#L90)
1313

1414
## Type Parameters
1515

docs/framework/preact/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:159](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L159)
12+
Defined in: [packages/preact-form/src/useForm.tsx:158](https://github.com/TanStack/form/blob/main/packages/preact-form/src/useForm.tsx#L158)
1313

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

docs/framework/preact/reference/functions/useStore.md

Lines changed: 10 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -5,80 +5,39 @@ title: useStore
55

66
# Function: useStore()
77

8-
## Call Signature
9-
10-
```ts
11-
function useStore<TState, TSelected>(
12-
store,
13-
selector?,
14-
options?): TSelected;
15-
```
16-
17-
Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.8.1\_react-dom@19.1.0\_react@19.1.0\_\_react@19.1.0/node\_modules/@tanstack/preact-store/dist/esm/index.d.ts:11
18-
19-
### Type Parameters
20-
21-
#### TState
22-
23-
`TState`
24-
25-
#### TSelected
26-
27-
`TSelected` = `NoInfer`\<`TState`\>
28-
29-
### Parameters
30-
31-
#### store
32-
33-
`Store`\<`TState`, `any`\>
34-
35-
#### selector?
36-
37-
(`state`) => `TSelected`
38-
39-
#### options?
40-
41-
`UseStoreOptions`\<`TSelected`\>
42-
43-
### Returns
44-
45-
`TSelected`
46-
47-
## Call Signature
48-
498
```ts
509
function useStore<TState, TSelected>(
5110
store,
5211
selector?,
5312
options?): TSelected;
5413
```
5514

56-
Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.8.1\_react-dom@19.1.0\_react@19.1.0\_\_react@19.1.0/node\_modules/@tanstack/preact-store/dist/esm/index.d.ts:12
15+
Defined in: [packages/preact-form/src/useStore.ts:34](https://github.com/TanStack/form/blob/main/packages/preact-form/src/useStore.ts#L34)
5716

58-
### Type Parameters
17+
## Type Parameters
5918

60-
#### TState
19+
### TState
6120

6221
`TState`
6322

64-
#### TSelected
23+
### TSelected
6524

6625
`TSelected` = `NoInfer`\<`TState`\>
6726

68-
### Parameters
27+
## Parameters
6928

70-
#### store
29+
### store
7130

72-
`Derived`\<`TState`, `any`\>
31+
`StoreLike`\<`TState`\>
7332

74-
#### selector?
33+
### selector?
7534

7635
(`state`) => `TSelected`
7736

78-
#### options?
37+
### options?
7938

8039
`UseStoreOptions`\<`TSelected`\>
8140

82-
### Returns
41+
## Returns
8342

8443
`TSelected`

docs/framework/preact/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ title: "@tanstack/preact-form"
1717

1818
- [FieldComponent](type-aliases/FieldComponent.md)
1919
- [LensFieldComponent](type-aliases/LensFieldComponent.md)
20+
- [PropsWithChildren](type-aliases/PropsWithChildren.md)
2021
- [ReactFormExtendedApi](type-aliases/ReactFormExtendedApi.md)
2122
- [ServerFormState](type-aliases/ServerFormState.md)
2223
- [UseField](type-aliases/UseField.md)

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

Lines changed: 6 additions & 6 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:24](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L24)
8+
Defined in: [packages/preact-form/src/useForm.tsx:23](https://github.com/TanStack/form/blob/main/packages/preact-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:41](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L41)
70+
Defined in: [packages/preact-form/src/useForm.tsx:40](https://github.com/TanStack/form/blob/main/packages/preact-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

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

7878
```ts
79-
Subscribe: <TSelected>(props) => ReactNode | Promise<ReactNode>;
79+
Subscribe: <TSelected>(props) => ComponentChildren;
8080
```
8181

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

@@ -95,12 +95,12 @@ A `Subscribe` function that allows you to listen and react to changes in the for
9595

9696
###### children
9797

98-
`ReactNode` \| (`state`) => `ReactNode`
98+
`ComponentChild` \| (`state`) => `ComponentChild`
9999

100100
###### selector?
101101

102102
(`state`) => `TSelected`
103103

104104
#### Returns
105105

106-
`ReactNode` \| `Promise`\<`ReactNode`\>
106+
`ComponentChildren`

docs/framework/preact/reference/interfaces/UseFieldOptions.md

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

66
# 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\>
77

8-
Defined in: [packages/react-form/src/types.ts:20](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L20)
8+
Defined in: [packages/preact-form/src/types.ts:21](https://github.com/TanStack/form/blob/main/packages/preact-form/src/types.ts#L21)
99

1010
The field options.
1111

@@ -115,7 +115,7 @@ The field options.
115115
optional mode: "value" | "array";
116116
```
117117

118-
Defined in: [packages/react-form/src/types.ts:14](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L14)
118+
Defined in: [packages/preact-form/src/types.ts:15](https://github.com/TanStack/form/blob/main/packages/preact-form/src/types.ts#L15)
119119

120120
#### Inherited from
121121

docs/framework/preact/reference/interfaces/UseFieldOptionsBound.md

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

66
# Interface: UseFieldOptionsBound\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync\>
77

8-
Defined in: [packages/react-form/src/types.ts:81](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L81)
8+
Defined in: [packages/preact-form/src/types.ts:82](https://github.com/TanStack/form/blob/main/packages/preact-form/src/types.ts#L82)
99

1010
## Extends
1111

@@ -69,7 +69,7 @@ Defined in: [packages/react-form/src/types.ts:81](https://github.com/TanStack/fo
6969
optional mode: "value" | "array";
7070
```
7171

72-
Defined in: [packages/react-form/src/types.ts:14](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L14)
72+
Defined in: [packages/preact-form/src/types.ts:15](https://github.com/TanStack/form/blob/main/packages/preact-form/src/types.ts#L15)
7373

7474
#### Inherited from
7575

0 commit comments

Comments
 (0)