PluginSettingsTabBase.refresh method

PluginSettingsTabBase › refresh

Re-renders the settings tab after the underlying state changed.

Rebuilds the definitions and re-renders, which covers both paths: Obsidian renders the declarative definitions when getSettingDefinitionItems provides them, and falls back to displayLegacy when it does not. Nothing is rendered while the tab is not the one on screen.

Use it only for changes that alter the STRUCTURE of the tab — rows added or removed. When only a PluginSettingsTabBaseSettingExParams.disabled / PluginSettingsTabBaseSettingExParams.visible predicate has to be re-evaluated, call the much cheaper refreshDomState instead, which toggles the rendered DOM in place.

Signature:

refresh(): void

Returns: void