PluginSettingTab

Defined in: obsidian.d.ts:3297

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

Defined in: obsidian.d.ts:3302

Parameters

app

App

plugin

Plugin

Returns

PluginSettingTab

Overrides

SettingTab.constructor

Properties

app

app: App

Defined in: obsidian.d.ts:3773

Reference to the app instance.

Inherited from

SettingTab.app

---

containerEl

containerEl: HTMLElement

Defined in: obsidian.d.ts:3779

Outermost HTML element on the setting tab.

Inherited from

SettingTab.containerEl

---

id

id: string

Defined in: src/obsidian/augmentations/SettingTab.d.ts:8

Unique ID of the tab

Inherited from

SettingTab.id

---

installedPluginsEl?

optional installedPluginsEl: HTMLElement

Defined in: src/obsidian/augmentations/SettingTab.d.ts:14

Reference to installed plugins element

If

Tab is the community plugins tab

Inherited from

SettingTab.installedPluginsEl

---

name

name: string

Defined in: src/obsidian/augmentations/SettingTab.d.ts:18

Sidebar name of the tab

Inherited from

SettingTab.name

---

navEl

navEl: HTMLElement

Defined in: src/obsidian/augmentations/SettingTab.d.ts:22

Sidebar navigation element of the tab

Inherited from

SettingTab.navEl

---

plugin?

optional plugin: Plugin

Defined in: src/obsidian/augmentations/SettingTab.d.ts:28

Reference to the plugin that initialized the tab

If

Tab is a plugin tab

Inherited from

SettingTab.plugin

---

setting

setting: Setting

Defined in: src/obsidian/augmentations/SettingTab.d.ts:32

Reference to the settings modal

Inherited from

SettingTab.setting

Methods

display()

abstract display(): 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

Inherited from

SettingTab.display

---

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

Inherited from

SettingTab.hide