# useTerminalInput

Source: /tuil/docs/reference/packages/ink/api/use-terminal-input
Locale: en

export exported by @mwillbanks/tuil-ink.



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

## export [#export]

Public export exported by `@mwillbanks/tuil-ink`.

```ts
export function useTerminalInput(
  handler: TerminalInputHandler,
  options: {
    readonly enabled?: boolean;
    readonly priority?: number;
    readonly layerId?: string;
  } = {},
): void;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                                                                                                             | Required | Description                                                                                                                                       | Related types                                                                     |
| --------- | ---------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `handler` | `TerminalInputHandler`                                                                                           | Yes      | Supplies the `handler` value as `TerminalInputHandler`.                                                                                           | [`TerminalInputHandler`](/tuil/docs/reference/packages/ink/api/terminal-input-handler) |
| `options` | `{     readonly enabled?: boolean;     readonly priority?: number;     readonly layerId?: string;   }` | No       | Supplies the `options` value as `{     readonly enabled?: boolean;     readonly priority?: number;     readonly layerId?: string;   }`. | —                                                                                 |

## Returns [#returns]

`void` — Returns a value that satisfies `void`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalInputHandler`](/tuil/docs/reference/packages/ink/api/terminal-input-handler)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ink/src/input.ts)

## Package [#package]

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