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

    Interface RouteTabsHandle<TItem>

    Imperative handle returned by routeTabs.

    interface RouteTabsHandle<TItem extends RouteTabItem = RouteTabItem> {
        activeId(): string | undefined;
        closeActive(): string | undefined;
        closeRoute(routeId: string): string | undefined;
        first(): string | undefined;
        focus(): void;
        focusRoute(routeId: string): string | undefined;
        last(): string | undefined;
        navigateActive(): string | undefined;
        next(): string | undefined;
        previous(): string | undefined;
        routeId(): string | undefined;
        element: BoxElement;
        destroy(): void;
        setData(data: RouteTabsData): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Requests closing a specific route when it is closeable.

      Parameters

      • routeId: string

      Returns string | undefined

    • Moves keyboard focus to an enabled route.

      Parameters

      • routeId: string

      Returns string | undefined

    • Moves focus to the previous enabled route, wrapping at the start.

      Returns string | undefined