SettingDefinitionBase

Official

Both Official Unofficial

Both Own Inherited

Common configuration shared by every concrete SettingDefinition.

Import:

import type { SettingDefinitionBase } from 'obsidian';

Signature:

export interface SettingDefinitionBase

Properties

	Property	Type	Description
	aliases?	string[]	Additional search terms.
	desc?	DocumentFragment | string	Description text or fragment. Used for rendering; the textContent of a fragment is used for search.
	disabled?	(() => boolean) | boolean	Disables the row: adds is-disabled to the setting element and propagates to every component registered on it. Evaluated on each render; call refreshDomState() on the setting tab to re-evaluate in place. Takes precedence over the disabled of a SettingDefinitionControl's own control. Precedence is decided by key presence, so setting this to undefined explicitly still suppresses that fallback.
	name	string	Display name — used for rendering and search.
	searchable?	(() => boolean) | boolean	Controls search visibility. false or () => false excludes from search.
	visible?	(() => boolean) | boolean	Controls whether the item is rendered. false or () => false hides the item and also excludes it from search for that render cycle. Evaluated on each render; call update() on the setting tab to re-evaluate after the underlying state changes.

---

Links to this page:

• SettingDefinitionAction
• SettingDefinitionControl
• SettingDefinitionEmpty
• SettingDefinitionRender