Interface RenderScrollAreaScrollbarOptions

Options accepted by renderScrollAreaScrollbar.

interface RenderScrollAreaScrollbarOptions {
    characters?: ScrollAreaCharacters;
    contentSize: number;
    viewportSize: number;
    offset: number;
    thumbOffset: number;
    thumbSize: number;
}

Hierarchy (View Summary)

ScrollAreaMetrics
- RenderScrollAreaScrollbarOptions

Index

Properties

characters? contentSize viewportSize offset thumbOffset thumbSize

Properties

`Optional`characters

characters?: ScrollAreaCharacters

Track and thumb characters.

Default Value

{ track: '│', thumb: '█' }

contentSize

contentSize: number

Total number of cells or rows in the content.

viewportSize

viewportSize: number

Number of visible cells or rows.

offset

offset: number

Current bounded content offset.

thumbOffset

thumbOffset: number

Scrollbar thumb start within a track equal to viewportSize.

thumbSize

thumbSize: number

Scrollbar thumb length within a track equal to viewportSize.