mlx-bun library API
    Preparing search index...

    Interface Shell

    interface Shell {
        controllers: Partial<Record<string, RouteController>>;
        overlays: Overlays;
        shortcuts: ShortcutSheet;
        currentRoute(): string;
        isDeveloperMode(): boolean;
        markUnavailable(id: string): void;
        mountPanels(panels: readonly ShellPanel[]): void;
        navigate(): void;
        panelTargets(): readonly { id: string; title: string }[];
        setDeveloperMode(on: boolean): void;
        start(options?: ShellStart): void;
        updateTabFades(): void;
    }
    Index
    controllers overlays shortcuts
    currentRoute isDeveloperMode markUnavailable mountPanels navigate panelTargets setDeveloperMode start updateTabFades
    controllers: Partial<Record<string, RouteController>>

    Page controllers by route id; hosts fill it before the first navigation.

    overlays: Overlays

    What Escape closes.

    shortcuts: ShortcutSheet

    • Hides a route's tab for good (a page the build does not carry); the host decides what its page shows instead.

      Parameters

      • id: string

      Returns void

    • Navigation targets for the (non-workspace) panels mounted so far.

      Returns readonly { id: string; title: string }[]

    Settings
    Member Visibility

    On This Page
    Properties
    Methods