mlx-bun library API
    Preparing search index...

    Interface ShellPanel

    One panel to mount: a module manifest's panel (tag, title, path; @mlx-bun/app-core's PanelSpec is assignable) plus the connection the host built for it.

    interface ShellPanel {
        connection: PanelConnection;
        developer?: boolean;
        framed?: boolean;
        overlay?: boolean;
        path: string;
        properties?: Readonly<Record<string, unknown>>;
        tag: string;
        title: string;
        workspace?: boolean;
    }
    Index
    connection developer? framed? overlay? path properties? tag title workspace?
    connection: PanelConnection
    developer?: boolean

    Listed among the developer tools (hidden until the Developer switch is on). Default true, false for a workspace.

    framed?: boolean

    False when the panel supplies its own scroll column, heading and cards. Default true.

    overlay?: boolean

    Companion overlay, mounted immediately without a route or tab.

    path: string

    Declared shell route: one lowercase kebab-case segment.

    properties?: Readonly<Record<string, unknown>>

    Further properties the host sets on the element before it attaches, for what a panel takes from its host beyond its connection.

    tag: string

    Custom element tag, mlx-<module id>-panel.

    title: string
    workspace?: boolean

    The product's own page rather than a tool: it fills the page (no title or card), is listed first, sits outside the Developer switch, and stays attached while another page is shown, so what it holds (a stream, a turn in flight) survives a visit elsewhere. The element hears enter() and leave() as its page is shown and hidden.

    Settings
    Member Visibility

    On This Page
    Properties