Sections

Configuring sections in Konstrukt, the back office UI builder for Umbraco.

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

Sections

Defining a section

You define a section by calling one of the AddSection methods on the root level KonstruktConfigBuilder instance.

AddSection(string name, Lambda sectionConfig = null) : KonstruktSectionConfigBuilder

Adds a section to the Umbraco menu with the given name.

// Example
config.AddSection("Repositories", sectionConfig => {
    ...
});

AddSectionBefore(string beforeAlias, string name, Lambda sectionConfig = null) : KonstruktSectionConfigBuilder

Adds a section to the Umbraco menu with the given name before the section with the given alias.

// Example
config.AddSectionBefore("settings", "Repositories", sectionConfig => {
    ...
});

AddSectionAfter(string afterAlias, string name, Lambda sectionConfig = null) : KonstruktSectionConfigBuilder

Adds a section to the Umbraco menu with the given name after the section with the given alias.

// Example
config.AddSectionAfter("media", "Repositories", sectionConfig => {
    ...
});

Changing a section alias

SetAlias(string alias) : KonstruktSectionConfigBuilder

Sets the alias of the section.

Optional: When adding a new section, an alias is automatically generated from the supplied name for you, however you can use the SetAlias method to override this should you need a specific alias.

// Example
sectionConfig.SetAlias("repositories");

Configuring the section tree

Tree(Lambda treeConfig = null) : KonstruktTreeConfigBuilder

Accesses the tree config of the current section. See Trees documentation for more info.

// Example
sectionConfig.Tree(treeConfig => {
    ...
});

Adding a dashboard to the section

AddDashboard(string name, Lambda dashboardConfig = null) : KonstruktDashboardConfigBuilder

Adds a dashboard with the given name. See Dashboards documentation for more info.

// Example
sectionConfig.AddDashboard("Team", dashboardConfig => {
    ...
});

AddDashboardBefore(string beforeAlias, string name, Lambda dashboardConfig = null) : KonstruktDashboardConfigBuilder

Adds a dashboard with the given name before the dashboard with the given alias. See Dashboards documentation for more info.

// Example
sectionConfig.AddDashboardBefore("contentIntro", "Team", dashboardConfig => {
    ...
});

AddDashboardAfter(string afterAlias, string name, Lambda dashboardConfig = null) : KonstruktDashboardConfigBuilder

Adds a dashboard with the given name after the dashboard with the given alias. See Dashboards documentation for more info.

// Example
sectionConfig.AddDashboardAfter("contentIntro", "Team", dashboardConfig => {
    ...
});

Extending an existing section

You can extend existing sections adding Konstrukt trees and dashboards, context apps and virtual sub trees by calling the WithSection method on the root level KonstruktConfigBuilder instance.

WithSection(string alias, Lambda sectionConfig = null) : KonstruktWithSectionConfigBuilder

Starts a sub configuration for the existing Umbraco section with the given alias.

// Example
config.WithSection("member", withSectionConfig => {
    ...
});

Adding a tree to an existing section

AddTree(string name, string icon, Lambda treeConfig = null) : KonstruktTreeConfigBuilder

Adds a tree to the current section. See Trees documentation for more info.

// Example
withSectionConfig.AddTree("My Tree", "icon-folder", treeConfig => {
    ...
});

AddTree(string groupName, string name, string icon, Lambda treeConfig = null) : KonstruktTreeConfigBuilder

Adds a tree to the current section in a group with the given name. See Trees documentation for more info.

// Example
withSectionConfig.AddTree("My Group", "My Tree", "icon-folder", treeConfig => {
    ...
});

AddTreeBefore(string treeAlias, string name, string icon, Lambda treeConfig = null) : KonstruktTreeConfigBuilder

Adds a tree to the current section before the tree with the given alias. See Trees documentation for more info.

// Example
withSectionConfig.AddTreeBefore("member", "My Tree", "icon-folder", treeConfig => {
    ...
});

AddTreeAfter(string treeAlias, string name, string icon, Lambda treeConfig = null) : KonstruktTreeConfigBuilder

Adds a tree to the current section after the tree with the given alias. See Trees documentation for more info.

// Example
withSectionConfig.AddTreeAfter("member", "My Tree", "icon-folder", treeConfig => {
    ...
});

Adding a dashboard to an existing section

AddDashboard(string name, Lambda dashboardConfig = null) : KonstruktDashboardConfigBuilder

Adds a dashboard with the given name. See Dashboards documentation for more info.

// Example
withSectionConfig.AddDashboard("Team", dashboardConfig => {
    ...
});

AddDashboardBefore(string beforeAlias, string name, Lambda dashboardConfig = null) : KonstruktDashboardConfigBuilder

Adds a dashboard with the given name before the dashboard with the given alias. See Dashboards documentation for more info.

// Example
withSectionConfig.AddDashboardBefore("contentIntro", "Team", dashboardConfig => {
    ...
});

AddDashboardAfter(string afterAlias, string name, Lambda dashboardConfig = null) : KonstruktDashboardConfigBuilder

Adds a dashboard with the given name after the dashboard with the given alias. See Dashboards documentation for more info.

// Example
withSectionConfig.AddDashboardAfter("contentIntro", "Team", dashboardConfig => {
    ...
});