commands.ICommandDynamicGroup interface

A dynamic split-button group.

Signature:

interface ICommandDynamicGroup<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.

Has a fixed primary command and a drop-down menu that is populated each time it opens.

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`	ICommand \| CommandId	Gets the split button's primary command, as a command or command identifier.
type	`readonly`	'command'	Gets the render type, always `'command'` for a split-button dynamic group.

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)