Interface ContextMenuItemConfig

Configuration for a single context-menu item.

interface ContextMenuItemConfig {
    callback?: ItemAction;
    doAction?: ItemAction;
    doHover?: ItemAction;
    getEnabled?: ItemStateGetter;
    getShown?: ItemStateGetter;
    getTitle?: ItemTitleGetter;
    icon?: string | ItemIconGetter;
    items?: ContextMenuItemConfig[][];
    title?: string;
}

Properties

callback? doAction? doHover? getEnabled? getShown? getTitle? icon? items? title?

Properties

Optionalcallback

callback?: ItemAction

Legacy alias for doAction.

OptionaldoAction

doAction?: ItemAction

Action invoked when the item is activated.

OptionaldoHover

doHover?: ItemAction

Optional action invoked when the pointer enters the item.

OptionalgetEnabled

getEnabled?: ItemStateGetter

Resolves whether the item is enabled for the current context.

Defaults to true.

OptionalgetShown

getShown?: ItemStateGetter

Resolves whether the item is shown for the current context.

Defaults to true.

OptionalgetTitle

getTitle?: ItemTitleGetter

Dynamic item title resolver.

Optionalicon

icon?: string | ItemIconGetter

Optional icon for this item. Either a static SVG markup string or a context-aware resolver returning one. The markup is rendered via innerHTML into the menu's icon column — stroke / fill colours that use currentColor will pick up the menu's icon-column colour automatically.

Items without an icon render normally; if at least one item in a menu has an icon, every item in that menu reserves the icon-column space so labels stay aligned.

Optionalitems

items?: ContextMenuItemConfig[][]

Nested submenu item groups.

Each inner array represents a visual group.

Optionaltitle

title?: string

Static item title.

Ignored when getTitle is provided.

Settings

Member Visibility

On This Page

Properties