# AdaptedTanStackField

Source: /tuil/docs/reference/packages/form/api/adapted-tan-stack-field
Locale: en

interface exported by @mwillbanks/tuil-form.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-form`.

```ts
export interface AdaptedTanStackField<T> {
  readonly name: string;
  readonly value: T;
  readonly errors: readonly string[];
  readonly touched: boolean;
  readonly dirty: boolean;
  readonly validating: boolean;
  readonly setValue: (value: T) => void;
  readonly blur: () => void;
  readonly validate: (cause: "change" | "blur" | "submit") => Promise<void>;
  readonly reset: () => void;
  readonly subscribe: (observer: () => void) => () => void;
}
```

## Members [#members]

| Member       | Type                                                       | Required | Description                                                                                         | Related types |
| ------------ | ---------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- | ------------- |
| `name`       | `string`                                                   | Yes      | The `name` member uses the `string` contract.                                                       | —             |
| `value`      | `T`                                                        | Yes      | The `value` member uses the `T` contract.                                                           | —             |
| `errors`     | `readonly string[]`                                        | Yes      | The `errors` member uses the `readonly string[]` contract.                                          | —             |
| `touched`    | `boolean`                                                  | Yes      | The `touched` member uses the `boolean` contract.                                                   | —             |
| `dirty`      | `boolean`                                                  | Yes      | The `dirty` member uses the `boolean` contract.                                                     | —             |
| `validating` | `boolean`                                                  | Yes      | The `validating` member uses the `boolean` contract.                                                | —             |
| `setValue`   | `(value: T) => void`                                       | Yes      | The `setValue` member uses the `(value: T) => void` contract.                                       | —             |
| `blur`       | `() => void`                                               | Yes      | The `blur` member uses the `() => void` contract.                                                   | —             |
| `validate`   | `(cause: "change" \| "blur" \| "submit") => Promise<void>` | Yes      | The `validate` member uses the `(cause: "change" \| "blur" \| "submit") => Promise<void>` contract. | —             |
| `reset`      | `() => void`                                               | Yes      | The `reset` member uses the `() => void` contract.                                                  | —             |
| `subscribe`  | `(observer: () => void) => () => void`                     | Yes      | The `subscribe` member uses the `(observer: () => void) => () => void` contract.                    | —             |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/form/src/index.tsx)

## Package [#package]

[@mwillbanks/tuil-form](/tuil/docs/reference/packages/form)