Class ContextMenu

constructor

• new ContextMenu(
      container: any,
      selector: string,
      menuItems: ContextMenuEntry[],
      options?: ContextMenuOptions,
  ): ContextMenu

  Parameters

  • container: any

    The HTML element that contains the context menu targets.

  • selector: string

    A CSS selector which activates the context menu.

  • menuItems: ContextMenuEntry[]

    An Array of entries to display in the menu

  • Optionaloptions: ContextMenuOptions = {}

    Additional options to configure the context menu.

  Returns ContextMenu

menuItems

onClose

onOpen

element

• get element(): HTMLElement

  The menu element.

  Returns HTMLElement

eventName

• get eventName(): string

  The event name to listen for.

  Returns string

expandUp

• get expandUp(): boolean

  Check which direction the menu is expanded in.

  Returns boolean

fixed

• get fixed(): boolean

  Whether to position the context menu as a fixed element, or inject it into the target.

  Returns boolean

relative

• get relative(): "target" | "cursor"

  For fixed context menus, control whether the menu is positioned relative to the target or to the mouse cursor. Non-fixed context menus are always positioned relative to the target.

  Returns "target" | "cursor"

selector

• get selector(): string

  A CSS selector to identify context menu targets.

  Returns string

target

• get target(): HTMLElement

  The parent HTML element to which the context menu is attached

  Returns HTMLElement

Staticimplementation

• get implementation(): typeof ContextMenu

  Retrieve the configured ContextMenu implementation.

  Returns typeof ContextMenu

activateListeners

• activateListeners(menu: HTMLElement, options?: ContextMenuRenderOptions): void

  Local listeners which apply to each ContextMenu instance which is created.

  Parameters

  • menu: HTMLElement

    The context menu element.

  • Optionaloptions: ContextMenuRenderOptions = {}

  Returns void

close

• close(options?: { animate?: boolean; target?: HTMLElement }): Promise<void>

  Closes the menu and removes it from the DOM.

  Parameters

  • Optionaloptions: { animate?: boolean; target?: HTMLElement } = {}

    Options to configure the closing behavior.

    • Optionalanimate?: boolean

      Animate the context menu closing.

    • Optionaltarget?: HTMLElement

      The target element to close on.

  Returns Promise<void>

render

• render(target: HTMLElement, options?: ContextMenuRenderOptions): Promise<void>

  Render the Context Menu by iterating over the menuItems it contains. Check the visibility of each menu item, and only render ones which are allowed by the item's logical condition. Attach a click handler to each item which is rendered.

  Parameters

  • target: HTMLElement

    The target element to which the context menu is attached.

  • Optionaloptions: ContextMenuRenderOptions = {}

  Returns Promise<void>

  A Promise that resolves when the open animation has completed.

StaticactivateListeners

• activateListeners(
      document: Document,
      __namedParameters?: { _deprecated?: boolean },
  ): void

  Bind global context menu listeners to a given document.

  Parameters

  • document: Document

    The document.

  • __namedParameters: { _deprecated?: boolean } = {}

  Returns void

Staticcreate

• create(
      app: Application,
      html: any,
      selector: string,
      menuItems: ContextMenuEntry[],
      options?: { hookName?: string },
  ): ContextMenu

  Create a ContextMenu for this Application and dispatch hooks.

  Parameters

  • app: Application

    The Application this ContextMenu belongs to.

  • html: any

    The Application's rendered HTML.

  • selector: string

    The target CSS selector which activates the menu.

  • menuItems: ContextMenuEntry[]

    The array of menu items being rendered.

  • Optionaloptions: { hookName?: string } = {}

    Additional options to configure context menu initialization.

    • OptionalhookName?: string

      The name of the hook to call.

  Returns ContextMenu

  Deprecated

  since v13