Dashboards
Configuring Dashboards in Umbraco UI Builder.
Last updated
Was this helpful?
Configuring Dashboards in Umbraco UI Builder.
Last updated
Was this helpful?
Dashboards in Umbraco UI Builder provide an intuitive way to present important information and tools at the root of a section within the Umbraco backoffice. They serve as a starting point for users, offering quick access to relevant data, insights, or actions. Dashboards can be customized, reordered, and configured to display for specific user groups, making them a flexible tool for enhancing the backoffice experience. When multiple dashboards are available in a section, they appear in a tabbed layout for easy navigation.
You can define a dashboard by calling one of the AddDashboard
methods on a SectionConfigBuilder
or a WithSectionConfigBuilder
instance.
AddDashboard()
MethodAdds a dashboard with the specified name.
AddDashboardBefore()
MethodAdds a dashboard with the specified name before the dashboard with the given alias.
AddDashboardAfter()
MethodAdds a dashboard with the specified name after the dashboard with the given alias.
SetAlias()
MethodSets the alias of the dashboard. By default, an alias is automatically generated based on the supplied name. If a specific alias is required, the SetAlias
method can be used to override the default.
Dashboard visibility can be controlled using ShowForUserGroup
and HideForUserGroup
, which specify which user groups can see the dashboard. These settings can be applied multiple times for different user roles.
By default, dashboards are pre-filtered to display only in their defined section. This filtering is combined with the SetVisibility
method to control when a dashboard appears.
SetVisibility()
MethodDefines visibility rules for the dashboard.
A dashboard can display only one collection. To display multiple collections, multiple dashboards must be configured.
SetCollection<>()
MethodAssigns a collection to the dashboard with the specified names, descriptions, and default icons. The ID property must be defined. For more details, see the Collections article.
SetCollection<>()
Method with Custom IconsAssigns a collection to the dashboard with the specified names, descriptions, and custom icons. The ID property must be defined. For more details, see the Collections article.