PluginSettingTab

PluginSettingTab class

Provides a unified interface for users to configure the plugin.

Signature:

export abstract class PluginSettingTab extends SettingTab 

Extends: SettingTab

Constructors

ConstructorModifiersDescription
(constructor)(app, plugin)Constructs a new instance of the PluginSettingTab class

Properties

PropertyModifiersTypeDescription
appApp

Reference to the app instance.

(Inherited from SettingTab)

containerElHTMLElement

Outermost HTML element on the setting tab.

(Inherited from SettingTab)

Methods

MethodModifiersDescription
display()abstract

Called when the settings tab should be rendered.

(Inherited from SettingTab)

hide()

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.

(Inherited from SettingTab)