PluginSettingTab class
Provides a unified interface for users to configure the plugin.
Signature:
export abstract class PluginSettingTab extends SettingTab
Extends: SettingTab
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(app, plugin) | Constructs a new instance of the PluginSettingTab class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
app | App | Reference to the app instance. (Inherited from SettingTab) | |
containerEl | HTMLElement | Outermost HTML element on the setting tab. (Inherited from SettingTab) |
Methods
Method | Modifiers | Description |
---|---|---|
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) |