# useTerminalScrollArea

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

function exported by @mwillbanks/tuil-ink.



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

## function [#function]

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

```ts
export function useTerminalScrollArea(options: TerminalScrollAreaOptions): {
  readonly state: ScrollAreaState;
  readonly snapshot: ScrollSnapshot;
};
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                        | Required | Description                                                  | Related types                                                                                |
| --------- | --------------------------- | -------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------- |
| `options` | `TerminalScrollAreaOptions` | Yes      | Supplies the `options` value as `TerminalScrollAreaOptions`. | [`TerminalScrollAreaOptions`](/tuil/docs/reference/packages/ink/api/terminal-scroll-area-options) |

## Returns [#returns]

`{
  readonly state: ScrollAreaState;
  readonly snapshot: ScrollSnapshot;
}` — Returns a value that satisfies `{
  readonly state: ScrollAreaState;
  readonly snapshot: ScrollSnapshot;
}`.

Related types: [`ScrollAreaState`](/tuil/docs/reference/packages/scroll/api/scroll-area-state), [`ScrollSnapshot`](/tuil/docs/reference/packages/scroll/api/scroll-snapshot)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalScrollAreaOptions`](/tuil/docs/reference/packages/ink/api/terminal-scroll-area-options)

## Source [#source]

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

## Package [#package]

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