SettingDefinitionRender

Official

Both Official Unofficial

Both Own Inherited

A setting definition that renders its row imperatively.

Import:

import type { SettingDefinitionRender } from 'obsidian';

Signature:

export interface SettingDefinitionRender extends SettingDefinitionBase

Extends: SettingDefinitionBase

Properties

	Property	Type	Description
	action?	never	Forbidden discriminant key — set only on SettingDefinitionAction.
	aliases?	string[]	Additional search terms. (Inherited from SettingDefinitionBase)
	control?	never	Forbidden discriminant key — set only on SettingDefinitionControl.
	desc?	DocumentFragment | string	Description text or fragment. Used for rendering; the textContent of a fragment is used for search. (Inherited from SettingDefinitionBase)
	name	string	Display name — used for rendering and search. (Inherited from SettingDefinitionBase)
	render	(setting: Setting, group: SettingGroup) => void | (() => void)	Renders the setting row imperatively. May return a cleanup function, invoked before the row is torn down. Not guaranteed to run when the host window is destroyed.
	searchable?	(() => boolean) | boolean	Controls search visibility. false or () => false excludes from search. (Inherited from SettingDefinitionBase)
	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. (Inherited from SettingDefinitionBase)

---

Links to this page:

• SettingDefinitionAction
• SettingDefinitionControl
• SettingDefinitionEmpty