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

    Interface PageData

    Stateful data accepted by the Blessed page adapter.

    interface PageData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        actions?: string;
        content?: string;
        gap?: number;
        footer?: string;
        footerHeight?: number;
        headerHeight?: number;
        subtitle?: string;
        title: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? foregroundTone? theme? actions? content? gap? footer? footerHeight? headerHeight? subtitle? title

    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.

    actions?: string

    Optional right-aligned header command or status text.

    Optionalcontent

    content?: string

    Main body text managed by the adapter.

    gap?: number

    Empty rows between header/body/footer regions.

    0

    footer?: string

    Footer text managed by the adapter.

    footerHeight?: number

    Footer height in terminal rows.

    0 when footer is empty, otherwise 1

    headerHeight?: number

    Header height in terminal rows.

    1

    subtitle?: string

    Optional supporting title text.

    title: string

    Non-empty page title.

    Settings

    Member Visibility

    On This Page

    Properties