Skip to main content

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.


fields?

optional fields: SettingsTreeFields;

Field inputs attached directly to this node.


icon?

optional icon: SettingsIcon;

Optional icon to display next to the node label.


label?

optional label: string;

An optional label shown at the top of this node.


renamable?

optional renamable: boolean;

True if the node label can be edited by the user.


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.

https://262.ecma-international.org/6.0/#sec-ordinary-object-internal-methods-and-internal-slots-ownpropertykeys


visible?

optional visible: boolean;

An optional visibility status. If this is not undefined, the node editor will display a visiblity toggle button and send update actions to the action handler.


enableVisibilityFilter?

optional enableVisibilityFilter: boolean;

Filter Children by visibility status