Home > @i2analyze/notebook-sdk > commands > IDynamicGroupConfig
commands.IDynamicGroupConfig type
Configuration for a dynamic group whose commands are created on demand when the group is opened.
Signature:
type IDynamicGroupConfig<TCommandType extends CommandType = CommandType> = IStandardDynamicGroup<TCommandType> | ICommandDynamicGroup<TCommandType>;
References: CommandType, IStandardDynamicGroup, ICommandDynamicGroup
Introduced: version 1.10
Type Parameters
| Parameter | Type | Description |
|---|---|---|
| TCommandType | extends CommandType(default: CommandType) | The type of the command-context for the group, which determines what payload is passed to onPopulate and what event API is passed to onSurface. |
Remarks
A dynamic group renders as a popup, never inline: either a collapsed commands.IStandardDynamicGroup dropdown/submenu, or a split-button commands.ICommandDynamicGroup (type: 'command' with a primaryCommand). The type discriminates between them, so primaryCommand is required exactly when type is 'command'.