plugin/plugin-settings-tab
This module defines a base class for creating plugin setting tabs in Obsidian. It provides a utility method to bind value components to plugin settings and handle changes.
Classes
Section titled “Classes”| Class | Description |
|---|---|
| PluginSettingsTabBase | Base class for creating plugin settings tabs in Obsidian. Provides a method for binding value components to plugin settings and handling changes. |
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| BindOptions | Options for PluginSettingsTabBase.bind. |
| BindOptionsExtended | Extended options for PluginSettingsTabBase.bind. |
| PluginSettingsTabBaseBindExtendedParams | Extended params for PluginSettingsTabBase.bind with value converters. |
| PluginSettingsTabBaseBindParams | Params for PluginSettingsTabBase.bind. |
| PluginSettingsTabBaseConstructorParams | Params for creating a PluginSettingsTabBase. |
| PluginSettingsTabBaseSettingExParams | Params for PluginSettingsTabBase.settingEx. |
| Type | Description |
|---|---|
| PluginSettingsTabBaseSettingGroupExParams | Params for PluginSettingsTabBase.settingGroupEx. Every member of SettingDefinitionGroup except its discriminator, which PluginSettingsTabBase.settingGroupEx sets. |
Variables
Section titled “Variables”| Variable | Description |
|---|---|
| SAVE_TO_FILE_CONTEXT | A context passed to the PluginSettingsComponentBase.saveToFile method. |