mlx-bun library API
    Preparing search index...

    Interface PanelSpec

    A self-contained web component the host mounts, in its own shell or a Tauri, Electron or Swift webview. It imports only its module's panel files and data protocol, and reaches the backend only through its connection.

    interface PanelSpec {
        developer?: boolean;
        entry: string;
        framed?: boolean;
        overlay?: boolean;
        path: string;
        tag: string;
        title: string;
        workspace?: boolean;
    }
    Index
    developer? entry framed? overlay? path tag title workspace?
    developer?: boolean

    Listed among developer tools by default; false for a panel every user needs.

    Readonlyentry

    entry: string

    Package export that defines the element when imported, e.g. @mlx-bun/module-transcription/panel.

    framed?: boolean

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

    overlay?: boolean

    Persistent companion overlay, mounted without a route or navigation tab.

    path: string

    Declared shell route: one lowercase kebab-case segment, preserving an existing path when migrated.

    tag: string

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

    title: string
    workspace?: boolean

    A workspace panel is the product's own page: it fills the shell's page instead of sitting in a titled card, is listed first and stays outside the Developer switch. Default false.

    Settings
    Member Visibility

    On This Page
    Properties