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

    Interface RouteTabsData<TItem>

    Stateful data accepted by the Blessed routeTabs adapter.

    interface RouteTabsData<TItem extends RouteTabItem = RouteTabItem> {
        activeId?: string;
        capabilities?: Pick<TerminalCapabilities, "unicode">;
        characters?: RouteTabsCharacters;
        defaultRouteId?: string;
        emptyText?: string;
        items: readonly TItem[];
        onActiveIdChange?: (routeId: string) => void;
        onClose?: (item: TItem) => void;
        onNavigate?: (routeId: string) => void;
        routeId?: string;
        separator?: string;
    }

    Type Parameters

    Index

    Properties

    activeId? capabilities? characters? defaultRouteId? emptyText? items onActiveIdChange? onClose? onNavigate? routeId? separator?

    Properties

    activeId?: string

    Preferred initial keyboard-focus route.

    capabilities?: Pick<TerminalCapabilities, "unicode">

    Terminal capabilities used to select Unicode or ASCII characters.

    characters?: RouteTabsCharacters

    Character tokens used by the pure renderer.

    defaultRouteId?: string

    Initial route for uncontrolled usage. Ignored when routeId is supplied.

    emptyText?: string

    Text displayed when no routes are open.

    items: readonly TItem[]

    Ordered open routes.

    onActiveIdChange?: (routeId: string) => void

    Called after keyboard focus moves to a different enabled route.

    onClose?: (item: TItem) => void

    Called when a closeable focused route requests closing.

    onNavigate?: (routeId: string) => void

    Called when a focused route requests navigation.

    routeId?: string

    Controlled current route identifier.

    separator?: string

    Text inserted between route tabs.

    Settings

    Member Visibility

    On This Page

    Properties