Skip to main content

MenusPort

MenusPort creates and manages context menu items that appear when the user right-clicks on page content, links, or the extension icon.

Context​

  • Availability: Background
  • Source: packages/ports/src/background/menus/menus.port.ts

Key Methods​

  • create(createProperties: WebExtMenusCreateProperties): string | number - Add a new context menu item.
  • update(id: string | number, updateProperties: Partial<WebExtMenusCreateProperties>): Promise<void> - Modify an existing menu item.
  • remove(id: string | number): Promise<void> - Remove a single menu item.
  • removeAll(): Promise<void> - Remove all extension-created menu items.
  • onClickedAddListener(listener: (info: any, tab?: WebExtTab) => void): void - Subscribe to menu item click events.
  • onClickedRemoveListener(listener: (info: any, tab?: WebExtTab) => void): void - Unsubscribe from click events.

Usage​

import { MenusPort } from '@hexajs-dev/ports';
import { Injectable, HexaContext } from '@hexajs-dev/common';

@Injectable({ context: HexaContext.Background })
export class ContextMenuService {
  constructor(private readonly menus: MenusPort) {}

  registerMenus() {
    this.menus.create({
      id: 'save-selection',
      title: 'Save to HexaClip',
      contexts: ['selection'],
    });
    this.menus.onClickedAddListener((info) => {
      if (info.menuItemId === 'save-selection') {
        this.handleSave(info.selectionText);
      }
    });
  }

  private handleSave(text?: string) {}
}

API Reference Appendix​

Below is the exhaustive, auto-generated technical reference for all types, interfaces, and signatures associated with this API.

Classes​

import { MenusPort } from '@hexajs-dev/ports';
class MenusPort { ... }

Methods​

create()

create(createProperties: HexaWebMenusCreateProperties): string | number

onClickedAddListener()

onClickedAddListener(listener: (info: any, tab?: HexaWebTab) => void): void

onClickedRemoveListener()

onClickedRemoveListener(listener: (info: any, tab?: HexaWebTab) => void): void

remove()

remove(id: string | number): Promise<void>

removeAll()

removeAll(): Promise<void>

update()

update(id: string | number, updateProperties: Partial<HexaWebMenusCreateProperties>): Promise<void>