SettingsTreeNode
type SettingsTreeNode = object;
A node represents a single item or group of items in the settings tree.
Properties
actions?
optional actions: SettingsTreeNodeAction[];
An array of actions that can be performed on this node.
children?
optional children: SettingsTreeChildren;
Other settings tree nodes nested under this node.
defaultExpansionState?
optional defaultExpansionState: "collapsed" | "expanded";
Set to collapsed if the node should be initially collapsed.
error?
optional error: string;
Optional message indicating any error state for the node.
warning?
optional warning: string;
Optional message indicating any warning state for the node. This message is not displayed when an error message is present.
fields?
optional fields: SettingsTreeFields;
Field inputs attached directly to this node.
icon?
optional icon: SettingsIcon;
Optional icon to display next to the node label.
color?
optional color: string;
Optional color for this node. When an icon is specified, the icon will be rendered in this color. Otherwise, a small color swatch is displayed before the label. Expects a valid CSS color string (e.g., "#ff0000", "rgb(255, 0, 0)", "red").
label?
optional label: string;
An optional label shown at the top of this node.
help?
optional help: string;
Optional help text to explain the purpose of the node.
renamable?
optional renamable: boolean;
True if the node label can be edited by the user.
reorderable?
optional reorderable: boolean;
Set to false on a child of a childrenReorderable node to keep this node rendered in place
without drag-and-drop controls or default "Move up" / "Move down" action menu items.
order?
optional order: number | string;
Optional sort order to override natural object ordering. All nodes with a sort order will be rendered before nodes all with no sort order.
Nodes without an explicit order will be ordered according to ECMA object ordering rules.
childrenReorderable?
optional childrenReorderable: boolean;
When set to true, the renderer treats this node's reorderable children as a
user-reorderable list with drag-and-drop controls and default "Move up" / "Move down" action
menu items when at least two reorderable children are present. Both reorder methods dispatch
"reorder-children" actions whose path is the path of this parent node.
When a visibility filter or tree-wide text filter hides any of this node's children, drag-and-drop affordances are suppressed until the filter is cleared so that the user is never dragging against a subset of the list. The action menu items remain available because they resolve against sibling keys in the complete list.
When this option is enabled, child render order is driven by the order of entries in
children. Explicit order values on children are ignored and should not be used for
reorderable children.
visible?
optional visible: boolean;
An optional visibility status. If this is not undefined, the node editor will display a visibility toggle button and send update actions to the action handler.
enableVisibilityFilter?
optional enableVisibilityFilter: boolean;
Filter Children by visibility status
drag?
optional drag: SettingsTreeNodeDrag;
Drag-and-drop configuration for this node.