Sections
Configuring sections in Umbraco UI Builder, the backoffice UI builder for Umbraco.
A section is a distinct area of the Umbraco backoffice, such as content, media, etc. The section is accessed via a link in the main menu at the top of the Umbraco interface. Umbraco UI Builder allows you to define multiple sections in order to organise the management of your models into logical sections.

Sections
You can define a section by calling one of the
AddSection
methods on the root level UIBuilderConfigBuilder
instance.Adds a section to the Umbraco menu with the given name.
// Example
config.AddSection("Repositories", sectionConfig => {
...
});
Adds a section to the Umbraco menu with the given name before the section with the given alias.
// Example
config.AddSectionBefore("settings", "Repositories", sectionConfig => {
...
});
Adds a section to the Umbraco menu with the given name after the section with the given alias.
// Example
config.AddSectionAfter("media", "Repositories", sectionConfig => {
...
});
Sets the alias of the section.
Optional: When adding a new section, an alias is automatically generated from the supplied name for you. However, if you need a specific alias you can use the
SetAlias
method to override this.// Example
sectionConfig.SetAlias("repositories");
Accesses the tree config of the current section. For more information check the Trees documentation.
// Example
sectionConfig.Tree(treeConfig => {
...
});
// Example
sectionConfig.AddDashboard("Team", dashboardConfig => {
...
});
Adds a dashboard with the given name before the dashboard with the given alias. For more information check the Dashboards documentation.
// Example
sectionConfig.AddDashboardBefore("contentIntro", "Team", dashboardConfig => {
...
});
Adds a dashboard with the given name after the dashboard with the given alias. For more information check the Dashboards documentation.
// Example
sectionConfig.AddDashboardAfter("contentIntro", "Team", dashboardConfig => {
...
});
You can extend existing sections by adding Umbraco UI Builder trees and dashboards, context apps, and virtual subtrees. This can be done by calling the
WithSection
method on the root level UIBuilderConfigBuilder
instance.Starts a sub-configuration for the existing Umbraco section with the given alias.
// Example
config.WithSection("member", withSectionConfig => {
...
});
// Example
withSectionConfig.AddTree("My Tree", "icon-folder", treeConfig => {
...
});
Adds a tree to the current section in a group with the given name. For more information check the Trees documentation.
// Example
withSectionConfig.AddTree("My Group", "My Tree", "icon-folder", treeConfig => {
...
});
Adds a tree to the current section before the tree with the given alias. For more information check the Trees documentation.
// Example
withSectionConfig.AddTreeBefore("member", "My Tree", "icon-folder", treeConfig => {
...
});
Adds a tree to the current section after the tree with the given alias. For more information check the Trees documentation.
// Example
withSectionConfig.AddTreeAfter("member", "My Tree", "icon-folder", treeConfig => {
...
});
// Example
withSectionConfig.AddDashboard("Team", dashboardConfig => {
...
});
Adds a dashboard with the given name before the dashboard with the given alias. For more information check the Dashboards documentation.
// Example
withSectionConfig.AddDashboardBefore("contentIntro", "Team", dashboardConfig => {
...
});
Adds a dashboard with the given name after the dashboard with the given alias. For more information check the Dashboards documentation.
// Example
withSectionConfig.AddDashboardAfter("contentIntro", "Team", dashboardConfig => {
...
});
Last modified 1mo ago