Skip to content

BindOptions<T>

Options for PluginSettingsTabBase.bind.

Import:

import type { BindOptions } from 'obsidian-dev-utils/obsidian/plugin/plugin-settings-tab';

Signature:

export interface BindOptions<T>

Properties

PropertyTypeDescription
shouldResetSettingWhenComponentIsEmpty?booleanWhether to reset the setting when the component value is empty. Applicable only to text-based components.
shouldShowPlaceholderForDefaultValues?booleanWhether to show the placeholder for default values. Applicable only to text-based components.
shouldShowValidationMessage?booleanWhether to show the validation message when the component value is invalid.

Methods

MethodReturnsDescription
onChanged(newValue, oldValue)Promisable<void>A callback function that is called when the value of the component changes.

Links to this page: