Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

Field.md

48 lines2.2 KB

1---
2id: Field
3title: Field
4---
5​
6# Variable: Field()
7​
8```ts
9const Field: <TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(props) => CreateComponentPublicInstanceWithMixins<UseFieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta> &
10 | {
11[key: `on${Capitalize<string>}`]: (...args) => any | undefined;
13 | {
14[key: `on${Capitalize<string>}`]: (...args) => any | undefined;
15}, {
16}, {
17}, {
18}, {
19}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, {
20}, false, {
21}, {
22}>;
23```
24​
25Defined in: [packages/vue-form/src/useField.tsx:510](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L510)
26​
27## Parameters
28​
29### props
30​
31UseFieldOptions\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, ... 14 more ..., TParentSubmitMeta\> & (\{ ...; \} \| \{ ...; \}) & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps`
32​
33## Returns
34​
35`CreateComponentPublicInstanceWithMixins`\<`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> &
36 \| \{
37\[`key`: `` `on${Capitalize<string>}` ``\]: (...`args`) => `any` \| `undefined`;
38\}
39 \| \{
40\[`key`: `` `on${Capitalize<string>}` ``\]: (...`args`) => `any` \| `undefined`;
41\}, \{
42\}, \{
43\}, \{
44\}, \{
45\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, \{
46\}, `false`, \{
47\}, \{
48\}\>