// Copyright 2019-2024 Tauri Programme within The Commons Conservancy // SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: MIT import { MenuItemOptions, SubmenuOptions, IconMenuItemOptions, PredefinedMenuItemOptions, CheckMenuItemOptions } from '../menu' import { MenuItem } from './menuItem' import { CheckMenuItem } from './checkMenuItem' import { IconMenuItem } from './iconMenuItem' import { PredefinedMenuItem } from './predefinedMenuItem' import { Submenu } from './submenu' import { type LogicalPosition, PhysicalPosition } from '../dpi' import { type Window } from '../window' import { invoke } from '../core' import { type ItemKind, MenuItemBase, newMenu } from './base' function itemFromKind([rid, id, kind]: [number, string, ItemKind]): | Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem { /* eslint-disable @typescript-eslint/no-unsafe-return */ switch (kind) { case 'Submenu': // @ts-expect-error constructor is protected for external usage only return new Submenu(rid, id) case 'Predefined': // @ts-expect-error constructor is protected for external usage only return new PredefinedMenuItem(rid, id) case 'Check': // @ts-expect-error constructor is protected for external usage only return new CheckMenuItem(rid, id) case 'Icon': // @ts-expect-error constructor is protected for external usage only return new IconMenuItem(rid, id) case 'MenuItem': default: // @ts-expect-error constructor is protected for external usage only return new MenuItem(rid, id) } /* eslint-enable @typescript-eslint/no-unsafe-return */ } /** Options for creating a new menu. */ export interface MenuOptions { /** Specify an id to use for the new menu. */ id?: string /** List of items to add to the new menu. */ items?: Array< | Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem | MenuItemOptions | SubmenuOptions | IconMenuItemOptions | PredefinedMenuItemOptions | CheckMenuItemOptions > } /** A type that is either a menu bar on the window * on Windows and Linux or as a global menu in the menubar on macOS. */ export class Menu extends MenuItemBase { /** @ignore */ protected constructor(rid: number, id: string) { super(rid, id, 'Menu') } /** Create a new menu. */ static async new(opts?: MenuOptions): Promise { return newMenu('Menu', opts).then(([rid, id]) => new Menu(rid, id)) } /** Create a default menu. */ static async default(): Promise { return invoke<[number, string]>('plugin:menu|create_default').then( ([rid, id]) => new Menu(rid, id) ) } /** * Add a menu item to the end of this menu. * * #### Platform-specific: * * - **macOS:** Only {@linkcode Submenu}s can be added to a {@linkcode Menu}. */ async append< T extends | Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem | MenuItemOptions | SubmenuOptions | IconMenuItemOptions | PredefinedMenuItemOptions | CheckMenuItemOptions >(items: T | T[]): Promise { return invoke('plugin:menu|append', { rid: this.rid, kind: this.kind, items: (Array.isArray(items) ? items : [items]).map((i) => 'rid' in i ? [i.rid, i.kind] : i ) }) } /** * Add a menu item to the beginning of this menu. * * #### Platform-specific: * * - **macOS:** Only {@linkcode Submenu}s can be added to a {@linkcode Menu}. */ async prepend< T extends | Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem | MenuItemOptions | SubmenuOptions | IconMenuItemOptions | PredefinedMenuItemOptions | CheckMenuItemOptions >(items: T | T[]): Promise { return invoke('plugin:menu|prepend', { rid: this.rid, kind: this.kind, items: (Array.isArray(items) ? items : [items]).map((i) => 'rid' in i ? [i.rid, i.kind] : i ) }) } /** * Add a menu item to the specified position in this menu. * * #### Platform-specific: * * - **macOS:** Only {@linkcode Submenu}s can be added to a {@linkcode Menu}. */ async insert< T extends | Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem | MenuItemOptions | SubmenuOptions | IconMenuItemOptions | PredefinedMenuItemOptions | CheckMenuItemOptions >(items: T | T[], position: number): Promise { return invoke('plugin:menu|insert', { rid: this.rid, kind: this.kind, items: (Array.isArray(items) ? items : [items]).map((i) => 'rid' in i ? [i.rid, i.kind] : i ), position }) } /** Remove a menu item from this menu. */ async remove( item: Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem ): Promise { return invoke('plugin:menu|remove', { rid: this.rid, kind: this.kind, item: [item.rid, item.kind] }) } /** Remove a menu item from this menu at the specified position. */ async removeAt( position: number ): Promise< | Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem | null > { return invoke<[number, string, ItemKind]>('plugin:menu|remove_at', { rid: this.rid, kind: this.kind, position }).then(itemFromKind) } /** Returns a list of menu items that has been added to this menu. */ async items(): Promise< Array< Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem > > { return invoke>('plugin:menu|items', { rid: this.rid, kind: this.kind }).then((i) => i.map(itemFromKind)) } /** Retrieves the menu item matching the given identifier. */ async get( id: string ): Promise< | Submenu | MenuItem | PredefinedMenuItem | CheckMenuItem | IconMenuItem | null > { return invoke<[number, string, ItemKind] | null>('plugin:menu|get', { rid: this.rid, kind: this.kind, id }).then((r) => (r ? itemFromKind(r) : null)) } /** * Popup this menu as a context menu on the specified window. * * If the position, is provided, it is relative to the window's top-left corner. */ async popup( at?: PhysicalPosition | LogicalPosition, window?: Window ): Promise { return invoke('plugin:menu|popup', { rid: this.rid, kind: this.kind, window: window?.label ?? null, at }) } /** * Sets the app-wide menu and returns the previous one. * * If a window was not created with an explicit menu or had one set explicitly, * this menu will be assigned to it. */ async setAsAppMenu(): Promise { return invoke<[number, string] | null>('plugin:menu|set_as_app_menu', { rid: this.rid }).then((r) => (r ? new Menu(r[0], r[1]) : null)) } /** * Sets the window menu and returns the previous one. * * #### Platform-specific: * * - **macOS:** Unsupported. The menu on macOS is app-wide and not specific to one * window, if you need to set it, use {@linkcode Menu.setAsAppMenu} instead. */ async setAsWindowMenu(window?: Window): Promise { return invoke<[number, string] | null>('plugin:menu|set_as_window_menu', { rid: this.rid, window: window?.label ?? null }).then((r) => (r ? new Menu(r[0], r[1]) : null)) } }