Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/framework/angular/guides/basic-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ onCountryChange: FieldListenerFn<any, any, any, any, string> = ({
}
```

More information can be found at [Listeners](../listeners.md)
More information can be found at [Listeners](./listeners.md)

## Array Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/guides/submission-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export class AppComponent {

## Transforming data with Standard Schemas

While Tanstack Form provides [Standard Schema support](../validation.md) for validation, it does not preserve the Schema's output data.
While Tanstack Form provides [Standard Schema support](./validation.md) for validation, it does not preserve the Schema's output data.

The value passed to the `onSubmit` function will always be the input data. To receive the output data of a Standard Schema, parse it in the `onSubmit` function:

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/guides/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ TanStack Form natively supports all libraries following the [Standard Schema spe

_Note:_ make sure to use the latest version of the schema libraries as older versions might not support Standard Schema yet.

> Validation will not provide you with transformed values. See [submission handling](../submission-handling.md) for more information.
> Validation will not provide you with transformed values. See [submission handling](./submission-handling.md) for more information.

To use schemas from these libraries you can pass them to the `validators` props as you would do with a custom function:

Expand Down
36 changes: 18 additions & 18 deletions docs/framework/angular/reference/classes/TanStackAppField.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Defined in: [app-field.ts:20](https://github.com/TanStack/form/blob/main/package

## Extends

- [`TanStackField`](../TanStackField.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\>
- [`TanStackField`](TanStackField.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\>

## Type Parameters

Expand Down Expand Up @@ -121,7 +121,7 @@ Defined in: [app-field.ts:79](https://github.com/TanStack/form/blob/main/package

#### Overrides

[`TanStackField`](../TanStackField.md).[`constructor`](../TanStackField.md#constructor)
[`TanStackField`](TanStackField.md).[`constructor`](TanStackField.md#constructor)

## Properties

Expand All @@ -135,7 +135,7 @@ Defined in: [tanstack-field.ts:151](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`_api`](../TanStackField.md#_api)
[`TanStackField`](TanStackField.md).[`_api`](TanStackField.md#_api)

***

Expand All @@ -149,7 +149,7 @@ Defined in: [tanstack-field.ts:76](https://github.com/TanStack/form/blob/main/pa

#### Inherited from

[`TanStackField`](../TanStackField.md).[`asyncAlways`](../TanStackField.md#asyncalways)
[`TanStackField`](TanStackField.md).[`asyncAlways`](TanStackField.md#asyncalways)

***

Expand All @@ -163,7 +163,7 @@ Defined in: [tanstack-field.ts:73](https://github.com/TanStack/form/blob/main/pa

#### Inherited from

[`TanStackField`](../TanStackField.md).[`asyncDebounceMs`](../TanStackField.md#asyncdebouncems)
[`TanStackField`](TanStackField.md).[`asyncDebounceMs`](TanStackField.md#asyncdebouncems)

***

Expand All @@ -187,7 +187,7 @@ Defined in: [tanstack-field.ts:238](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`cd`](../TanStackField.md#cd)
[`TanStackField`](TanStackField.md).[`cd`](TanStackField.md#cd)

***

Expand All @@ -203,7 +203,7 @@ Defined in: [tanstack-field.ts:118](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`defaultMeta`](../TanStackField.md#defaultmeta)
[`TanStackField`](TanStackField.md).[`defaultMeta`](TanStackField.md#defaultmeta)

***

Expand All @@ -217,7 +217,7 @@ Defined in: [tanstack-field.ts:72](https://github.com/TanStack/form/blob/main/pa

#### Inherited from

[`TanStackField`](../TanStackField.md).[`defaultValue`](../TanStackField.md#defaultvalue)
[`TanStackField`](TanStackField.md).[`defaultValue`](TanStackField.md#defaultvalue)

***

Expand All @@ -231,7 +231,7 @@ Defined in: [tanstack-field.ts:149](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`disableErrorFlat`](../TanStackField.md#disableerrorflat)
[`TanStackField`](TanStackField.md).[`disableErrorFlat`](TanStackField.md#disableerrorflat)

***

Expand All @@ -245,7 +245,7 @@ Defined in: [tanstack-field.ts:222](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`injector`](../TanStackField.md#injector)
[`TanStackField`](TanStackField.md).[`injector`](TanStackField.md#injector)

***

Expand All @@ -261,7 +261,7 @@ Defined in: [tanstack-field.ts:117](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`listeners`](../TanStackField.md#listeners)
[`TanStackField`](TanStackField.md).[`listeners`](TanStackField.md#listeners)

***

Expand All @@ -275,7 +275,7 @@ Defined in: [tanstack-field.ts:147](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`mode`](../TanStackField.md#mode)
[`TanStackField`](TanStackField.md).[`mode`](TanStackField.md#mode)

***

Expand All @@ -289,7 +289,7 @@ Defined in: [tanstack-field.ts:71](https://github.com/TanStack/form/blob/main/pa

#### Inherited from

[`TanStackField`](../TanStackField.md).[`name`](../TanStackField.md#name)
[`TanStackField`](TanStackField.md).[`name`](TanStackField.md#name)

***

Expand All @@ -303,7 +303,7 @@ Defined in: [tanstack-field.ts:183](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`options`](../TanStackField.md#options)
[`TanStackField`](TanStackField.md).[`options`](TanStackField.md#options)

***

Expand All @@ -317,7 +317,7 @@ Defined in: [tanstack-field.ts:79](https://github.com/TanStack/form/blob/main/pa

#### Inherited from

[`TanStackField`](../TanStackField.md).[`tanstackField`](../TanStackField.md#tanstackfield)
[`TanStackField`](TanStackField.md).[`tanstackField`](TanStackField.md#tanstackfield)

***

Expand All @@ -333,7 +333,7 @@ Defined in: [tanstack-field.ts:97](https://github.com/TanStack/form/blob/main/pa

#### Inherited from

[`TanStackField`](../TanStackField.md).[`validators`](../TanStackField.md#validators)
[`TanStackField`](TanStackField.md).[`validators`](TanStackField.md#validators)

## Accessors

Expand All @@ -353,7 +353,7 @@ Defined in: [tanstack-field.ts:155](https://github.com/TanStack/form/blob/main/p

#### Inherited from

[`TanStackField`](../TanStackField.md).[`api`](../TanStackField.md#api)
[`TanStackField`](TanStackField.md).[`api`](TanStackField.md#api)

## Methods

Expand All @@ -377,4 +377,4 @@ It is invoked only once when the directive is instantiated.

#### Inherited from

[`TanStackField`](../TanStackField.md).[`ngOnInit`](../TanStackField.md#ngoninit)
[`TanStackField`](TanStackField.md).[`ngOnInit`](TanStackField.md#ngoninit)
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/classes/TanStackField.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Defined in: [tanstack-field.ts:37](https://github.com/TanStack/form/blob/main/pa

## Extended by

- [`TanStackAppField`](../TanStackAppField.md)
- [`TanStackAppField`](TanStackAppField.md)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectField.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Defined in: [injectable.ts:39](https://github.com/TanStack/form/blob/main/packag

## Returns

[`TanStackFieldInjectable`](../../classes/TanStackFieldInjectable.md)\<`T`\>
[`TanStackFieldInjectable`](../classes/TanStackFieldInjectable.md)\<`T`\>
12 changes: 6 additions & 6 deletions docs/framework/angular/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ title: "@tanstack/angular-form"

## Classes

- [TanStackAppField](../classes/TanStackAppField.md)
- [TanStackField](../classes/TanStackField.md)
- [TanStackFieldInjectable](../classes/TanStackFieldInjectable.md)
- [TanStackAppField](classes/TanStackAppField.md)
- [TanStackField](classes/TanStackField.md)
- [TanStackFieldInjectable](classes/TanStackFieldInjectable.md)

## Functions

- [injectField](../functions/injectField.md)
- [injectForm](../functions/injectForm.md)
- [injectStore](../functions/injectStore.md)
- [injectField](functions/injectField.md)
- [injectForm](functions/injectForm.md)
- [injectStore](functions/injectStore.md)
2 changes: 1 addition & 1 deletion docs/framework/lit/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ title: "@tanstack/lit-form"

## Classes

- [TanStackFormController](../classes/TanStackFormController.md)
- [TanStackFormController](classes/TanStackFormController.md)
2 changes: 1 addition & 1 deletion docs/framework/react/guides/basic-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Example:
/>
```

More information can be found at [Listeners](../listeners.md)
More information can be found at [Listeners](./listeners.md)

## Array Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/guides/focus-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Focus Management

In some instances, you may want to focus the first input with an error.

[Because TanStack Form intentionally does not have insights into your markup](../../../../philosophy.md), we cannot add a built-in focus management feature.
[Because TanStack Form intentionally does not have insights into your markup](../../../philosophy.md), we cannot add a built-in focus management feature.

However, you can easily add this feature into your application without this hypothetical built-in feature.

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/guides/form-composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ const ChildForm = withForm({

## Reusing groups of fields in multiple forms

Sometimes, a pair of fields are so closely related that it makes sense to group and reuse them — like the password example listed in the [linked fields guide](../linked-fields.md). Instead of repeating this logic across multiple forms, you can utilize the `withFieldGroup` higher-order component.
Sometimes, a pair of fields are so closely related that it makes sense to group and reuse them — like the password example listed in the [linked fields guide](./linked-fields.md). Instead of repeating this logic across multiple forms, you can utilize the `withFieldGroup` higher-order component.

> Unlike `withForm`, validators cannot be specified and could be any value.
> Ensure that your fields can accept unknown error types.
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/guides/reactivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If you would like to access reactive values, you will need to subscribe to them

Some uses for these subscriptions are rendering up-to-date field values, determining what to render based on a condition, or using field values inside the logic of your component.

> For situations where you want to "react" to triggers, check out the [listener](../listeners.md) API.
> For situations where you want to "react" to triggers, check out the [listener](./listeners.md) API.

## useStore

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/react/guides/ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ This section focuses on integrating TanStack Form with `Next.js`, particularly u

- Start a new `Next.js` project, following the steps in the [Next.js Documentation](https://nextjs.org/docs/getting-started/installation). Ensure you select `yes` for `Would you like to use App Router?` during the setup to access all new features provided by Next.js.
- Install `@tanstack/react-form`
- Install any [form validator](../validation#validation-through-schema-libraries) of your choice. [Optional]
- Install any [form validator](./validation#validation-through-schema-libraries) of your choice. [Optional]

## App Router integration

Expand Down Expand Up @@ -338,7 +338,7 @@ Here, we're using [React's `useActionState` hook](https://playfulprogramming.com

- Start a new `Remix` project, following the steps in the [Remix Documentation](https://remix.run/docs/en/main/start/quickstart).
- Install `@tanstack/react-form`
- Install any [form validator](../validation#validation-through-schema-libraries) of your choice. [Optional]
- Install any [form validator](./validation#validation-through-schema-libraries) of your choice. [Optional]

## Remix integration

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/guides/submission-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ function App() {

## Transforming data with Standard Schemas

While Tanstack Form provides [Standard Schema support](../validation.md) for validation, it does not preserve the Schema's output data.
While Tanstack Form provides [Standard Schema support](./validation.md) for validation, it does not preserve the Schema's output data.

The value passed to the `onSubmit` function will always be the input data. To receive the output data of a Standard Schema, parse it in the `onSubmit` function:

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/guides/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ TanStack Form natively supports all libraries following the [Standard Schema spe

_Note:_ make sure to use the latest version of the schema libraries as older versions might not support Standard Schema yet.

> Validation will not provide you with transformed values. See [submission handling](../submission-handling.md) for more information.
> Validation will not provide you with transformed values. See [submission handling](./submission-handling.md) for more information.

To use schemas from these libraries you can pass them to the `validators` props as you would do with a custom function:

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Quick Start

TanStack Form is unlike most form libraries you've used before. It's designed for large-scale production usage, with a focus on type safety, performance and composition for an unmatched developer experience.

As a result, we've developed [a philosophy around the library's usage](../../../philosophy.md) that values scalability and long-term developer experience over short and sharable code snippets.
As a result, we've developed [a philosophy around the library's usage](../../philosophy.md) that values scalability and long-term developer experience over short and sharable code snippets.

Here's an example of a form following many of our best practices, which will allow you to rapidly develop even high-complexity forms after a short onboarding experience:

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/react/reference/functions/createFormHook.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ withFieldGroup: <TFieldGroupData, TSubmitMeta, TRenderProps>(__namedParameters)

##### \_\_namedParameters

[`WithFieldGroupProps`](../../interfaces/WithFieldGroupProps.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\>
[`WithFieldGroupProps`](../interfaces/WithFieldGroupProps.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\>

#### Returns

Expand Down Expand Up @@ -261,7 +261,7 @@ withForm: <TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync

##### \_\_namedParameters

[`WithFormProps`](../../interfaces/WithFormProps.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`, `TRenderProps`\>
[`WithFormProps`](../interfaces/WithFormProps.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`, `TRenderProps`\>

#### Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ useFormContext: () => ReactFormExtendedApi<Record<string, never>, any, any, any,

#### Returns

[`ReactFormExtendedApi`](../../type-aliases/ReactFormExtendedApi.md)\<`Record`\<`string`, `never`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>
[`ReactFormExtendedApi`](../type-aliases/ReactFormExtendedApi.md)\<`Record`\<`string`, `never`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>
2 changes: 1 addition & 1 deletion docs/framework/react/reference/functions/useField.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ A hook for managing a field in a form.

### opts

[`UseFieldOptions`](../../interfaces/UseFieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TPatentSubmitMeta`\>
[`UseFieldOptions`](../interfaces/UseFieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TPatentSubmitMeta`\>

An object with field options.

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/reference/functions/useForm.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ This API encapsulates all the necessary functionalities related to the form. It

## Returns

[`ReactFormExtendedApi`](../../type-aliases/ReactFormExtendedApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
[`ReactFormExtendedApi`](../type-aliases/ReactFormExtendedApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>
34 changes: 17 additions & 17 deletions docs/framework/react/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,29 @@ title: "@tanstack/react-form"

## Interfaces

- [ReactFormApi](../interfaces/ReactFormApi.md)
- [UseFieldOptions](../interfaces/UseFieldOptions.md)
- [UseFieldOptionsBound](../interfaces/UseFieldOptionsBound.md)
- [WithFieldGroupProps](../interfaces/WithFieldGroupProps.md)
- [WithFormProps](../interfaces/WithFormProps.md)
- [ReactFormApi](interfaces/ReactFormApi.md)
- [UseFieldOptions](interfaces/UseFieldOptions.md)
- [UseFieldOptionsBound](interfaces/UseFieldOptionsBound.md)
- [WithFieldGroupProps](interfaces/WithFieldGroupProps.md)
- [WithFormProps](interfaces/WithFormProps.md)

## Type Aliases

- [FieldComponent](../type-aliases/FieldComponent.md)
- [LensFieldComponent](../type-aliases/LensFieldComponent.md)
- [ReactFormExtendedApi](../type-aliases/ReactFormExtendedApi.md)
- [ServerFormState](../type-aliases/ServerFormState.md)
- [UseField](../type-aliases/UseField.md)
- [FieldComponent](type-aliases/FieldComponent.md)
- [LensFieldComponent](type-aliases/LensFieldComponent.md)
- [ReactFormExtendedApi](type-aliases/ReactFormExtendedApi.md)
- [ServerFormState](type-aliases/ServerFormState.md)
- [UseField](type-aliases/UseField.md)

## Variables

- [Field](../variables/Field.md)
- [Field](variables/Field.md)

## Functions

- [createFormHook](../functions/createFormHook.md)
- [createFormHookContexts](../functions/createFormHookContexts.md)
- [useField](../functions/useField.md)
- [useFieldGroup](../functions/useFieldGroup.md)
- [useForm](../functions/useForm.md)
- [useStore](../functions/useStore.md)
- [createFormHook](functions/createFormHook.md)
- [createFormHookContexts](functions/createFormHookContexts.md)
- [useField](functions/useField.md)
- [useFieldGroup](functions/useFieldGroup.md)
- [useForm](functions/useForm.md)
- [useStore](functions/useStore.md)
Loading
Loading