commands.IStandardGroup interface

A non-split group of actions: rendered inline ('expanded'), as a single dropdown button ('collapsed'), or as a stacked column ('stacked').

Signature:

interface IStandardGroup<TCommandType extends CommandType = 'unscoped'> extends IGroupConfigBase<TCommandType>

Extends: IGroupConfigBase<TCommandType>

Introduced: version 1.0

Type Parameters

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

Property	Modifiers	Type	Description
context?	`readonly`	TCommandType	(Optional) Gets the command-context type, which determines what event API is passed to commands.IGroupConfigBase.onSurface(). (Inherited from IGroupConfigBase)
icon?	`readonly`	IIcon	(Optional) Gets the icon of the group, which is displayed if the group is collapsed. (Inherited from IGroupConfigBase)
id	`readonly`	GroupId	Gets the identifier of the group. This must be a non-empty string. (Inherited from IGroupBase)
isCollapsed?	`readonly`	boolean	(Optional) Indicates whether the group is initially expanded (`false`) or collapsed (`true`) in the user interface. (Inherited from IGroupBase)
label?	`readonly`	string	(Optional) Gets the label of the group. (Inherited from IGroupConfigBase)
popoutStyle?	`readonly`	'ribbon'	(Optional) Gets the popup style for the group's trigger button. (Inherited from IGroupConfigBase)
primaryCommand?	`readonly`	never	(Optional) Gets the primary command, which is not applicable to a non-split group.
type?	`readonly`	'expanded' \| 'collapsed' \| 'stacked'	(Optional) Gets the render type of the group.

Method	Description
onSurface(groupAction, eventApi, signal)?	(Optional) Runs when an action derived from the group is surfaced, enabling the group to configure the action in response to events. (Inherited from IGroupConfigBase)