PluginSettingsTabBase.settingGroupEx method

PluginSettingsTabBase › settingGroupEx

Builds a declarative heading group.

The declarative counterpart of SettingGroupEx: where that class appends a group to a container imperatively, this returns the definition Obsidian renders, so a group-structured tab keeps its shape after the migration.

Signature:

settingGroupEx(params: { heading?: string; cls?: string; search?: { placeholder?: string; match: (def: SettingDefinition<string>, query: string) => boolean; }; extraButtons?: ((component: ExtraButtonComponent) => any)[]; items?: SettingGroupItem<string>[]; visible?: boolean | (() => boolean); extraButtons__?: ((component: ExtraButtonComponent) => unknown)[]; }): SettingDefinitionGroup

Parameters:

Parameter	Type	Description
params	{ heading?: string; cls?: string; search?: { placeholder?: string; match: (def: SettingDefinition<string>, query: string) => boolean; }; extraButtons?: ((component: ExtraButtonComponent) => any)[]; items?: SettingGroupItem<string>[]; visible?: boolean | (() => boolean); extraButtons__?: ((component: ExtraButtonComponent) => unknown)[]; }	The group params.

Returns: SettingDefinitionGroup — The group definition.