Class TJSContextMenu

Parameters

• opts: {
      activeWindow?: Window;
      anchorToEventTarget?: boolean;
      classes?: Iterable<string>;
      duration?: number;
      easing?: EasingReference;
      event?: MouseEvent | PointerEvent | KeyboardEvent;
      focusDebug?: boolean;
      focusEl?: string | HTMLElement;
      id?: string;
      items?: Iterable<Items, any, any> | (() => Iterable<Items>);
      keyCode?: string;
      offsetX?: number;
      offsetY?: number;
      onClose?: Function;
      onPressApplyFocus?: boolean;
      styles?: { [key: string]: string };
      x?: number;
      y?: number;
  }

  Optional parameters.

  • OptionalactiveWindow?: Window

    The active browser window that the context menu is displaying inside. When you pass an event this is determined automatically.

  • OptionalanchorToEventTarget?: boolean

    Align context menu to the event.target element. This will usually display the context menu aligned at the bottom left of the target element with automatic alignment adjustments when the menu opens to the left or upwards.

  • Optionalclasses?: Iterable<string>

    Additional custom CSS classes to add to the menu. This allows CSS style targeting.

  • Optionalduration?: number

    Transition option for duration of transition in milliseconds; default: 120ms.

  • Optionaleasing?: EasingReference

    Transition option for ease. Either an easing function or easing function name.

  • Optionalevent?: MouseEvent | PointerEvent | KeyboardEvent

    The source PointerEvent, MouseEvent or KeyboardEvent. It is highly recommended to pass the originating DOM event for automatic configuration.

  • OptionalfocusDebug?: boolean

    When true the associated A11yFocusSource object will log focus target data when applied.

  • OptionalfocusEl?: string | HTMLElement

    A specific HTMLElement or selector string as the default focus target.

  • Optionalid?: string

    A custom CSS ID to add to the menu. This allows CSS style targeting.

  • Optionalitems?: Iterable<Items, any, any> | (() => Iterable<Items>)

    Menu items list of function returning a menu item list to display.

  • OptionalkeyCode?: string

    Key to select menu items.

  • OptionaloffsetX?: number

    Small positive number offset for context menu so the pointer / mouse is over the menu on display.

  • OptionaloffsetY?: number

    Small positive number offset for context menu so the pointer / mouse is over the menu on display.

  • OptionalonClose?: Function

    A function that is invoked when the context menu is closed. Useful for any state based changes such as CSS highlighting of context menu invoking element.

  • OptionalonPressApplyFocus?: boolean

    When true, any focus source derived from the associated event or defined focusEl is applied automatically in response to menu item presses.

  • Optionalstyles?: { [key: string]: string }

    Optional inline styles to apply.

  • Optionalx?: number

    X position override for the top / left of the menu.

  • Optionaly?: number

    Y position override for the top / left of the menu.