PluginSettingTab

Provides a unified interface for users to configure the plugin.

See

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

Extends

• SettingTab

Constructors

new PluginSettingTab()

new PluginSettingTab(app, plugin): PluginSettingTab

Parameters

• app: App

• plugin: Plugin

Returns

PluginSettingTab

Overrides

SettingTab.constructor

Properties

app

app: App

Reference to the app instance.

Inherited from

SettingTab.app

---

containerEl

containerEl: HTMLElement

Outermost HTML element on the setting tab.

Inherited from

SettingTab.containerEl

---

id

id: string

Unique ID of the tab

Inherited from

SettingTab.id

---

installedPluginsEl?

optional installedPluginsEl: HTMLElement

Reference to installed plugins element

If

Tab is the community plugins tab

Inherited from

SettingTab.installedPluginsEl

---

name

name: string

Sidebar name of the tab

Inherited from

SettingTab.name

---

navEl

navEl: HTMLElement

Sidebar navigation element of the tab

Inherited from

SettingTab.navEl

---

plugin?

optional plugin: Plugin

Reference to the plugin that initialized the tab

If

Tab is a plugin tab

Inherited from

SettingTab.plugin

---

setting

setting: Setting

Reference to the settings modal

Inherited from

SettingTab.setting

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

Inherited from

SettingTab.display

---

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

Inherited from

SettingTab.hide