Skip to content

Commit 24dfe42

Browse files
fix(react-form): export WithFormProps type (#1235)
* feat(react-form): export `WithFormProps` type * fix(react-form): re-export from barrel index.ts file * ci: apply automated fixes and generate docs --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 6c67a26 commit 24dfe42

File tree

5 files changed

+77
-2
lines changed

5 files changed

+77
-2
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync
101101

102102
##### \_\_namedParameters
103103

104-
`WithFormProps`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`, `TRenderProps`\>
104+
[`WithFormProps`](../interfaces/withformprops.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`, `TRenderProps`\>
105105

106106
#### Returns
107107

docs/framework/react/reference/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ title: "@tanstack/react-form"
1010
## Interfaces
1111

1212
- [ReactFormApi](interfaces/reactformapi.md)
13+
- [WithFormProps](interfaces/withformprops.md)
1314

1415
## Type Aliases
1516

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/react-form/src/createFormHook.tsx:136](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L136)
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`, `ComponentType`\<`any`\>\>
39+
40+
**TFormComponents** *extends* `Record`\<`string`, `ComponentType`\<`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/react-form/src/createFormHook.tsx:163](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L163)
53+
54+
***
55+
56+
### render()
57+
58+
```ts
59+
render: (props) => Element;
60+
```
61+
62+
Defined in: [packages/react-form/src/createFormHook.tsx:164](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L164)
63+
64+
#### Parameters
65+
66+
##### props
67+
68+
`PropsWithChildren`\<`NoInfer`\<`TRenderProps`\> & `object`\>
69+
70+
#### Returns
71+
72+
`Element`

packages/react-form/src/createFormHook.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ type AppFieldExtendedReactFormApi<
133133
AppForm: ComponentType<PropsWithChildren>
134134
}
135135

136-
interface WithFormProps<
136+
export interface WithFormProps<
137137
TFormData,
138138
TOnMount extends undefined | FormValidateOrFn<TFormData>,
139139
TOnChange extends undefined | FormValidateOrFn<TFormData>,

packages/react-form/src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@ export type { UseField, FieldComponent } from './useField'
99
export { useField, Field } from './useField'
1010

1111
export { useTransform } from './useTransform'
12+
13+
export type { WithFormProps } from './createFormHook'
1214
export { createFormHook, createFormHookContexts } from './createFormHook'

0 commit comments

Comments
 (0)