Skip to content

PluginSettingsTabBase.settingEx method

PluginSettingsTabBase › settingEx

Builds a search-indexable declarative row that is rendered imperatively.

The bridge between the declarative API and ODU's imperative building blocks: Obsidian owns the row (so it indexes it for search and evaluates its PluginSettingsTabBaseSettingExParams.visible / PluginSettingsTabBaseSettingExParams.disabled predicates on every refreshDomState), while PluginSettingsTabBaseSettingExParams.render fills it in with SettingEx adders and bind exactly as an imperative tab would.

Signature:

settingEx(params: PluginSettingsTabBaseSettingExParams): SettingDefinitionRender

Parameters:

ParameterTypeDescription
paramsPluginSettingsTabBaseSettingExParamsThe row params.

Returns: SettingDefinitionRenderThe setting definition.