Umbraco UI Builder
CMSCloudHeartcoreDXP
13.latest (LTS)
13.latest (LTS)
  • Umbraco UI Builder Documentation
  • Known Issues
  • Release Notes
  • Installation
    • Installing Umbraco UI Builder
    • Licensing
  • Upgrading
    • Upgrading Umbraco UI Builder
    • Version Specific Upgrade Notes
    • Migrate from Konstrukt to Umbraco UI Builder
  • Getting Started
    • Overview
    • Configuration
    • User Interface
  • How-to Guides
    • Creating your first integration
  • Areas
    • Overview
    • Sections
      • Summary Dashboards
    • Trees
      • Folders
    • Dashboards
    • Context Apps
  • Collections
    • Overview
    • The Basics
    • List Views
      • Field Views
    • Editors
    • Child Collections
      • Child Collection Groups
      • Retrieve Child Collections
    • Related Collections
    • Entity Identifier Converters
  • Searching
    • Overview
    • Searchable Properties
  • Filtering
    • Overview
    • Global Filters
    • Data Views
      • Data Views Builders
    • Filterable Properties
  • Actions
    • Overview
    • The Basics
    • Action Visibility
    • Inbuilt Actions
  • Cards
    • Overview
    • Count Cards
    • Custom Cards
  • Property Editors
    • Overview
    • Entity Picker
  • Advanced
    • Virtual Sub Trees
    • Encrypted Properties
    • Value Mappers
    • Repositories
    • Events
  • Miscellaneous
    • Conventions
    • Umbraco Aliases
Powered by GitBook
On this page
Edit on GitHub
Export as PDF
  1. Getting Started

Configuration

Configuring Umbraco UI Builder, the backoffice UI builder for Umbraco.

Umbraco UI Builder can be configured directly via the AddUIBuilder extension method on IUmbracoBuilder.

AddUIBuilder

To configure Umbraco UI Builder via the AddUIBuilder extension method, you can look at the Program.cs file at the root of your web project. From within this file, before the call to AddComposers() you can add the AddUIBuilder configuration.

Alternatively, if your project is upgraded from earlier versions, you can add the configuration to the Startup.cs file.

builder.CreateUmbracoBuilder()
    .AddBackOffice()
    .AddWebsite()
    .AddUIBuilder(cfg => {
                // Apply your configuration here
    })
    .AddDeliveryApi()
    .AddComposers()
    .Build();

The AddUIBuilder extension method accepts a single parameter, a delegate function with one of the Umbraco UI Builder configuration builder arguments. With this, you can call the relevant fluent APIs to define your solution.

PreviousOverviewNextUser Interface

Last updated 7 months ago