Skip to content
Obsidian Typings

SettingTab

See

https://docs.obsidian.md/Plugins/User+interface/Settings#Register+a+settings+tab

Extended by

Constructors

new SettingTab()

new SettingTab(): SettingTab

Returns

SettingTab

Properties

app

app: App

Reference to the app instance.

containerEl

containerEl: HTMLElement

Outermost HTML element on the setting tab.

id

id: string

Unique ID of the tab

installedPluginsEl?

optional installedPluginsEl: HTMLElement

Reference to installed plugins element

If

Tab is the community plugins tab

name

name: string

Sidebar name of the tab

navEl: HTMLElement

Sidebar navigation element of the tab

plugin?

optional plugin: Plugin

Reference to the plugin that initialized the tab

If

Tab is a plugin tab

setting

setting: Setting

Reference to the settings modal

Methods

display()

abstract display(): void

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

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