Trees
Configuring and customizing Trees to organize and manage the backoffice interface effectively.
Last updated
Was this helpful?
Configuring and customizing Trees to organize and manage the backoffice interface effectively.
Last updated
Was this helpful?
A tree is a hierarchical structure that organizes sections into sub-sections. It appears in the main side panel of the Umbraco interface. In Umbraco UI Builder, each section can only have one tree definition, but you can use folder nodes to organize the tree.
Tree()
MethodThis method defines the structure and behavior of a tree within a section.
AddTree()
methodThis method adds a tree to the current section, specifying its name and icon.
AddTree()
MethodThis method adds a tree to the current section under a specified group.
AddTreeBefore()
to Position a TreeThis method adds a tree to the current section before the tree with the specified alias.
AddTreeAfter()
to Position a TreeThis method adds a tree to the current section after the tree with the specified alias.
SetIconColor()
MethodThis method changes the color of the tree’s icon. The available options are black
, green
, yellow
, orange
, blue
, or red
.
Only trees in existing sections have an icon. Trees in Umbraco UI Builder sections display the tree contents directly.
AddGroup()
MethodThis method adds a group to the current tree with the specified name.
Only trees in Umbraco UI Builder sections support groups.
AddFolder()
MethodAddFolder()
Method with Custom IconAddCollection<>()
MethodAddCollection<>()
Method with IconsWithTree()
MethodThis method starts a sub-configuration for an existing tree with the specified alias.
AddContextApp()
MethodAddContextApp()
Method with Custom IconAddContextApp()
Method Before Another Context AppAddContextApp()
Method with Custom Icon Before Another Context AppAddContextApp()
Method After Another Context AppAddContextApp()
Method with Custom Icon After Another Context AppThe tree configuration for Umbraco UI Builder sections is part of the config builder and is accessed via its Tree
method.
To add a tree to an existing section, use one of the AddTree
methods from the config builder.
This method adds a folder node inside a tree or group, using the default folder icon. For more details, see the article.
This method adds a folder with a specified icon inside a tree or group. For more details, see the article.
This method adds a collection to the current tree or group, specifying its names, descriptions, and default icons. The ID property must be defined. For more details, see the article.
This method adds a collection to the current tree or group, specifying its names, descriptions, and custom icons. The ID property must be defined. For more details, see the article.
To extend existing trees, call the WithTree
method on a instance.
This method adds a context app with the specified name and default icon. For more details, see the article.
This method adds a context app with the specified name and custom icon. For more details, see the article.
This method adds a context app with the specified name and default icon before the specified context app alias. For more information, see the article.
This method adds a context app with the specified name and custom icon before the specified context app alias. For more information, see the article.
This method adds a context app with the specified name and default icon after the specified context app alias. For more information, see the article.
This method adds a context app with the specified name and custom icon after the specified context app alias. For more information, see the article.