Skip to content

PluginSettingsTabBase.getSettingDefinitionItems method

PluginSettingsTabBase › getSettingDefinitionItems

The declarative setting definitions for the tab (Obsidian 1.13+).

Consumers override this, typically building each row with settingEx and bind and grouping them with settingGroupEx. Returning an empty array — the default — makes Obsidian fall back to the imperative displayLegacy path.

MUST be a pure builder. Obsidian calls it when the tab is registered (addSettingTab), long before the tab is ever opened, in order to index the settings for search. Anything with a side effect belongs inside a row's PluginSettingsTabBaseSettingExParams.render callback, which runs only when the row is actually rendered.

Signature:

getSettingDefinitionItems(): SettingDefinitionItem[]

Returns: SettingDefinitionItem[]The setting definitions.