diff --git a/docs/config.json b/docs/config.json index 6f362eb73..220237d0a 100644 --- a/docs/config.json +++ b/docs/config.json @@ -192,40 +192,40 @@ "label": "API Reference", "children": [ { "label": "JavaScript Reference", "to": "reference/index" }, - { "label": "Classes / FieldApi", "to": "reference/fieldapi" }, - { "label": "Classes / FormApi", "to": "reference/formapi" }, - { "label": "Functions / formOptions", "to": "reference/formoptions" }, - { "label": "Functions / mergeForm", "to": "reference/mergeform" }, + { "label": "Classes / FieldApi", "to": "reference/FieldApi" }, + { "label": "Classes / FormApi", "to": "reference/FormApi" }, + { "label": "Functions / formOptions", "to": "reference/formOptions" }, + { "label": "Functions / mergeForm", "to": "reference/mergeForm" }, { "label": "Interfaces / FieldApiOptions", - "to": "reference/fieldapioptions" + "to": "reference/FieldApiOptions" }, { "label": "Interfaces / FieldOptions", - "to": "reference/fieldoptions" + "to": "reference/FieldOptions" }, { "label": "Interfaces / FieldValidators", - "to": "reference/fieldvalidators" + "to": "reference/FieldValidators" }, - { "label": "Interfaces / FormOptions", "to": "reference/formoptions" }, + { "label": "Interfaces / FormOptions", "to": "reference/FormOptions" }, { "label": "Interfaces / FormValidators", - "to": "reference/formvalidators" + "to": "reference/FormValidators" }, - { "label": "Types / DeepKeys", "to": "reference/deepkeys" }, - { "label": "Types / DeepValue", "to": "reference/deepvalue" }, - { "label": "Types / FieldInfo", "to": "reference/fieldinfo" }, - { "label": "Types / FieldMeta", "to": "reference/fieldmeta" }, - { "label": "Types / FieldState", "to": "reference/fieldstate" }, - { "label": "Types / FormState", "to": "reference/formstate" }, - { "label": "Types / Updater", "to": "reference/updater" }, - { "label": "Types / UpdaterFn", "to": "reference/updaterfn" }, + { "label": "Types / DeepKeys", "to": "reference/DeepKeys" }, + { "label": "Types / DeepValue", "to": "reference/DeepValue" }, + { "label": "Types / FieldInfo", "to": "reference/FieldInfo" }, + { "label": "Types / FieldMeta", "to": "reference/FieldMeta" }, + { "label": "Types / FieldState", "to": "reference/FieldState" }, + { "label": "Types / FormState", "to": "reference/FormState" }, + { "label": "Types / Updater", "to": "reference/Updater" }, + { "label": "Types / UpdaterFn", "to": "reference/UpdaterFn" }, { "label": "Types / ValidationError", - "to": "reference/validationerror" + "to": "reference/ValidationError" }, - { "label": "Types / ValidationMeta", "to": "reference/validationmeta" } + { "label": "Types / ValidationMeta", "to": "reference/ValidationMeta" } ], "frameworks": [ { @@ -237,35 +237,35 @@ }, { "label": "Functions / createServerValidate", - "to": "framework/react/reference/createservervalidate" + "to": "framework/react/reference/createServerValidate" }, { "label": "Functions / Field", - "to": "framework/react/reference/field" + "to": "framework/react/reference/Field" }, { "label": "Functions / useField", - "to": "framework/react/reference/usefield" + "to": "framework/react/reference/useField" }, { "label": "Functions / useForm", - "to": "framework/react/reference/useform" + "to": "framework/react/reference/useForm" }, { "label": "Functions / useTransform", - "to": "framework/react/reference/usetransform" + "to": "framework/react/reference/useTransform" }, { "label": "Types / FieldComponent", - "to": "framework/react/reference/fieldcomponent" + "to": "framework/react/reference/FieldComponent" }, { "label": "Types / UseField", - "to": "framework/react/reference/usefield" + "to": "framework/react/reference/UseField" }, { "label": "Variables / initialFormState", - "to": "framework/react/reference/initialformstate" + "to": "framework/react/reference/initialFormState" } ] }, @@ -275,23 +275,23 @@ { "label": "Vue Reference", "to": "framework/vue/reference/index" }, { "label": "Functions / Field", - "to": "framework/vue/reference/field" + "to": "framework/vue/reference/Field" }, { "label": "Functions / useField", - "to": "framework/vue/reference/usefield" + "to": "framework/vue/reference/useField" }, { "label": "Functions / useForm", - "to": "framework/vue/reference/useform" + "to": "framework/vue/reference/useForm" }, { "label": "Types / FieldComponent", - "to": "framework/vue/reference/fieldcomponent" + "to": "framework/vue/reference/FieldComponent" }, { "label": "Types / UseField", - "to": "framework/vue/reference/usefield" + "to": "framework/vue/reference/UseField" } ] }, @@ -304,23 +304,23 @@ }, { "label": "Functions / createField", - "to": "framework/solid/reference/createfield" + "to": "framework/solid/reference/createField" }, { "label": "Functions / createForm", - "to": "framework/solid/reference/createform" + "to": "framework/solid/reference/createForm" }, { "label": "Functions / Field", - "to": "framework/solid/reference/field" + "to": "framework/solid/reference/Field" }, { "label": "Types / CreateField", - "to": "framework/solid/reference/createfield" + "to": "framework/solid/reference/CreateField" }, { "label": "Types / FieldComponent", - "to": "framework/solid/reference/fieldcomponent" + "to": "framework/solid/reference/FieldComponent" } ] }, @@ -330,7 +330,7 @@ { "label": "Lit Reference", "to": "framework/lit/reference/index" }, { "label": "Classes / TanStackFormController", - "to": "framework/lit/reference/tanstackformcontroller" + "to": "framework/lit/reference/TanStackFormController" } ] }, @@ -343,15 +343,15 @@ }, { "label": "Classes / TanStackField", - "to": "framework/angular/reference/tanstackfield" + "to": "framework/angular/reference/TanStackField" }, { "label": "Functions / injectForm", - "to": "framework/angular/reference/injectform" + "to": "framework/angular/reference/injectForm" }, { "label": "Functions / injectStore", - "to": "framework/angular/reference/injectstore" + "to": "framework/angular/reference/injectStore" } ] } diff --git a/docs/framework/angular/reference/tanstackfield.md b/docs/framework/angular/reference/TanStackField.md similarity index 85% rename from docs/framework/angular/reference/tanstackfield.md rename to docs/framework/angular/reference/TanStackField.md index 39b6c7774..30a3cb1a9 100644 --- a/docs/framework/angular/reference/tanstackfield.md +++ b/docs/framework/angular/reference/TanStackField.md @@ -34,7 +34,7 @@ new TanStackField(): #### Returns -[`TanStackField`](tanstackfield.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +[`TanStackField`](TanStackField.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> ## Properties @@ -46,7 +46,7 @@ api: FieldApi; #### Defined in -[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L61) +[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L61) *** @@ -64,7 +64,7 @@ If `true`, always run async validation, even if there are errors emitted during #### Defined in -[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L50) +[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L50) *** @@ -82,7 +82,7 @@ The default time to debounce async validation if there is not a more specific de #### Defined in -[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L49) +[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L49) *** @@ -100,7 +100,7 @@ An optional object with default metadata for the field. #### Defined in -[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L59) +[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L59) *** @@ -118,7 +118,7 @@ An optional default value for the field. #### Defined in -[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L48) +[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L48) *** @@ -136,7 +136,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Defined in -[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L44) +[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L44) *** @@ -148,7 +148,7 @@ tanstackField: FormApi; #### Defined in -[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L52) +[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L52) *** @@ -164,7 +164,7 @@ optional unmount: () => void; #### Defined in -[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L76) +[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L76) *** @@ -182,7 +182,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L51) +[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L51) *** @@ -200,7 +200,7 @@ A list of validators to pass to the field #### Defined in -[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L56) +[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L56) ## Methods @@ -225,7 +225,7 @@ children are checked. #### Defined in -[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L88) +[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L88) *** @@ -248,7 +248,7 @@ before a directive, pipe, or service instance is destroyed. #### Defined in -[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L84) +[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L84) *** @@ -274,4 +274,4 @@ It is invoked only once when the directive is instantiated. #### Defined in -[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/tanstack-field.directive.ts#L78) +[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L78) diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index b8e5b5778..7c69077c7 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -7,9 +7,9 @@ title: "@tanstack/angular-form" ## Classes -- [TanStackField](tanstackfield.md) +- [TanStackField](TanStackField.md) ## Functions -- [injectForm](injectform.md) -- [injectStore](injectstore.md) +- [injectForm](injectForm.md) +- [injectStore](injectStore.md) diff --git a/docs/framework/angular/reference/injectform.md b/docs/framework/angular/reference/injectForm.md similarity index 78% rename from docs/framework/angular/reference/injectform.md rename to docs/framework/angular/reference/injectForm.md index 28f52e204..7e3a30ad9 100644 --- a/docs/framework/angular/reference/injectform.md +++ b/docs/framework/angular/reference/injectForm.md @@ -25,4 +25,4 @@ function injectForm(opts?): FormApi(form, selector?): Sig ## Defined in -[inject-store.ts:4](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/angular-form/src/inject-store.ts#L4) +[inject-store.ts:4](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/inject-store.ts#L4) diff --git a/docs/framework/lit/reference/tanstackformcontroller.md b/docs/framework/lit/reference/TanStackFormController.md similarity index 88% rename from docs/framework/lit/reference/tanstackformcontroller.md rename to docs/framework/lit/reference/TanStackFormController.md index 230031364..0488a548a 100644 --- a/docs/framework/lit/reference/tanstackformcontroller.md +++ b/docs/framework/lit/reference/TanStackFormController.md @@ -31,11 +31,11 @@ new TanStackFormController(host, config?): TanStack #### Returns -[`TanStackFormController`](tanstackformcontroller.md)\<`TParentData`, `TFormValidator`\> +[`TanStackFormController`](TanStackFormController.md)\<`TParentData`, `TFormValidator`\> #### Defined in -[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L93) +[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L93) ## Properties @@ -47,7 +47,7 @@ api: FormApi; #### Defined in -[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/lit-form/src/tanstack-form-controller.ts#L91) +[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L91) ## Methods @@ -101,7 +101,7 @@ render: renderCallback + +```ts +type UseField: (opts) => FieldApi; +``` + +A type representing a hook for using a field in a form with the given form data type. + +A function that takes an optional object with a `name` property and field options, and returns a `FieldApi` instance for the specified field. + +## Type Parameters + +• **TParentData** + +• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` + +## Type Parameters + +• **TName** *extends* `DeepKeys`\<`TParentData`\> + +• **TFieldValidator** *extends* `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` + +• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> + +## Parameters + +• **opts**: `Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> + +## Returns + +`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> + +## Defined in + +[useField.tsx:25](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useField.tsx#L25) diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 79989df76..d7932ad72 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -7,12 +7,12 @@ title: "@tanstack/react-form" ## Type Aliases -- [FieldComponent](fieldcomponent.md) -- [UseField](usefield.md) +- [FieldComponent](FieldComponent.md) +- [UseField](UseField.md) ## Functions -- [Field](field.md) -- [useField](usefield.md) -- [useForm](useform.md) -- [useTransform](usetransform.md) +- [Field](Field.md) +- [useField](useField.md) +- [useForm](useForm.md) +- [useTransform](useTransform.md) diff --git a/docs/framework/react/reference/usefield.md b/docs/framework/react/reference/useField.md similarity index 89% rename from docs/framework/react/reference/usefield.md rename to docs/framework/react/reference/useField.md index d1923c6e1..042bc9eec 100644 --- a/docs/framework/react/reference/usefield.md +++ b/docs/framework/react/reference/useField.md @@ -37,4 +37,4 @@ The `FieldApi` instance for the specified field. ## Defined in -[useField.tsx:49](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useField.tsx#L49) +[useField.tsx:49](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useField.tsx#L49) diff --git a/docs/framework/react/reference/useform.md b/docs/framework/react/reference/useForm.md similarity index 86% rename from docs/framework/react/reference/useform.md rename to docs/framework/react/reference/useForm.md index d8f21302e..ceb6c8560 100644 --- a/docs/framework/react/reference/useform.md +++ b/docs/framework/react/reference/useForm.md @@ -29,4 +29,4 @@ This API encapsulates all the necessary functionalities related to the form. It ## Defined in -[useForm.tsx:56](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useForm.tsx#L56) +[useForm.tsx:56](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useForm.tsx#L56) diff --git a/docs/framework/react/reference/usetransform.md b/docs/framework/react/reference/useTransform.md similarity index 83% rename from docs/framework/react/reference/usetransform.md rename to docs/framework/react/reference/useTransform.md index 69ff910ce..e7ca588ce 100644 --- a/docs/framework/react/reference/usetransform.md +++ b/docs/framework/react/reference/useTransform.md @@ -47,4 +47,4 @@ fn: (formBase) => FormApi; ## Defined in -[useTransform.ts:3](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/react-form/src/useTransform.ts#L3) +[useTransform.ts:3](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useTransform.ts#L3) diff --git a/docs/framework/solid/reference/CreateField.md b/docs/framework/solid/reference/CreateField.md new file mode 100644 index 000000000..a18ab774c --- /dev/null +++ b/docs/framework/solid/reference/CreateField.md @@ -0,0 +1,40 @@ +--- +id: CreateField +title: CreateField +--- + +# Type Alias: CreateField()\ + +```ts +type CreateField: (opts) => () => FieldApi & SolidFieldApi; +``` + +## Type Parameters + +• **TParentData** + +• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` + +## Type Parameters + +• **TName** *extends* `DeepKeys`\<`TParentData`\> + +• **TFieldValidator** *extends* `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` + +• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> + +## Parameters + +• **opts** + +## Returns + +`Function` + +### Returns + +`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `SolidFieldApi`\<`TParentData`, `TFormValidator`\> + +## Defined in + +[createField.tsx:29](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/solid-form/src/createField.tsx#L29) diff --git a/docs/framework/solid/reference/field.md b/docs/framework/solid/reference/Field.md similarity index 85% rename from docs/framework/solid/reference/field.md rename to docs/framework/solid/reference/Field.md index 47f28f98d..c99b71172 100644 --- a/docs/framework/solid/reference/field.md +++ b/docs/framework/solid/reference/Field.md @@ -31,4 +31,4 @@ function Field(props ## Defined in -[createField.tsx:185](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/solid-form/src/createField.tsx#L185) +[createField.tsx:185](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/solid-form/src/createField.tsx#L185) diff --git a/docs/framework/solid/reference/fieldcomponent.md b/docs/framework/solid/reference/FieldComponent.md similarity index 88% rename from docs/framework/solid/reference/fieldcomponent.md rename to docs/framework/solid/reference/FieldComponent.md index 16fee8e07..05219b5a4 100644 --- a/docs/framework/solid/reference/fieldcomponent.md +++ b/docs/framework/solid/reference/FieldComponent.md @@ -39,4 +39,4 @@ type FieldComponent: ## Defined in -[createField.tsx:87](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/solid-form/src/createField.tsx#L87) +[createField.tsx:87](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/solid-form/src/createField.tsx#L87) diff --git a/docs/framework/solid/reference/createform.md b/docs/framework/solid/reference/createForm.md similarity index 80% rename from docs/framework/solid/reference/createform.md rename to docs/framework/solid/reference/createForm.md index 1dd901308..01f192274 100644 --- a/docs/framework/solid/reference/createform.md +++ b/docs/framework/solid/reference/createForm.md @@ -25,4 +25,4 @@ function createForm(opts?): FormApi(props ## Defined in -[packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/vue-form/src/useField.tsx#L162) +[packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/vue-form/src/useField.tsx#L162) diff --git a/docs/framework/vue/reference/fieldcomponent.md b/docs/framework/vue/reference/FieldComponent.md similarity index 94% rename from docs/framework/vue/reference/fieldcomponent.md rename to docs/framework/vue/reference/FieldComponent.md index 10f764cf4..42c9a0668 100644 --- a/docs/framework/vue/reference/fieldcomponent.md +++ b/docs/framework/vue/reference/FieldComponent.md @@ -35,4 +35,4 @@ type FieldComponent: + +```ts +type UseField: (opts) => object; +``` + +## Type Parameters + +• **TParentData** + +• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` + +## Type Parameters + +• **TName** *extends* `DeepKeys`\<`TParentData`\> + +• **TFieldValidator** *extends* `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` + +• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> + +## Parameters + +• **opts**: `Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> + +## Returns + +`object` + +### api + +```ts +api: FieldApi & VueFieldApi; +``` + +### state + +```ts +state: Readonly["state"]>>; +``` + +## Defined in + +[packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/vue-form/src/useField.tsx#L17) diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index 75a7a91e3..dbc3b7920 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -7,11 +7,11 @@ title: "@tanstack/vue-form" ## Type Aliases -- [FieldComponent](fieldcomponent.md) -- [UseField](usefield.md) +- [FieldComponent](FieldComponent.md) +- [UseField](UseField.md) ## Functions -- [Field](field.md) -- [useField](usefield.md) -- [useForm](useform.md) +- [Field](Field.md) +- [useField](useField.md) +- [useForm](useForm.md) diff --git a/docs/framework/vue/reference/usefield.md b/docs/framework/vue/reference/useField.md similarity index 94% rename from docs/framework/vue/reference/usefield.md rename to docs/framework/vue/reference/useField.md index 579024cb8..d7a5b6e8d 100644 --- a/docs/framework/vue/reference/usefield.md +++ b/docs/framework/vue/reference/useField.md @@ -43,4 +43,4 @@ readonly state: Readonly>> = fieldState; ## Defined in -[packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/vue-form/src/useField.tsx#L49) +[packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/vue-form/src/useField.tsx#L49) diff --git a/docs/framework/vue/reference/useform.md b/docs/framework/vue/reference/useForm.md similarity index 90% rename from docs/framework/vue/reference/useform.md rename to docs/framework/vue/reference/useForm.md index 1d10a35bd..e73107b4f 100644 --- a/docs/framework/vue/reference/useform.md +++ b/docs/framework/vue/reference/useForm.md @@ -25,4 +25,4 @@ function useForm(opts?): FormApi +• **TName** *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> -• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` +• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -• **TData** *extends* [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> +• **TData** *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> ## Constructors @@ -37,15 +37,15 @@ Initializes a new `FieldApi` instance. #### Parameters -• **opts**: [`FieldApiOptions`](fieldapioptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +• **opts**: [`FieldApiOptions`](FieldApiOptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> #### Returns -[`FieldApi`](fieldapi.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +[`FieldApi`](FieldApi.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> #### Defined in -[packages/form-core/src/FieldApi.ts:432](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L432) +[packages/form-core/src/FieldApi.ts:432](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L432) ## Properties @@ -59,7 +59,7 @@ A reference to the form API instance. #### Defined in -[packages/form-core/src/FieldApi.ts:395](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L395) +[packages/form-core/src/FieldApi.ts:395](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L395) *** @@ -73,7 +73,7 @@ The field name. #### Defined in -[packages/form-core/src/FieldApi.ts:405](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L405) +[packages/form-core/src/FieldApi.ts:405](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L405) *** @@ -87,7 +87,7 @@ The field options. #### Defined in -[packages/form-core/src/FieldApi.ts:409](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L409) +[packages/form-core/src/FieldApi.ts:409](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L409) *** @@ -101,7 +101,7 @@ The current field state. #### Defined in -[packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L423) +[packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L423) *** @@ -115,7 +115,7 @@ The field state store. #### Defined in -[packages/form-core/src/FieldApi.ts:419](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L419) +[packages/form-core/src/FieldApi.ts:419](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L419) ## Methods @@ -129,11 +129,11 @@ Gets the field information object. #### Returns -[`FieldInfo`](fieldinfo.md)\<`TParentData`, `TFormValidator`\> +[`FieldInfo`](FieldInfo.md)\<`TParentData`, `TFormValidator`\> #### Defined in -[packages/form-core/src/FieldApi.ts:642](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L642) +[packages/form-core/src/FieldApi.ts:642](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L642) *** @@ -147,11 +147,11 @@ Gets the current field metadata. #### Returns -[`FieldMeta`](fieldmeta.md) +[`FieldMeta`](FieldMeta.md) #### Defined in -[packages/form-core/src/FieldApi.ts:621](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L621) +[packages/form-core/src/FieldApi.ts:621](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L621) *** @@ -173,7 +173,7 @@ Use `field.state.value` instead. #### Defined in -[packages/form-core/src/FieldApi.ts:601](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L601) +[packages/form-core/src/FieldApi.ts:601](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L601) *** @@ -191,7 +191,7 @@ Handles the blur event. #### Defined in -[packages/form-core/src/FieldApi.ts:956](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L956) +[packages/form-core/src/FieldApi.ts:956](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L956) *** @@ -205,7 +205,7 @@ Handles the change event. #### Parameters -• **updater**: [`Updater`](updater.md)\<`TData`\> +• **updater**: [`Updater`](Updater.md)\<`TData`\> #### Returns @@ -213,7 +213,7 @@ Handles the change event. #### Defined in -[packages/form-core/src/FieldApi.ts:949](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L949) +[packages/form-core/src/FieldApi.ts:949](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L949) *** @@ -242,7 +242,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri #### Defined in -[packages/form-core/src/FieldApi.ts:655](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L655) +[packages/form-core/src/FieldApi.ts:655](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L655) *** @@ -264,7 +264,7 @@ Mounts the field instance to the form. #### Defined in -[packages/form-core/src/FieldApi.ts:517](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L517) +[packages/form-core/src/FieldApi.ts:517](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L517) *** @@ -293,7 +293,7 @@ Moves the value at the first specified index to the second specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:685](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L685) +[packages/form-core/src/FieldApi.ts:685](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L685) *** @@ -317,7 +317,7 @@ Pushes a new value to the field. #### Defined in -[packages/form-core/src/FieldApi.ts:647](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L647) +[packages/form-core/src/FieldApi.ts:647](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L647) *** @@ -341,7 +341,7 @@ Removes a value at the specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:673](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L673) +[packages/form-core/src/FieldApi.ts:673](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L673) *** @@ -370,7 +370,7 @@ Replaces a value at the specified index. #### Defined in -[packages/form-core/src/FieldApi.ts:664](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L664) +[packages/form-core/src/FieldApi.ts:664](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L664) *** @@ -384,7 +384,7 @@ Sets the field metadata. #### Parameters -• **updater**: [`Updater`](updater.md)\<[`FieldMeta`](fieldmeta.md)\> +• **updater**: [`Updater`](Updater.md)\<[`FieldMeta`](FieldMeta.md)\> #### Returns @@ -392,7 +392,7 @@ Sets the field metadata. #### Defined in -[packages/form-core/src/FieldApi.ts:636](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L636) +[packages/form-core/src/FieldApi.ts:636](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L636) *** @@ -406,7 +406,7 @@ Sets the field value and run the `change` validator. #### Parameters -• **updater**: [`Updater`](updater.md)\<`TData`\> +• **updater**: [`Updater`](Updater.md)\<`TData`\> • **options?**: `UpdateMetaOptions` @@ -416,7 +416,7 @@ Sets the field value and run the `change` validator. #### Defined in -[packages/form-core/src/FieldApi.ts:608](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L608) +[packages/form-core/src/FieldApi.ts:608](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L608) *** @@ -445,7 +445,7 @@ Swaps the values at the specified indices. #### Defined in -[packages/form-core/src/FieldApi.ts:679](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L679) +[packages/form-core/src/FieldApi.ts:679](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L679) *** @@ -459,7 +459,7 @@ Updates the field instance with new options. #### Parameters -• **opts**: [`FieldApiOptions`](fieldapioptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +• **opts**: [`FieldApiOptions`](FieldApiOptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> #### Returns @@ -467,7 +467,7 @@ Updates the field instance with new options. #### Defined in -[packages/form-core/src/FieldApi.ts:564](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L564) +[packages/form-core/src/FieldApi.ts:564](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L564) *** @@ -485,8 +485,8 @@ Validates the field value. #### Returns -[`ValidationError`](validationerror.md)[] \| `Promise`\<[`ValidationError`](validationerror.md)[]\> +[`ValidationError`](ValidationError.md)[] \| `Promise`\<[`ValidationError`](ValidationError.md)[]\> #### Defined in -[packages/form-core/src/FieldApi.ts:923](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L923) +[packages/form-core/src/FieldApi.ts:923](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L923) diff --git a/docs/reference/fieldapioptions.md b/docs/reference/FieldApiOptions.md similarity index 68% rename from docs/reference/fieldapioptions.md rename to docs/reference/FieldApiOptions.md index 53b2e87e2..27400204e 100644 --- a/docs/reference/fieldapioptions.md +++ b/docs/reference/FieldApiOptions.md @@ -9,19 +9,19 @@ An object type representing the required options for the FieldApi class. ## Extends -- [`FieldOptions`](fieldoptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +- [`FieldOptions`](FieldOptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> ## Type Parameters • **TParentData** -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> +• **TName** *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> -• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` +• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -• **TData** *extends* [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> +• **TData** *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> ## Properties @@ -35,11 +35,11 @@ If `true`, always run async validation, even if there are errors emitted during #### Inherited from -[`FieldOptions`](fieldoptions.md).[`asyncAlways`](Interface.FieldOptions.md#asyncalways) +[`FieldOptions`](FieldOptions.md).[`asyncAlways`](Interface.FieldOptions.md#asyncalways) #### Defined in -[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L284) +[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L284) *** @@ -53,11 +53,11 @@ The default time to debounce async validation if there is not a more specific de #### Inherited from -[`FieldOptions`](fieldoptions.md).[`asyncDebounceMs`](Interface.FieldOptions.md#asyncdebouncems) +[`FieldOptions`](FieldOptions.md).[`asyncDebounceMs`](Interface.FieldOptions.md#asyncdebouncems) #### Defined in -[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L280) +[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L280) *** @@ -71,11 +71,11 @@ An optional object with default metadata for the field. #### Inherited from -[`FieldOptions`](fieldoptions.md).[`defaultMeta`](Interface.FieldOptions.md#defaultmeta) +[`FieldOptions`](FieldOptions.md).[`defaultMeta`](Interface.FieldOptions.md#defaultmeta) #### Defined in -[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L302) +[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L302) *** @@ -89,11 +89,11 @@ An optional default value for the field. #### Inherited from -[`FieldOptions`](fieldoptions.md).[`defaultValue`](Interface.FieldOptions.md#defaultvalue) +[`FieldOptions`](FieldOptions.md).[`defaultValue`](Interface.FieldOptions.md#defaultvalue) #### Defined in -[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L276) +[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L276) *** @@ -105,7 +105,7 @@ form: FormApi; #### Defined in -[packages/form-core/src/FieldApi.ts:325](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L325) +[packages/form-core/src/FieldApi.ts:325](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L325) *** @@ -119,11 +119,11 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Inherited from -[`FieldOptions`](fieldoptions.md).[`name`](Interface.FieldOptions.md#name) +[`FieldOptions`](FieldOptions.md).[`name`](Interface.FieldOptions.md#name) #### Defined in -[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L272) +[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L272) *** @@ -137,11 +137,11 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Inherited from -[`FieldOptions`](fieldoptions.md).[`validatorAdapter`](Interface.FieldOptions.md#validatoradapter) +[`FieldOptions`](FieldOptions.md).[`validatorAdapter`](Interface.FieldOptions.md#validatoradapter) #### Defined in -[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L288) +[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L288) *** @@ -155,8 +155,8 @@ A list of validators to pass to the field #### Inherited from -[`FieldOptions`](fieldoptions.md).[`validators`](Interface.FieldOptions.md#validators) +[`FieldOptions`](FieldOptions.md).[`validators`](Interface.FieldOptions.md#validators) #### Defined in -[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L292) +[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L292) diff --git a/docs/reference/fieldinfo.md b/docs/reference/FieldInfo.md similarity index 92% rename from docs/reference/fieldinfo.md rename to docs/reference/FieldInfo.md index 45cae791b..8ea7bfe45 100644 --- a/docs/reference/fieldinfo.md +++ b/docs/reference/FieldInfo.md @@ -37,4 +37,4 @@ A record of field validation internal handling. ## Defined in -[packages/form-core/src/FormApi.ts:176](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L176) +[packages/form-core/src/FormApi.ts:176](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L176) diff --git a/docs/reference/fieldmeta.md b/docs/reference/FieldMeta.md similarity index 94% rename from docs/reference/fieldmeta.md rename to docs/reference/FieldMeta.md index 538960af7..4bc3dc341 100644 --- a/docs/reference/fieldmeta.md +++ b/docs/reference/FieldMeta.md @@ -63,4 +63,4 @@ A flag indicating whether the field is currently being validated. ## Defined in -[packages/form-core/src/FieldApi.ts:331](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L331) +[packages/form-core/src/FieldApi.ts:331](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L331) diff --git a/docs/reference/fieldoptions.md b/docs/reference/FieldOptions.md similarity index 73% rename from docs/reference/fieldoptions.md rename to docs/reference/FieldOptions.md index f90d81774..9e02fdb30 100644 --- a/docs/reference/fieldoptions.md +++ b/docs/reference/FieldOptions.md @@ -9,19 +9,19 @@ An object type representing the options for a field in a form. ## Extended by -- [`FieldApiOptions`](fieldapioptions.md) +- [`FieldApiOptions`](FieldApiOptions.md) ## Type Parameters • **TParentData** -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> +• **TName** *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> -• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` +• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -• **TData** *extends* [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> +• **TData** *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> ## Properties @@ -35,7 +35,7 @@ If `true`, always run async validation, even if there are errors emitted during #### Defined in -[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L284) +[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L284) *** @@ -49,7 +49,7 @@ The default time to debounce async validation if there is not a more specific de #### Defined in -[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L280) +[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L280) *** @@ -63,7 +63,7 @@ An optional object with default metadata for the field. #### Defined in -[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L302) +[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L302) *** @@ -77,7 +77,7 @@ An optional default value for the field. #### Defined in -[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L276) +[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L276) *** @@ -91,7 +91,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Defined in -[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L272) +[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L272) *** @@ -105,7 +105,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L288) +[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L288) *** @@ -119,4 +119,4 @@ A list of validators to pass to the field #### Defined in -[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L292) +[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L292) diff --git a/docs/reference/fieldstate.md b/docs/reference/FieldState.md similarity index 88% rename from docs/reference/fieldstate.md rename to docs/reference/FieldState.md index 6af4812d1..3bee65106 100644 --- a/docs/reference/fieldstate.md +++ b/docs/reference/FieldState.md @@ -35,4 +35,4 @@ The current value of the field. ## Defined in -[packages/form-core/src/FieldApi.ts:361](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L361) +[packages/form-core/src/FieldApi.ts:361](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L361) diff --git a/docs/reference/fieldvalidators.md b/docs/reference/FieldValidators.md similarity index 85% rename from docs/reference/fieldvalidators.md rename to docs/reference/FieldValidators.md index 2f2dc8f80..6907606ed 100644 --- a/docs/reference/fieldvalidators.md +++ b/docs/reference/FieldValidators.md @@ -9,13 +9,13 @@ title: FieldValidators • **TParentData** -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> +• **TName** *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> -• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` +• **TFieldValidator** *extends* `Validator`\<[`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined` • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -• **TData** *extends* [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> +• **TData** *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> ## Properties @@ -36,7 +36,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:196](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L196) +[packages/form-core/src/FieldApi.ts:196](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L196) *** @@ -57,7 +57,7 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:209](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L209) +[packages/form-core/src/FieldApi.ts:209](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L209) *** @@ -73,7 +73,7 @@ If set to a number larger than 0, will debounce the async validation event by th #### Defined in -[packages/form-core/src/FieldApi.ts:222](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L222) +[packages/form-core/src/FieldApi.ts:222](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L222) *** @@ -87,7 +87,7 @@ An optional list of field names that should trigger this field's `onBlur` and `o #### Defined in -[packages/form-core/src/FieldApi.ts:226](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L226) +[packages/form-core/src/FieldApi.ts:226](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L226) *** @@ -108,7 +108,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:160](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L160) +[packages/form-core/src/FieldApi.ts:160](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L160) *** @@ -129,7 +129,7 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:173](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L173) +[packages/form-core/src/FieldApi.ts:173](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L173) *** @@ -145,7 +145,7 @@ If set to a number larger than 0, will debounce the async validation event by th #### Defined in -[packages/form-core/src/FieldApi.ts:185](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L185) +[packages/form-core/src/FieldApi.ts:185](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L185) *** @@ -159,7 +159,7 @@ An optional list of field names that should trigger this field's `onChange` and #### Defined in -[packages/form-core/src/FieldApi.ts:189](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L189) +[packages/form-core/src/FieldApi.ts:189](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L189) *** @@ -173,7 +173,7 @@ An optional function that takes a param of `formApi` which is a generic type of #### Defined in -[packages/form-core/src/FieldApi.ts:147](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L147) +[packages/form-core/src/FieldApi.ts:147](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L147) *** @@ -194,7 +194,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:233](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L233) +[packages/form-core/src/FieldApi.ts:233](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L233) *** @@ -215,4 +215,4 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:246](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FieldApi.ts#L246) +[packages/form-core/src/FieldApi.ts:246](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FieldApi.ts#L246) diff --git a/docs/reference/formapi.md b/docs/reference/FormApi.md similarity index 79% rename from docs/reference/formapi.md rename to docs/reference/FormApi.md index 73e2468d9..9d938539e 100644 --- a/docs/reference/formapi.md +++ b/docs/reference/FormApi.md @@ -29,15 +29,15 @@ Constructs a new `FormApi` instance with the given form options. #### Parameters -• **opts?**: [`FormOptions`](formoptions.md)\<`TFormData`, `TFormValidator`\> +• **opts?**: [`FormOptions`](FormOptions.md)\<`TFormData`, `TFormValidator`\> #### Returns -[`FormApi`](formapi.md)\<`TFormData`, `TFormValidator`\> +[`FormApi`](FormApi.md)\<`TFormData`, `TFormValidator`\> #### Defined in -[packages/form-core/src/FormApi.ts:345](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L345) +[packages/form-core/src/FormApi.ts:345](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L345) ## Properties @@ -51,7 +51,7 @@ A record of field information for each field in the form. #### Defined in -[packages/form-core/src/FormApi.ts:334](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L334) +[packages/form-core/src/FormApi.ts:334](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L334) *** @@ -65,7 +65,7 @@ The options for the form. #### Defined in -[packages/form-core/src/FormApi.ts:318](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L318) +[packages/form-core/src/FormApi.ts:318](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L318) *** @@ -83,7 +83,7 @@ Please use form.useStore() utility to subscribe to state #### Defined in -[packages/form-core/src/FormApi.ts:330](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L330) +[packages/form-core/src/FormApi.ts:330](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L330) *** @@ -97,7 +97,7 @@ A [TanStack Store instance](https://tanstack.com/store/latest/docs/reference/Sto #### Defined in -[packages/form-core/src/FormApi.ts:322](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L322) +[packages/form-core/src/FormApi.ts:322](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L322) ## Methods @@ -121,7 +121,7 @@ deleteField(field): void #### Defined in -[packages/form-core/src/FormApi.ts:925](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L925) +[packages/form-core/src/FormApi.ts:925](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L925) *** @@ -143,11 +143,11 @@ Gets the field info of the specified field. #### Returns -[`FieldInfo`](fieldinfo.md)\<`TFormData`, `TFormValidator`\> +[`FieldInfo`](FieldInfo.md)\<`TFormData`, `TFormValidator`\> #### Defined in -[packages/form-core/src/FormApi.ts:843](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L843) +[packages/form-core/src/FormApi.ts:843](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L843) *** @@ -169,11 +169,11 @@ Gets the metadata of the specified field. #### Returns -`undefined` \| [`FieldMeta`](fieldmeta.md) +`undefined` \| [`FieldMeta`](FieldMeta.md) #### Defined in -[packages/form-core/src/FormApi.ts:834](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L834) +[packages/form-core/src/FormApi.ts:834](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L834) *** @@ -195,11 +195,11 @@ Gets the value of the specified field. #### Returns -[`DeepValue`](deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> +[`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> #### Defined in -[packages/form-core/src/FormApi.ts:827](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L827) +[packages/form-core/src/FormApi.ts:827](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L827) *** @@ -217,7 +217,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu #### Defined in -[packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L767) +[packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L767) *** @@ -243,7 +243,7 @@ Inserts a value into an array field at the specified index, shifting the subsequ • **index**: `number` -• **value**: [`DeepValue`](deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` +• **value**: [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` • **opts?**: `UpdateMetaOptions` @@ -253,7 +253,7 @@ Inserts a value into an array field at the specified index, shifting the subsequ #### Defined in -[packages/form-core/src/FormApi.ts:957](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L957) +[packages/form-core/src/FormApi.ts:957](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L957) *** @@ -269,7 +269,7 @@ mount(): void #### Defined in -[packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L443) +[packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L443) *** @@ -305,7 +305,7 @@ Moves the value at the first specified index to the second specified index withi #### Defined in -[packages/form-core/src/FormApi.ts:1075](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L1075) +[packages/form-core/src/FormApi.ts:1075](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L1075) *** @@ -328,7 +328,7 @@ Pushes a value into an array field. • **field**: `TField` -• **value**: [`DeepValue`](deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` +• **value**: [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` • **opts?**: `UpdateMetaOptions` @@ -338,7 +338,7 @@ Pushes a value into an array field. #### Defined in -[packages/form-core/src/FormApi.ts:939](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L939) +[packages/form-core/src/FormApi.ts:939](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L939) *** @@ -371,7 +371,7 @@ Removes a value from an array field at the specified index. #### Defined in -[packages/form-core/src/FormApi.ts:1010](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L1010) +[packages/form-core/src/FormApi.ts:1010](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L1010) *** @@ -397,7 +397,7 @@ Replaces a value into an array field at the specified index. • **index**: `number` -• **value**: [`DeepValue`](deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` +• **value**: [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` • **opts?**: `UpdateMetaOptions` @@ -407,7 +407,7 @@ Replaces a value into an array field at the specified index. #### Defined in -[packages/form-core/src/FormApi.ts:984](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L984) +[packages/form-core/src/FormApi.ts:984](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L984) *** @@ -425,7 +425,7 @@ Resets the form state to the default values. #### Defined in -[packages/form-core/src/FormApi.ts:505](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L505) +[packages/form-core/src/FormApi.ts:505](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L505) *** @@ -441,15 +441,15 @@ resetFieldMeta(fieldMeta): Record #### Parameters -• **fieldMeta**: `Record`\<`TField`, [`FieldMeta`](fieldmeta.md)\> +• **fieldMeta**: `Record`\<`TField`, [`FieldMeta`](FieldMeta.md)\> #### Returns -`Record`\<`TField`, [`FieldMeta`](fieldmeta.md)\> +`Record`\<`TField`, [`FieldMeta`](FieldMeta.md)\> #### Defined in -[packages/form-core/src/FormApi.ts:877](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L877) +[packages/form-core/src/FormApi.ts:877](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L877) *** @@ -469,7 +469,7 @@ Updates the metadata of the specified field. • **field**: `TField` -• **updater**: [`Updater`](updater.md)\<[`FieldMeta`](fieldmeta.md)\> +• **updater**: [`Updater`](Updater.md)\<[`FieldMeta`](FieldMeta.md)\> #### Returns @@ -477,7 +477,7 @@ Updates the metadata of the specified field. #### Defined in -[packages/form-core/src/FormApi.ts:862](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L862) +[packages/form-core/src/FormApi.ts:862](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L862) *** @@ -500,7 +500,7 @@ Sets the value of the specified field and optionally updates the touched state. • **field**: `TField` -• **updater**: [`Updater`](updater.md)\<[`DeepValue`](deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\> +• **updater**: [`Updater`](Updater.md)\<[`DeepValue`](DeepValue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\> • **opts?**: `UpdateMetaOptions` @@ -510,7 +510,7 @@ Sets the value of the specified field and optionally updates the touched state. #### Defined in -[packages/form-core/src/FormApi.ts:900](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L900) +[packages/form-core/src/FormApi.ts:900](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L900) *** @@ -546,7 +546,7 @@ Swaps the values at the specified indices within an array field. #### Defined in -[packages/form-core/src/FormApi.ts:1049](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L1049) +[packages/form-core/src/FormApi.ts:1049](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L1049) *** @@ -560,7 +560,7 @@ Updates the form options and form state. #### Parameters -• **options?**: [`FormOptions`](formoptions.md)\<`TFormData`, `TFormValidator`\> +• **options?**: [`FormOptions`](FormOptions.md)\<`TFormData`, `TFormValidator`\> #### Returns @@ -568,7 +568,7 @@ Updates the form options and form state. #### Defined in -[packages/form-core/src/FormApi.ts:465](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L465) +[packages/form-core/src/FormApi.ts:465](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L465) *** @@ -586,11 +586,11 @@ Validates all fields in the form using the correct handlers for a given validati #### Returns -`Promise`\<[`ValidationError`](validationerror.md)[]\> +`Promise`\<[`ValidationError`](ValidationError.md)[]\> #### Defined in -[packages/form-core/src/FormApi.ts:520](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L520) +[packages/form-core/src/FormApi.ts:520](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L520) *** @@ -619,11 +619,11 @@ Validates the children of a specified array in the form starting from a given in #### Returns -`Promise`\<[`ValidationError`](validationerror.md)[]\> +`Promise`\<[`ValidationError`](ValidationError.md)[]\> #### Defined in -[packages/form-core/src/FormApi.ts:547](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L547) +[packages/form-core/src/FormApi.ts:547](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L547) *** @@ -647,8 +647,8 @@ Validates a specified field in the form using the correct handlers for a given v #### Returns -[`ValidationError`](validationerror.md)[] \| `Promise`\<[`ValidationError`](validationerror.md)[]\> +[`ValidationError`](ValidationError.md)[] \| `Promise`\<[`ValidationError`](ValidationError.md)[]\> #### Defined in -[packages/form-core/src/FormApi.ts:586](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L586) +[packages/form-core/src/FormApi.ts:586](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L586) diff --git a/docs/reference/FormOptions.md b/docs/reference/FormOptions.md new file mode 100644 index 000000000..65b3593dc --- /dev/null +++ b/docs/reference/FormOptions.md @@ -0,0 +1,162 @@ +--- +id: FormOptions +title: FormOptions +--- + +# Interface: FormOptions\ + +An object representing the options for a form. + +## Type Parameters + +• **TFormData** + +• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` + +## Properties + +### asyncAlways? + +```ts +optional asyncAlways: boolean; +``` + +If true, always run async validation, even when sync validation has produced an error. Defaults to undefined. + +#### Defined in + +[packages/form-core/src/FormApi.ts:133](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L133) + +*** + +### asyncDebounceMs? + +```ts +optional asyncDebounceMs: number; +``` + +Optional time in milliseconds if you want to introduce a delay before firing off an async action. + +#### Defined in + +[packages/form-core/src/FormApi.ts:137](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L137) + +*** + +### defaultState? + +```ts +optional defaultState: Partial>; +``` + +The default state for the form. + +#### Defined in + +[packages/form-core/src/FormApi.ts:129](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L129) + +*** + +### defaultValues? + +```ts +optional defaultValues: TFormData; +``` + +Set initial values for your form. + +#### Defined in + +[packages/form-core/src/FormApi.ts:125](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L125) + +*** + +### onSubmit()? + +```ts +optional onSubmit: (props) => any; +``` + +A function to be called when the form is submitted, what should happen once the user submits a valid form returns `any` or a promise `Promise` + +#### Parameters + +• **props** + +• **props.formApi**: [`FormApi`](FormApi.md)\<`TFormData`, `TFormValidator`\> + +• **props.value**: `TFormData` + +#### Returns + +`any` + +#### Defined in + +[packages/form-core/src/FormApi.ts:149](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L149) + +*** + +### onSubmitInvalid()? + +```ts +optional onSubmitInvalid: (props) => void; +``` + +Specify an action for scenarios where the user tries to submit an invalid form. + +#### Parameters + +• **props** + +• **props.formApi**: [`FormApi`](FormApi.md)\<`TFormData`, `TFormValidator`\> + +• **props.value**: `TFormData` + +#### Returns + +`void` + +#### Defined in + +[packages/form-core/src/FormApi.ts:156](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L156) + +*** + +### transform? + +```ts +optional transform: FormTransform; +``` + +#### Defined in + +[packages/form-core/src/FormApi.ts:160](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L160) + +*** + +### validatorAdapter? + +```ts +optional validatorAdapter: TFormValidator; +``` + +A validator adapter to support usage of extra validation types (IE: Zod, Yup, or Valibot usage) + +#### Defined in + +[packages/form-core/src/FormApi.ts:141](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L141) + +*** + +### validators? + +```ts +optional validators: FormValidators; +``` + +A list of validators to pass to the form + +#### Defined in + +[packages/form-core/src/FormApi.ts:145](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L145) diff --git a/docs/reference/formstate.md b/docs/reference/FormState.md similarity index 97% rename from docs/reference/formstate.md rename to docs/reference/FormState.md index dfd7f07da..94b296103 100644 --- a/docs/reference/formstate.md +++ b/docs/reference/FormState.md @@ -163,4 +163,4 @@ The current values of the form fields. ## Defined in -[packages/form-core/src/FormApi.ts:198](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L198) +[packages/form-core/src/FormApi.ts:198](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L198) diff --git a/docs/reference/formvalidators.md b/docs/reference/FormValidators.md similarity index 83% rename from docs/reference/formvalidators.md rename to docs/reference/FormValidators.md index 0917c642a..55fa9bd7b 100644 --- a/docs/reference/formvalidators.md +++ b/docs/reference/FormValidators.md @@ -23,7 +23,7 @@ Optional function that validates the form data when a field loses focus, returns #### Defined in -[packages/form-core/src/FormApi.ts:89](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L89) +[packages/form-core/src/FormApi.ts:89](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L89) *** @@ -37,7 +37,7 @@ Optional onBlur asynchronous validation method for when a field loses focus retu #### Defined in -[packages/form-core/src/FormApi.ts:93](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L93) +[packages/form-core/src/FormApi.ts:93](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L93) *** @@ -51,7 +51,7 @@ The default time in milliseconds that if set to a number larger than 0, will deb #### Defined in -[packages/form-core/src/FormApi.ts:97](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L97) +[packages/form-core/src/FormApi.ts:97](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L97) *** @@ -65,7 +65,7 @@ Optional function that checks the validity of your data whenever a value changes #### Defined in -[packages/form-core/src/FormApi.ts:77](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L77) +[packages/form-core/src/FormApi.ts:77](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L77) *** @@ -79,7 +79,7 @@ Optional onChange asynchronous counterpart to onChange. Useful for more complex #### Defined in -[packages/form-core/src/FormApi.ts:81](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L81) +[packages/form-core/src/FormApi.ts:81](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L81) *** @@ -93,7 +93,7 @@ The default time in milliseconds that if set to a number larger than 0, will deb #### Defined in -[packages/form-core/src/FormApi.ts:85](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L85) +[packages/form-core/src/FormApi.ts:85](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L85) *** @@ -107,7 +107,7 @@ Optional function that fires as soon as the component mounts. #### Defined in -[packages/form-core/src/FormApi.ts:73](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L73) +[packages/form-core/src/FormApi.ts:73](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L73) *** @@ -119,7 +119,7 @@ optional onSubmit: FormValidateOrFn; #### Defined in -[packages/form-core/src/FormApi.ts:98](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L98) +[packages/form-core/src/FormApi.ts:98](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L98) *** @@ -131,4 +131,4 @@ optional onSubmitAsync: FormAsyncValidateOrFn; #### Defined in -[packages/form-core/src/FormApi.ts:99](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L99) +[packages/form-core/src/FormApi.ts:99](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L99) diff --git a/docs/reference/updater.md b/docs/reference/Updater.md similarity index 83% rename from docs/reference/updater.md rename to docs/reference/Updater.md index b1e56ff90..dd8e6f586 100644 --- a/docs/reference/updater.md +++ b/docs/reference/Updater.md @@ -17,4 +17,4 @@ type Updater: TOutput | UpdaterFn; ## Defined in -[packages/form-core/src/utils.ts:7](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/utils.ts#L7) +[packages/form-core/src/utils.ts:7](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/utils.ts#L7) diff --git a/docs/reference/updaterfn.md b/docs/reference/UpdaterFn.md similarity index 85% rename from docs/reference/updaterfn.md rename to docs/reference/UpdaterFn.md index 217f66572..5c8f1daf6 100644 --- a/docs/reference/updaterfn.md +++ b/docs/reference/UpdaterFn.md @@ -25,4 +25,4 @@ type UpdaterFn: (input) => TOutput; ## Defined in -[packages/form-core/src/utils.ts:5](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/utils.ts#L5) +[packages/form-core/src/utils.ts:5](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/utils.ts#L5) diff --git a/docs/reference/validationerror.md b/docs/reference/ValidationError.md similarity index 79% rename from docs/reference/validationerror.md rename to docs/reference/ValidationError.md index 659be7cf0..bf3395870 100644 --- a/docs/reference/validationerror.md +++ b/docs/reference/ValidationError.md @@ -11,4 +11,4 @@ type ValidationError: undefined | false | null | string; ## Defined in -[packages/form-core/src/types.ts:1](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/types.ts#L1) +[packages/form-core/src/types.ts:1](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/types.ts#L1) diff --git a/docs/reference/validationmeta.md b/docs/reference/ValidationMeta.md similarity index 88% rename from docs/reference/validationmeta.md rename to docs/reference/ValidationMeta.md index 31a4c721c..aaae801cb 100644 --- a/docs/reference/validationmeta.md +++ b/docs/reference/ValidationMeta.md @@ -23,4 +23,4 @@ An abort controller stored in memory to cancel previous async validation attempt ## Defined in -[packages/form-core/src/FormApi.ts:166](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/FormApi.ts#L166) +[packages/form-core/src/FormApi.ts:166](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/FormApi.ts#L166) diff --git a/docs/reference/formoptions.md b/docs/reference/formOptions.md similarity index 72% rename from docs/reference/formoptions.md rename to docs/reference/formOptions.md index 642b33ae6..c9c1ad01c 100644 --- a/docs/reference/formoptions.md +++ b/docs/reference/formOptions.md @@ -17,12 +17,12 @@ function formOptions(defaultOpts?): undefined | FormO ## Parameters -• **defaultOpts?**: [`FormOptions`](formoptions.md)\<`TFormData`, `TFormValidator`\> +• **defaultOpts?**: [`FormOptions`](FormOptions.md)\<`TFormData`, `TFormValidator`\> ## Returns -`undefined` \| [`FormOptions`](formoptions.md)\<`TFormData`, `TFormValidator`\> +`undefined` \| [`FormOptions`](FormOptions.md)\<`TFormData`, `TFormValidator`\> ## Defined in -[packages/form-core/src/formOptions.ts:4](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/formOptions.ts#L4) +[packages/form-core/src/formOptions.ts:4](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/formOptions.ts#L4) diff --git a/docs/reference/index.md b/docs/reference/index.md index 161fbc60b..c14fc1f05 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -7,31 +7,31 @@ title: "@tanstack/form-core" ## Classes -- [FieldApi](fieldapi.md) -- [FormApi](formapi.md) +- [FieldApi](FieldApi.md) +- [FormApi](FormApi.md) ## Interfaces -- [FieldApiOptions](fieldapioptions.md) -- [FieldOptions](fieldoptions.md) -- [FieldValidators](fieldvalidators.md) -- [FormOptions](formoptions.md) -- [FormValidators](formvalidators.md) +- [FieldApiOptions](FieldApiOptions.md) +- [FieldOptions](FieldOptions.md) +- [FieldValidators](FieldValidators.md) +- [FormOptions](FormOptions.md) +- [FormValidators](FormValidators.md) ## Type Aliases -- [DeepKeys](deepkeys.md) -- [DeepValue](deepvalue.md) -- [FieldInfo](fieldinfo.md) -- [FieldMeta](fieldmeta.md) -- [FieldState](fieldstate.md) -- [FormState](formstate.md) -- [Updater](updater.md) -- [UpdaterFn](updaterfn.md) -- [ValidationError](validationerror.md) -- [ValidationMeta](validationmeta.md) +- [DeepKeys](DeepKeys.md) +- [DeepValue](DeepValue.md) +- [FieldInfo](FieldInfo.md) +- [FieldMeta](FieldMeta.md) +- [FieldState](FieldState.md) +- [FormState](FormState.md) +- [Updater](Updater.md) +- [UpdaterFn](UpdaterFn.md) +- [ValidationError](ValidationError.md) +- [ValidationMeta](ValidationMeta.md) ## Functions -- [formOptions](formoptions.md) -- [mergeForm](mergeform.md) +- [formOptions](formOptions.md) +- [mergeForm](mergeForm.md) diff --git a/docs/reference/mergeform.md b/docs/reference/mergeForm.md similarity index 67% rename from docs/reference/mergeform.md rename to docs/reference/mergeForm.md index 2639b964d..28258e9a1 100644 --- a/docs/reference/mergeform.md +++ b/docs/reference/mergeForm.md @@ -17,14 +17,14 @@ function mergeForm(baseForm, state): FormApi, `NoInfer`\<`TFormValidator`\>\> +• **baseForm**: [`FormApi`](FormApi.md)\<`NoInfer`\<`TFormData`\>, `NoInfer`\<`TFormValidator`\>\> -• **state**: `Partial`\<[`FormState`](formstate.md)\<`TFormData`\>\> +• **state**: `Partial`\<[`FormState`](FormState.md)\<`TFormData`\>\> ## Returns -[`FormApi`](formapi.md)\<`NoInfer`\<`TFormData`\>, `NoInfer`\<`TFormValidator`\>\> +[`FormApi`](FormApi.md)\<`NoInfer`\<`TFormData`\>, `NoInfer`\<`TFormValidator`\>\> ## Defined in -[packages/form-core/src/mergeForm.ts:37](https://github.com/TanStack/form/blob/a7956e9367e8bea8c62bd25c618aa3ad9194b14d/packages/form-core/src/mergeForm.ts#L37) +[packages/form-core/src/mergeForm.ts:37](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/form-core/src/mergeForm.ts#L37) diff --git a/scripts/typedoc-remove-prefix.js b/scripts/typedoc-remove-prefix.js index 14c5e2b67..fe00189d7 100644 --- a/scripts/typedoc-remove-prefix.js +++ b/scripts/typedoc-remove-prefix.js @@ -29,7 +29,7 @@ export function load(app) { if (name[0] !== 'index') { name.splice(0, 1) } - const newBasename = name.join('.').toLowerCase() + const newBasename = name.join('.') urlMapping.url = newBasename urlMapping.model.url = newBasename return urlMapping