PluginSettingsTabBase<PluginSettings>
Base class for creating plugin settings tabs in Obsidian. Provides a method for binding value components to plugin settings and handling changes.
Import:
import { PluginSettingsTabBase } from 'obsidian-dev-utils/obsidian/plugin/plugin-settings-tab';Signature:
export class PluginSettingsTabBase<PluginSettings extends object> extends mixinAsyncEvents<PluginSettingsTabBaseEventMap>()(PluginSettingTab)Extends: mixinAsyncEvents<PluginSettingsTabBaseEventMap>()(PluginSettingTab)
Constructor
new PluginSettingsTabBase(params: PluginSettingsTabBaseConstructorParams<PluginSettings>)Creates a new plugin settings tab.
Properties
| Property | Type | Description |
|---|---|---|
| pluginSettingsComponent | PluginSettingsComponentBase<PluginSettings> | The settings manager. |
Methods
| Method | Returns | Description |
|---|---|---|
| bind(params) | TValueComponent | Binds a value component to a plugin setting. |
| display() | void | Renders the plugin settings tab. |
| displayLegacy() | void | Legacy way to render the plugin settings tab. Temporary workaround to avoid dealing with @deprecated. |
| hide() | void | Hides the plugin settings tab. |
| hideAsync() | Promise<void> | Async actions to perform when the settings tab is being hidden. |
| onLoadSettings(_loadedState, _isInitialLoad) | Promise<void> | Called when the plugin settings are loaded. |
| revalidate() | Promise<void> | Revalidates the settings. |
| show() | void | Shows the plugin settings tab. |
Links to this page: