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

    Interface TimelineData

    Stateful data accepted by the Blessed timeline adapter.

    interface TimelineData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        markers?: StatusMarkers;
        emptyText?: string;
        items: readonly TimelineItem[];
        offset?: number;
        showMarker?: boolean;
        showTimestamp?: boolean;
        locale?: string;
        timeZone?: string;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? foregroundTone? theme? capabilities? markers? emptyText? items offset? showMarker? showTimestamp? locale? timeZone?

    Properties

    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.

    capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">

    Explicit terminal capabilities used for deterministic rendering.

    markers?: StatusMarkers

    Custom semantic markers.

    emptyText?: string

    Text displayed when no items exist.

    items: readonly TimelineItem[]

    Ordered timeline items. Caller-owned data is never mutated.

    offset?: number

    First rendered item index.

    showMarker?: boolean

    Whether to include semantic markers.

    true

    showTimestamp?: boolean

    Whether to include timestamps when present.

    true

    locale?: string
    timeZone?: string

    Settings

    Member Visibility

    On This Page

    Properties