# useTerminalField

Source: /tuil/docs/reference/packages/form/api/use-terminal-field
Locale: en

function exported by @mwillbanks/tuil-form.



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

## function [#function]

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

```ts
export function useTerminalField<T>(
  options: TerminalFieldOptions<T>,
): TerminalFieldBinding<T>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                      | Required | Description                                                | Related types                                                                      |
| --------- | ------------------------- | -------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `options` | `TerminalFieldOptions<T>` | Yes      | Supplies the `options` value as `TerminalFieldOptions<T>`. | [`TerminalFieldOptions`](/tuil/docs/reference/packages/form/api/terminal-field-options) |

## Returns [#returns]

`TerminalFieldBinding<T>` — Returns a value that satisfies `TerminalFieldBinding<T>`.

Related types: [`TerminalFieldBinding`](/tuil/docs/reference/packages/form/api/terminal-field-binding)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalFieldBinding`](/tuil/docs/reference/packages/form/api/terminal-field-binding)
* [`TerminalFieldOptions`](/tuil/docs/reference/packages/form/api/terminal-field-options)

## 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)