obsidian/augmentations/settings/setting-definitions
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| SettingDefinition__ | Union of the non-grouping setting definition shapes that may appear inside a SettingDefinitionGroup or at the top level. |
| SettingDefinitionAction | A setting definition that renders an action row (clickable button or link). |
| SettingDefinitionAddItem | Configuration for a SettingDefinitionList’s addItem affordance. |
| SettingDefinitionBase | Common configuration shared by every concrete SettingDefinition. |
| SettingDefinitionControl | A setting definition that renders a single bound control. |
| SettingDefinitionEmpty | A setting definition that renders only a heading row (name + description) with no control, action, or custom render. |
| SettingDefinitionGroup | A 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. |
| SettingDefinitionList | A 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. |
| SettingDefinitionPage | A declarative page of settings rendered as a navigable entry. Used as an inline page in the array returned by getSettingDefinitions(). |
| SettingDefinitionRender | A setting definition that renders its row imperatively. |
| SettingGroupItem__ | A single item within a SettingDefinitionGroup — either a setting or a navigable page. |