blessed-components - v1.20.0
    Preparing search index...

    Interface ScrollAreaData

    Stateful content, offset, keyboard, and theme data accepted by ScrollArea.

    interface ScrollAreaData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        characters?: ScrollAreaCharacters;
        contentHeight: number;
        defaultOffset?: number;
        focusedCharacters?: ScrollAreaCharacters;
        onOffsetChange?: (offset: number) => void;
        offset?: number;
        pageOverlap?: number;
        showScrollbar?: boolean;
        scrollbarTone?: keyof ThemeColors;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? foregroundTone? theme? characters? contentHeight defaultOffset? focusedCharacters? onOffsetChange? offset? pageOverlap? showScrollbar? scrollbarTone?

    Properties

    capabilities?: Pick<TerminalCapabilities, "colorLevel">

    Explicit color capability used for deterministic rendering.

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    foregroundTone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    theme?: Theme

    Semantic terminal theme.

    characters?: ScrollAreaCharacters

    Scrollbar track and thumb characters.

    contentHeight: number

    Total content height in rows.

    defaultOffset?: number

    Initial offset for uncontrolled usage.

    focusedCharacters?: ScrollAreaCharacters

    Scrollbar characters used while the root owns focus.

    onOffsetChange?: (offset: number) => void

    Called when user or imperative input requests a new offset.

    offset?: number

    Controlled vertical offset.

    Visual state changes only after a new value reaches setData().

    pageOverlap?: number

    Rows retained between page operations.

    1

    showScrollbar?: boolean

    Whether one stable column is reserved for the scrollbar.

    true

    scrollbarTone?: keyof ThemeColors

    Semantic foreground token for the scrollbar.

    'muted'

    Settings

    Member Visibility

    On This Page

    Properties