Skip to content

SettingTab.getControlValue method

SettingTab › getControlValue

Official

Read the current value for a control key. Called on every render of a control-type setting definition.

The default implementation reads from this.app.vault.getConfig — appropriate for the app's own setting tabs. obsidian#PluginSettingTab and InternalPluginSettingTab override this to read from their conventional settings storage; plugins with custom storage override on their subclass.

Signature:

getControlValue(key: string): unknown

Parameters:

Parameter Type Description
key string

Returns: unknown

Since: 1.13.0