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

    Interface PreformattedData

    Stateful data accepted by the Blessed preformatted adapter.

    interface PreformattedData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        onOffsetChange?: (
            offsets: { horizontalOffset: number; verticalOffset: number },
        ) => void;
        pageOverlap?: number;
        tone?: keyof ThemeColors;
        content: string;
        height?: number;
        horizontalOffset?: number;
        verticalOffset?: number;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? onOffsetChange? pageOverlap? tone? content height? horizontalOffset? verticalOffset? width?

    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'

    theme?: Theme

    Semantic terminal theme.

    onOffsetChange?: (
        offsets: { horizontalOffset: number; verticalOffset: number },
    ) => void

    Called when horizontal or vertical offsets change.

    pageOverlap?: number

    Rows retained between page operations.

    1

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    content

    content: string

    Multiline content. ANSI sequences and Blessed tags are removed.

    height?: number

    Maximum rendered line count.

    horizontalOffset?: number

    Horizontal cell offset applied before width clipping.

    0

    verticalOffset?: number

    Vertical line offset applied before height clipping.

    0

    width?: number

    Maximum rendered width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties