SettingTab
Defined in: obsidian.d.ts:3767
See
https://docs.obsidian.md/Plugins/User+interface/Settings#Register+a+settings+tab
Extended by
Constructors
new SettingTab()
new SettingTab():
SettingTab
Returns
Properties
app
app:
App
Defined in: obsidian.d.ts:3773
Reference to the app instance.
containerEl
containerEl:
HTMLElement
Defined in: obsidian.d.ts:3779
Outermost HTML element on the setting tab.
id
id:
string
Defined in: src/obsidian/augmentations/SettingTab.d.ts:8
Unique ID of the tab
installedPluginsEl?
optionalinstalledPluginsEl:HTMLElement
Defined in: src/obsidian/augmentations/SettingTab.d.ts:14
Reference to installed plugins element
If
Tab is the community plugins tab
name
name:
string
Defined in: src/obsidian/augmentations/SettingTab.d.ts:18
Sidebar name of the tab
navEl
navEl:
HTMLElement
Defined in: src/obsidian/augmentations/SettingTab.d.ts:22
Sidebar navigation element of the tab
plugin?
optionalplugin:Plugin
Defined in: src/obsidian/augmentations/SettingTab.d.ts:28
Reference to the plugin that initialized the tab
If
Tab is a plugin tab
setting
setting:
Setting
Defined in: src/obsidian/augmentations/SettingTab.d.ts:32
Reference to the settings modal
Methods
display()
abstractdisplay():void
Defined in: obsidian.d.ts:3786
Called when the settings tab should be rendered.
Returns
void
See
https://docs.obsidian.md/Plugins/User+interface/Settings#Register+a+settings+tab
hide()
hide():
void
Defined in: obsidian.d.ts:3793
Hides the contents of the setting tab. Any registered components should be unloaded when the view is hidden. Override this if you need to perform additional cleanup.
Returns
void