platform-bible-utils
    Preparing search index...

    Type Alias WebViewMenu

    Menus for one single web view

    type WebViewMenu = {
        contextMenu: SingleColumnMenu | undefined;
        includeDefaults: boolean | undefined;
        isExperimental?: boolean;
        tabMenu?: SingleColumnMenu;
        topMenu: MultiColumnMenu | undefined;
    }
    Index

    Properties

    contextMenu: SingleColumnMenu | undefined

    Menu that opens when you right click on the main body/area of a tab

    includeDefaults: boolean | undefined

    Indicates whether the platform default top and context menus should be included for this web view.

    This does not govern the tab menu. Its items act on the tab frame rather than on the web view's contents, so the platform's tab items are included whatever this says — see WebViewMenu.tabMenu.

    isExperimental?: boolean

    Set to true to mark this WebView menu as experimental. Experimental menu content may change or be removed without notice. Extensions reading this should treat the marker as informational.

    Menu that opens when you right click on the tab itself, rather than on its contents.

    Items here act on the tab, so they are offered on every tab — including tabs that host no web view. Absent means this web view contributes nothing of its own, and the tab shows the platform items alone; unlike the menus above, there is no opting out of those.

    Some platform items in this menu carry a command that names an action the tab menu performs itself rather than a registered PAPI command — platform.floatTab moves the tab into a float panel within its own window, which never leaves the renderer. Treat a command here as the name of the action, not as something to invoke through the command service.

    The platform's own groups here sit at orders 50 and 100, so choose another order for yours. A single-column menu buckets every group together for the duplicate-order check, so a second group at 100 throws — and because a failed contribution is rolled back whole, that would cost this extension its entire menus.json, not just its tab items.

    This menu is unstable and may change or disappear without notice

    topMenu: MultiColumnMenu | undefined

    Menu that opens when you click on the top left corner of a tab