commands.IStandardDynamicGroup interface

A dynamic group that renders as a collapsed dropdown/submenu, populated on open.

Signature:

interface IStandardDynamicGroup<TCommandType extends CommandType = CommandType> extends IDynamicGroupConfigBase<TCommandType>

Extends: IDynamicGroupConfigBase<TCommandType>

Introduced: version 1.10

Type Parameters

Parameter	Type	Description
TCommandType	extends CommandType(default: CommandType)	The type of the command-context for the group.

Property	Modifiers	Type	Description
context	`readonly`	TCommandType	Gets the command-context type for the group. (Inherited from IDynamicGroupConfigBase)
icon?	`readonly`	IIcon	(Optional) Gets the icon of the group. (Inherited from IDynamicGroupConfigBase)
id	`readonly`	GroupId	Gets the identifier of the group. This must be a non-empty string. (Inherited from IDynamicGroupConfigBase)
label	`readonly`	string	Gets the label of the group, which is displayed as the button/menu-entry title. (Inherited from IDynamicGroupConfigBase)
primaryCommand?	`readonly`	never	(Optional) Gets the primary command, which is not applicable to a collapsed dynamic group.
type?	`readonly`	'collapsed'	(Optional) Gets the render type, `'collapsed'` (the default) for a dropdown/submenu.

Method	Description
onPopulate(commandArea, context, signal)	Populates the group's commands each time the group is opened. (Inherited from IDynamicGroupConfigBase)
onSurface(groupAction, eventApi, signal)?	(Optional) Runs when the dynamic group's popup button is surfaced, enabling its state to be driven from events. (Inherited from IDynamicGroupConfigBase)