Skip to content

obsidian/augmentations/settings/setting-definitions

InterfaceDescription
SettingDefinition__Union of the non-grouping setting definition shapes that may appear inside a SettingDefinitionGroup or at the top level.
SettingDefinitionActionA setting definition that renders an action row (clickable button or link).
SettingDefinitionAddItemConfiguration for a SettingDefinitionList’s addItem affordance.
SettingDefinitionBaseCommon configuration shared by every concrete SettingDefinition.
SettingDefinitionControlA setting definition that renders a single bound control.
SettingDefinitionEmptyA setting definition that renders only a heading row (name + description) with no control, action, or custom render.
SettingDefinitionGroupA group of settings rendered under a shared heading. Used as an inline group in the array returned by getSettingDefinitions(). For collections of mutable data (with add/delete/reorder affordances), use SettingDefinitionList instead.
SettingDefinitionListA specialized SettingDefinitionGroup for collections of mutable data: entries the user adds, reorders, or removes. Rendered with a more compact visual style than a group, and supports emptyState, onReorder, and onDelete for the mutation affordances.
SettingDefinitionPageA declarative page of settings rendered as a navigable entry. Used as an inline page in the array returned by getSettingDefinitions().
SettingDefinitionRenderA setting definition that renders its row imperatively.
SettingGroupItem__A single item within a SettingDefinitionGroup — either a setting or a navigable page.