Interface CompoundMenuNodeInternal

For most use cases, refer to MenuAction or MenuNode

interface CompoundMenuNode {
    children: MenuNode[];
    contextKeyOverlays?: Record<string, string>;
    id: string;
    onDidChange?: Event<void>;
    sortString: string;
    isEmpty<T>(effectiveMenuPath, contextMatcher, context, ...args): boolean;
    isVisible<T>(effectiveMenuPath, contextMatcher, context, ...args): boolean;
}

Hierarchy (view full)

Implemented by

Properties

children contextKeyOverlays? id onDidChange? sortString

Methods

isEmpty isVisible

Properties

children

children: MenuNode[]

Optional contextKeyOverlays

contextKeyOverlays?: Record<string, string>

Readonly id

id: string

technical identifier.

Optional onDidChange

onDidChange?: Event<void>

Readonly sortString

sortString: string

Menu nodes are sorted in ascending order based on their sortString.

Methods

isEmpty

  • isEmpty<T>(effectiveMenuPath, contextMatcher, context, ...args): boolean

  • Whether the group or submenu contains any visible children

    Type Parameters

    • T

    Parameters

    • effectiveMenuPath: MenuPath

      The menu path where visibility is checked

    • contextMatcher: ContextExpressionMatcher<T>

      The context matcher to use

    • context: undefined | T

      the context to use

    • Rest ...args: unknown[]

      the command arguments, if applicable

    Returns boolean

isVisible

Settings

Member Visibility

Theme

On This Page

childrencontextKeyOverlaysidonDidChangesortStringisEmptyisVisible