Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContextMenuProvider<TTarget>

Interface for widgets that wish to provide a context menu. They need to implement the bindContextMenu method. This method is called once when the context menu is initialized. Widgets should register the appropriate event listeners and call menuWidget.show() to bring up the context menu.

Type Parameters

  • TTarget

    Type of the widget that wishes to provide a context menu.

Hierarchy

  • ContextMenuProvider

Implemented by

Index

Methods

Methods

bindContextMenu

  • Callback that is invoked when the context menu is initialized. Lets the context menu provider register the appropriate event listeners for when the context menu should be shown and hidden.

    Parameters

    • menuWidget: ContextMenu<ContextMenuCfg>

      The widget instance of the context menu.

    • targetWidget: TTarget

      The widget instance of the target widget that wants to add a context menu.

    • targetId: string | JQuery<HTMLElement>

      ID selector or DOM element of the target, i.e. the element the context menu belongs to.

    • cfg: ContextMenuCfg

      The current configuration of the context menu.

    Returns void

Generated using TypeDoc