Interface ScrollAreaHandle

Imperative handle returned by scrollArea.

interface ScrollAreaHandle {
    contentElement: BoxElement;
    scrollbarElement: BoxElement;
    end(): number;
    focus(): void;
    home(): number;
    lineBackward(amount?: number): number;
    lineForward(amount?: number): number;
    metrics(): ScrollAreaMetrics;
    offset(): number;
    pageBackward(): number;
    pageForward(): number;
    resize(): ScrollAreaMetrics;
    scrollTo(offset: number): number;
    element: BoxElement;
    destroy(): void;
    setData(data: ScrollAreaData): void;
}

Hierarchy (View Summary)

BlessedComponentHandle<ScrollAreaData, blessed.Widgets.BoxElement>
- ScrollAreaHandle

Index

Properties

contentElement scrollbarElement element

Methods

end focus home lineBackward lineForward metrics offset pageBackward pageForward resize scrollTo destroy setData

Properties

`Readonly`contentElement

contentElement: BoxElement

Inner translated element receiving caller-owned children.

`Readonly`scrollbarElement

scrollbarElement: BoxElement

Visible scrollbar element.

`Readonly`element

element: BoxElement

Underlying Blessed element available for standard element operations.

Methods

end

end(): number
Moves to maximum offset.

Returns number
- Defined in adapters/blessed/scroll-area.ts:73

focus

focus(): void
Gives terminal focus to the scrollable root.

Returns void
- Defined in adapters/blessed/scroll-area.ts:76

home

home(): number
Moves to offset zero.

Returns number
- Defined in adapters/blessed/scroll-area.ts:79

lineBackward

lineBackward(amount?: number): number
Moves backward by one or more rows.
Parameters
- Optionalamount: number
Returns number
- Defined in adapters/blessed/scroll-area.ts:82

lineForward

lineForward(amount?: number): number
Moves forward by one or more rows.
Parameters
- Optionalamount: number
Returns number
- Defined in adapters/blessed/scroll-area.ts:85

metrics

metrics(): ScrollAreaMetrics
Returns current headless scrollbar metrics.

Returns ScrollAreaMetrics
- Defined in adapters/blessed/scroll-area.ts:88

offset

offset(): number
Returns current visual offset.

Returns number
- Defined in adapters/blessed/scroll-area.ts:91

pageBackward

pageBackward(): number
Moves backward by one page.

Returns number
- Defined in adapters/blessed/scroll-area.ts:94

pageForward

pageForward(): number
Moves forward by one page.

Returns number
- Defined in adapters/blessed/scroll-area.ts:97

resize

resize(): ScrollAreaMetrics
Re-measures available dimensions.

Returns ScrollAreaMetrics
- Defined in adapters/blessed/scroll-area.ts:100

scrollTo

scrollTo(offset: number): number
Moves to an absolute offset.
Parameters
- offset: number
Returns number
- Defined in adapters/blessed/scroll-area.ts:103

destroy

destroy(): void
Destroys and detaches the owned element without destroying its parent.

Returns void
Inherited from BlessedComponentHandle.destroy
- Defined in adapters/blessed/types.ts:23

setData

setData(data: ScrollAreaData): void
Re-renders component content using complete replacement data.

The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.
Parameters
- data: ScrollAreaData
Returns void
Inherited from BlessedComponentHandle.setData
- Defined in adapters/blessed/types.ts:31