Skip to content

Commit 824d723

Browse files
autofix-ci[bot]autofix-ci[bot]
authored
ci: apply automated fixes and generate docs
1 parent 737e262 commit 824d723

File tree

9 files changed

+262
-11
lines changed

9 files changed

+262
-11
lines changed

‎docs/framework/solid/reference/functions/createfield.md

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

14-
Defined in: [packages/solid-form/src/createField.tsx:223](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L223)
14+
Defined in: [packages/solid-form/src/createField.tsx:222](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L222)
1515

1616
## Type Parameters
1717

‎docs/framework/solid/reference/functions/createform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: createForm
1111
function createForm<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>(opts?): FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta> & SolidFormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>
1212
```
1313

14-
Defined in: [packages/solid-form/src/createForm.tsx:115](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L115)
14+
Defined in: [packages/solid-form/src/createForm.tsx:153](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L153)
1515

1616
## Type Parameters
1717

‎docs/framework/solid/reference/functions/createformhook.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
id: createFormHook
3+
title: createFormHook
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Function: createFormHook()
9+
10+
```ts
11+
function createFormHook<TComponents, TFormComponents>(opts): object
12+
```
13+
14+
Defined in: [packages/solid-form/src/createFormHook.tsx:232](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L232)
15+
16+
## Type Parameters
17+
18+
• **TComponents** *extends* `Record`\<`string`, `Component`\<`any`\>\>
19+
20+
• **TFormComponents** *extends* `Record`\<`string`, `Component`\<`any`\>\>
21+
22+
## Parameters
23+
24+
### opts
25+
26+
`CreateFormHookProps`\<`TComponents`, `TFormComponents`\>
27+
28+
## Returns
29+
30+
`object`
31+
32+
### useAppForm()
33+
34+
```ts
35+
useAppForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>(props) => AppFieldExtendedSolidFormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>;
36+
```
37+
38+
#### Type Parameters
39+
40+
• **TFormData**
41+
42+
• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
43+
44+
• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
45+
46+
• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
47+
48+
• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
49+
50+
• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
51+
52+
• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
53+
54+
• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
55+
56+
• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
57+
58+
• **TSubmitMeta**
59+
60+
#### Parameters
61+
62+
##### props
63+
64+
`Accessor`\<`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\>\>
65+
66+
#### Returns
67+
68+
`AppFieldExtendedSolidFormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>
69+
70+
### withForm()
71+
72+
```ts
73+
withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta, TRenderProps>(__namedParameters) => (props) => Element;
74+
```
75+
76+
#### Type Parameters
77+
78+
• **TFormData**
79+
80+
• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
81+
82+
• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
83+
84+
• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
85+
86+
• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
87+
88+
• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
89+
90+
• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
91+
92+
• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
93+
94+
• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
95+
96+
• **TSubmitMeta**
97+
98+
• **TRenderProps** *extends* `Record`\<`string`, `unknown`\> = \{\}
99+
100+
#### Parameters
101+
102+
##### \_\_namedParameters
103+
104+
[`WithFormProps`](../../interfaces/withformprops.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`, `TRenderProps`\>
105+
106+
#### Returns
107+
108+
`Function`
109+
110+
##### Parameters
111+
112+
###### props
113+
114+
`ParentProps`\<`NoInfer`\<`UnwrapOrAny`\<`TRenderProps`\>\> & `object`\>
115+
116+
##### Returns
117+
118+
`Element`

‎docs/framework/solid/reference/functions/createformhookcontexts.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
id: createFormHookContexts
3+
title: createFormHookContexts
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Function: createFormHookContexts()
9+
10+
```ts
11+
function createFormHookContexts(): object
12+
```
13+
14+
Defined in: [packages/solid-form/src/createFormHook.tsx:58](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L58)
15+
16+
## Returns
17+
18+
`object`
19+
20+
### fieldContext
21+
22+
```ts
23+
fieldContext: Context<Accessor<AnyFieldApi>>;
24+
```
25+
26+
### formContext
27+
28+
```ts
29+
formContext: Context<AnyFormApi>;
30+
```
31+
32+
### useFieldContext()
33+
34+
```ts
35+
useFieldContext: <TData>() => Accessor<FieldApi<any, string, TData, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>>;
36+
```
37+
38+
#### Type Parameters
39+
40+
• **TData**
41+
42+
#### Returns
43+
44+
`Accessor`\<`FieldApi`\<`any`, `string`, `TData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>\>
45+
46+
### useFormContext()
47+
48+
```ts
49+
useFormContext: () => SolidFormExtendedApi<Record<string, never>, any, any, any, any, any, any, any, any, any>;
50+
```
51+
52+
#### Returns
53+
54+
`SolidFormExtendedApi`\<`Record`\<`string`, `never`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>

‎docs/framework/solid/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, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>(props): Element
1212
```
1313

