PluginSettingsTabBaseSettingExParams

Import:

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

Signature:

export interface PluginSettingsTabBaseSettingExParams

Properties

Property	Type	Description
aliases?	string[]	Additional search terms for the setting.
desc?	DocumentFragment \| string	The description of the setting. Used for rendering; the text content of a fragment is used for search.
disabled?	(() => boolean) \| boolean	Whether the setting row is disabled. A function form is re-evaluated on every render AND on every `PluginSettingsTabBase.refreshDomState` call, so it can reflect runtime state. Obsidian applies it with `Setting.setDisabled`, which disables the row and every component registered on it.
name	string	The display name of the setting. Used for rendering and search.
searchable?	(() => boolean) \| boolean	Controls whether the setting is included in the settings search. Defaults to `true`.
visible?	(() => boolean) \| boolean	Controls whether the setting row is rendered. A function form is re-evaluated on every render and on every `PluginSettingsTabBase.refreshDomState` call. Defaults to `true`.

Method	Returns	Description
render(setting, group)	(() => void) \| void	Renders the setting row imperatively, typically via the SettingEx adders and PluginSettingsTabBase.bind. The setting Obsidian creates for the row is adopted into a SettingEx before it is handed over, so an imperative row body carries over unchanged. May return a cleanup function, invoked before the row is torn down or re-rendered.