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

    Interface BreadcrumbBarData<TAction>

    Shared semantic style data accepted by themed Blessed adapters.

    interface BreadcrumbBarData<
        TAction extends BreadcrumbBarAction = BreadcrumbBarAction,
    > {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        activeTarget?: BreadcrumbBarTarget;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        onAction?: (action: TAction) => void;
        onNavigateSibling?: (
            sibling: BreadcrumbBarSibling,
            direction: "next" | "previous",
        ) => void;
        onActiveTargetChange?: (target: BreadcrumbBarTarget) => void;
        width?: number;
        actions?: readonly TAction[];
        items: readonly BreadcrumbItem[];
        nextSibling?: BreadcrumbBarSibling;
        pad?: boolean;
        previousSibling?: BreadcrumbBarSibling;
        separator?: string;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    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.

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

    Explicit color capability used for deterministic rendering.

    onAction?: (action: TAction) => void
    onNavigateSibling?: (
        sibling: BreadcrumbBarSibling,
        direction: "next" | "previous",
    ) => void
    onActiveTargetChange?: (target: BreadcrumbBarTarget) => void
    width?: number
    actions?: readonly TAction[]
    items: readonly BreadcrumbItem[]

    Ordered location path.

    nextSibling?: BreadcrumbBarSibling
    pad?: boolean
    previousSibling?: BreadcrumbBarSibling
    separator?: string