ReferencePackages@mwillbanks/tuil-inkAPI

useTerminalScrollArea

function exported by @mwillbanks/tuil-ink.

function

Public function exported by @mwillbanks/tuil-ink.

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

Members

This declaration has no public members.

Parameters

Member	Type	Required	Description	Related types
`options`	`TerminalScrollAreaOptions`	Yes	Supplies the `options` value as `TerminalScrollAreaOptions`.	`TerminalScrollAreaOptions`

Returns

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

Related types: ScrollAreaState, ScrollSnapshot

Throws

No thrown errors are documented for this declaration.

TerminalScrollAreaOptions

Source

View the secondary source reference

Package

@mwillbanks/tuil-ink

useTerminalInput

export exported by @mwillbanks/tuil-ink.

useTerminalSize

function exported by @mwillbanks/tuil-ink.

useTerminalScrollArea

On this page