PluginSettingsTabBaseBindParams<PluginSettings, UIValue, TValueComponent>
Params for PluginSettingsTabBase.bind.
Import:
import type { PluginSettingsTabBaseBindParams } from '@mnaoumov/obsidian-lib/plugin/plugin-settings-tab';Signature:
export interface PluginSettingsTabBaseBindParams<PluginSettings extends object, UIValue, TValueComponent> extends BindOptions<UIValue>Extends: BindOptions<UIValue>
Properties
| Property | Type | Description |
|---|---|---|
| onChanged? | (newValue: ReadonlyDeep<UIValue>, oldValue: ReadonlyDeep<UIValue>) => Promisable<void> | A callback function that is called when the value of the component changes. (Inherited from BindOptions) |
| propertyName | ConditionalKeys<PluginSettings, UIValue> | The property of the plugin settings to bind to. |
| shouldResetSettingWhenComponentIsEmpty? | boolean | Whether to reset the setting when the component value is empty. Applicable only to text-based components. (Inherited from BindOptions) |
| shouldShowPlaceholderForDefaultValues? | boolean | Whether to show the placeholder for default values. Applicable only to text-based components. (Inherited from BindOptions) |
| shouldShowValidationMessage? | boolean | Whether to show the validation message when the component value is invalid. (Inherited from BindOptions) |
| valueComponent | TValueComponent & ValueComponentWithChangeTracking<UIValue> | The value component to bind. |