Class ContextMenu

Lightweight context menu that renders at fixed viewport coordinates.

Hierarchy (View Summary)

ContextMenu
- DiagramContextMenu

Index

Constructors

Properties

host menuElement config

Accessors

Methods

addMenuItem addSeparator show open close destroy

Constructors

constructor

new ContextMenu(host: HTMLElement, config?: ContextMenuConfig): ContextMenu
Creates a ContextMenu. Styles are injected once.
Parameters
- host: HTMLElement
  Element to append the menu into. Must establish a stacking context so CSS variables are inherited.
- config: ContextMenuConfig = {}
  Optional class-name overrides.
Returns ContextMenu
- Defined in src/editor/menus/context.menu.ts:48

Properties

`Protected` `Readonly`host

host: HTMLElement

`Protected`menuElement

menuElement: HTMLElement | null = null

`Protected` `Readonly`config

config: ContextMenuConfig

Accessors

visible

get visible(): boolean
Returns true when the menu is currently visible.

Returns boolean
- Defined in src/editor/menus/context.menu.ts:59

Methods

addMenuItem

addMenuItem(
    label: string,
    onClick: () => void,
    options?: { icon?: Element | null; active?: boolean; disabled?: boolean },
): HTMLElement
Appends a labelled menu item that calls the given handler and closes the menu on click.
Parameters
- label: string
  Display text for the item.
- onClick: () => void
  Callback invoked when the item is clicked.
- options: { icon?: Element | null; active?: boolean; disabled?: boolean } = {}
  Optional icon element, active toggle state, and disabled flag.
Returns HTMLElement
The created menu item element.
- Defined in src/editor/menus/context.menu.ts:70

addSeparator

addSeparator(): void
Appends a visual separator line.

Returns void
- Defined in src/editor/menus/context.menu.ts:101

`Protected`show

show(x: number, y: number): void
Positions and displays the menu at the given viewport coordinates. Any previously open menu is closed first. Call this from open after populating items.
Parameters
- x: number
  Horizontal position in viewport pixels.
- y: number
  Vertical position in viewport pixels.
Returns void
- Defined in src/editor/menus/context.menu.ts:114

open

open(_event: MouseEvent): void
Opens the context menu in response to a pointer event. Override in subclasses to populate items and call show. The base implementation does nothing.
Parameters
- _event: MouseEvent
  The pointer event that triggered the context menu.
Returns void
- Defined in src/editor/menus/context.menu.ts:155

close

close(): void
Hides and removes the menu from the DOM.

Returns void
- Defined in src/editor/menus/context.menu.ts:160

destroy

destroy(): void
Permanently removes the menu and cleans up listeners.

Returns void
- Defined in src/editor/menus/context.menu.ts:169