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

    Interface ViewportData

    Stateful dimensions, offset, and theme accepted by viewport.

    interface ViewportData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        contentHeight: number;
        contentWidth: number;
        x?: number;
        y?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? foregroundTone? theme? contentHeight contentWidth x? y?

    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.

    contentHeight: number

    Total content height in rows.

    contentWidth: number

    Total content width in cells.

    x?: number

    Optional absolute horizontal offset.

    y?: number

    Optional absolute vertical offset.

    Settings

    Member Visibility

    On This Page

    Properties