|
| 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` |
0 commit comments