Class CompositeMenuNode

Node representing a (sub)menu in the menu tree structure.

Hierarchy

CompositeMenuNode

Implements

MenuNode

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CompositeMenuNode(id: string, label?: string, options?: SubMenuOptions): CompositeMenuNode

- Defined in packages/core/src/common/menu.ts:319
Parameters
- id: string
- Optional label: string
- Optional options: SubMenuOptions
Returns CompositeMenuNode

Properties

Protected Readonly _children

_children: MenuNode[] = []

Optional iconClass

iconClass: string

Readonly id

id: string

technical identifier.

Optional label

label: string

the optional label for this specific node.

Optional order

order: string

Accessors

children

get children(): readonly MenuNode[]

- Defined in packages/core/src/common/menu.ts:332
Returns readonly MenuNode[]

isSubmenu

get isSubmenu(): boolean

- Defined in packages/core/src/common/menu.ts:388
Returns boolean

sortString

get sortString(): string

Implementation of MenuNode.sortString
- Defined in packages/core/src/common/menu.ts:384
Menu nodes are sorted in ascending order based on their sortString.

Returns string

Methods

addNode

addNode(node: MenuNode): Disposable

- Defined in packages/core/src/common/menu.ts:341
Inserts the given node at the position indicated by sortString.

Parameters
- node: MenuNode
Returns Disposable

a disposable which, when called, will remove the given node again.

removeNode

removeNode(id: string): void

- Defined in packages/core/src/common/menu.ts:374
Removes the first node with the given id.

Parameters
- id: string
  
  node id.
Returns void

Static isNavigationGroup

isNavigationGroup(node: MenuNode): node is CompositeMenuNode

- Defined in packages/core/src/common/menu.ts:399
Indicates whether the given node is the special navigation menu.

Parameters
- node: MenuNode
  
  the menu node to check.
Returns node is CompositeMenuNode

true when the given node is a CompositeMenuNode with id navigation, false otherwise.