14-
Defined in: [packages/solid-form/src/createField.tsx:524](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L524)
14+
Defined in: [packages/solid-form/src/createField.tsx:538](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L538)
1515

1616
## Type Parameters
1717

‎docs/framework/solid/reference/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ title: "@tanstack/solid-form"
1010
## Interfaces
1111

1212
- [SolidFormApi](../interfaces/solidformapi.md)
13+
- [WithFormProps](../interfaces/withformprops.md)
1314

1415
## Type Aliases
1516

@@ -20,5 +21,7 @@ title: "@tanstack/solid-form"
2021

2122
- [createField](../functions/createfield.md)
2223
- [createForm](../functions/createform.md)
24+
- [createFormHook](../functions/createformhook.md)
25+
- [createFormHookContexts](../functions/createformhookcontexts.md)
2326
- [Field](../functions/field.md)
2427
- [useStore](../functions/usestore.md)

‎docs/framework/solid/reference/interfaces/withformprops.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
id: WithFormProps
3+
title: WithFormProps
4+
---
5+
6+
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7+
8+
# Interface: WithFormProps\<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta, TFieldComponents, TFormComponents, TRenderProps\>
9+
10+
Defined in: [packages/solid-form/src/createFormHook.tsx:182](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L182)
11+
12+
## Extends
13+
14+
- `FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\>
15+
16+
## Type Parameters
17+
18+
• **TFormData**
19+
20+
• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
21+
22+
• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
23+
24+
• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
25+
26+
• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
27+
28+
• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
29+
30+
• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\>
31+
32+
• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
33+
34+
• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\>
35+
36+
• **TSubmitMeta**
37+
38+
• **TFieldComponents** *extends* `Record`\<`string`, `Component`\<`any`\>\>
39+
40+
• **TFormComponents** *extends* `Record`\<`string`, `Component`\<`any`\>\>
41+
42+
• **TRenderProps** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `never`\>
43+
44+
## Properties
45+
46+
### props?
47+
48+
```ts
49+
optional props: TRenderProps;
50+
```
51+
52+
Defined in: [packages/solid-form/src/createFormHook.tsx:209](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L209)
53+
54+
***
55+
56+
### render()
57+
58+
```ts
59+
render: (props) => Element;
60+
```
61+
62+
Defined in: [packages/solid-form/src/createFormHook.tsx:210](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createFormHook.tsx#L210)
63+
64+
#### Parameters
65+
66+
##### props
67+
68+
`ParentProps`\<`NoInfer`\<`TRenderProps`\> & `object`\>
69+
70+
#### Returns
71+
72+
`Element`

‎docs/framework/solid/reference/type-aliases/createfield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: CreateField
1111
type CreateField<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta> = <TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>(opts) => () => FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta> & SolidFieldApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta>;
1212
```
1313

14-
Defined in: [packages/solid-form/src/createField.tsx:49](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L49)
14+
Defined in: [packages/solid-form/src/createField.tsx:48](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L48)
1515

1616
## Type Parameters
1717

‎docs/framework/solid/reference/type-aliases/fieldcomponent.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,18 @@ title: FieldComponent
55

66
<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
77

8-
# Type Alias: FieldComponent()\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta\>
8+
# Type Alias: FieldComponent()\<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TPatentSubmitMeta, ExtendedApi\>
99

1010
```ts
11-
type FieldComponent<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TParentSubmitMeta> = <TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>({
11+
type FieldComponent<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TPatentSubmitMeta, ExtendedApi> = <TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>({
1212
children,
1313
...fieldOptions
14-
}) => JSXElement;
14+
}) => JSX.Element;
1515
```
1616

17-
Defined in: [packages/solid-form/src/createField.tsx:400](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L400)
17+
Defined in: [packages/solid-form/src/createField.tsx:406](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L406)
18+
19+
A type alias representing a field component for a specific form data type.
1820

1921
## Type Parameters
2022

@@ -36,7 +38,9 @@ Defined in: [packages/solid-form/src/createField.tsx:400](https://github.com/Tan
3638

3739
• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
3840

39-
• **TParentSubmitMeta**
41+
• **TPatentSubmitMeta**
42+
43+
• **ExtendedApi** = \{\}
4044

4145
## Type Parameters
4246

@@ -65,8 +69,8 @@ Defined in: [packages/solid-form/src/createField.tsx:400](https://github.com/Tan
6569
...fieldOptions
6670
\}
6771

68-
`FieldComponentBoundProps`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>
72+
`FieldComponentBoundProps`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`, `ExtendedApi`\>
6973

7074
## Returns
7175

72-
`JSXElement`
76+
`JSX.Element`

0 commit comments

Comments
 (0)