-
Notifications
You must be signed in to change notification settings - Fork 799
Updated articles #6854
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Updated articles #6854
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
4aedc00
Updated articles
eshanrnh 676984d
Structural changes
eshanrnh b593687
Updated creating your first integration article
eshanrnh 9f69fe1
Updated user interface article
eshanrnh 76a2151
Moved images into new folder structure
eshanrnh b45b655
Updated old names to new naming conventions
eshanrnh 90f067c
Update 15/umbraco-ui-builder/getting-started/configuration.md
eshanrnh b52dcb9
Update 15/umbraco-ui-builder/getting-started/installation.md
eshanrnh f23c61c
Update 15/umbraco-ui-builder/getting-started/installation.md
eshanrnh 60313d8
Update 15/umbraco-ui-builder/getting-started/licensing-model.md
eshanrnh 85dbda8
Update 15/umbraco-ui-builder/getting-started/licensing-model.md
eshanrnh 4478d47
Update 15/umbraco-ui-builder/getting-started/requirements.md
eshanrnh 35832ce
Update 15/umbraco-ui-builder/getting-started/user-interface.md
eshanrnh cdfa041
Updated images
eshanrnh a1aee12
Moved images after text
eshanrnh af50a20
Minor fixes
eshanrnh 9a4ad1f
Update 15/umbraco-ui-builder/guides/creating-your-first-integration.md
eshanrnh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,33 @@ | ||
--- | ||
description: Configuring Umbraco UI Builder, the backoffice UI builder for Umbraco. | ||
description: Learn how to configure Umbraco UI Builder using the extension method. | ||
--- | ||
|
||
# Configuration | ||
|
||
Umbraco UI Builder can be configured directly via the `AddUIBuilder` extension method on `IUmbracoBuilder`. | ||
You can configure Umbraco UI Builder using the `AddUIBuilder` extension method in `Program.cs`. | ||
|
||
## AddUIBuilder | ||
## Using `AddUIBuilder` | ||
|
||
To configure Umbraco UI Builder via the `AddUIBuilder` extension method, You can look in the `Program.cs` file in the root of your web project. From within this file, before the call to `AddComposers()` we can add our `AddUIBuilder` configuration. | ||
To configure Umbraco UI Builder: | ||
|
||
1. Open the `Program.cs` file in your project. | ||
2. Locate the `CreateUmbracoBuilder()` method. | ||
3. Add `AddUIBuilder` before `AddComposers()`. | ||
|
||
```csharp | ||
builder.CreateUmbracoBuilder() | ||
.AddBackOffice() | ||
.AddWebsite() | ||
.AddUIBuilder(cfg => { | ||
// Apply your configuration here | ||
// 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 then call the relevant fluent APIs to define your solution. | ||
{% hint style="info" %} | ||
If you want an example configuration, see the **Configure Umbraco UI Builder** section in the [Creating your First Integration](../guides/creating-your-first-integration.md) article. | ||
{% endhint %} | ||
|
||
The `AddUIBuilder` method accepts a delegate function, allowing you to configure your solution using fluent APIs. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
description: Follow the steps to install Umbraco UI Builder into your Umbraco CMS website. | ||
--- | ||
|
||
# Installation | ||
|
||
In this article, you will learn how to install Umbraco UI Builder into your Umbraco CMS implementation. | ||
|
||
## Install via Command Line | ||
|
||
Run the following command in your web project: | ||
|
||
```sh | ||
dotnet add package Umbraco.UIBuilder | ||
``` | ||
|
||
For a class library without UI elements, install: | ||
|
||
```sh | ||
dotnet add package Umbraco.UIBuilder.Startup | ||
``` | ||
|
||
## Install via Visual Studio | ||
|
||
To install via Visual Studio, follow these steps: | ||
|
||
1. Open Visual Studio and load your project. | ||
2. Go to **Tools** -> **NuGet Package Manager** -> **Manage NuGet Packages for Solution...** | ||
3. Select the **Browse** tab and search for **Umbraco.UIBuilder**. | ||
|
||
 | ||
|
||
4. Select a version from the **Version** drop-down based on the Umbraco CMS version you are using. | ||
5. Click **Install**. | ||
6. *[Optional]* Search for and install **Umbraco.UIBuilder.Startup** if installing without UI elements. | ||
7. Ensure that the package reference is added to the **.csproj** file once the installation is complete: | ||
|
||
```cs | ||
<ItemGroup> | ||
<PackageReference Include="Umbraco.UIBuilder" Version="15.0.2" /> | ||
</ItemGroup> | ||
``` | ||
|
||
## Installing a License | ||
|
||
For details on how to install a license, see the [Licensing](licensing-model.md#installing-your-license) article. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
description: >- | ||
Get started with Umbraco UI Builder by understanding its system requirements, | ||
versioning, and installation prerequisites. | ||
--- | ||
|
||
# Requirements | ||
|
||
In this article, you will find the requirements to get started with Umbraco UI Builder. Umbraco UI Builder allows you to create and manage custom UI elements for your Umbraco backoffice. | ||
|
||
## Prerequisites | ||
|
||
* Umbraco 15+ website configured and ready to install Umbraco UI Builder. | ||
|
||
{% hint style="info" %} | ||
For instructions on installing Umbraco, see the [Umbraco CMS Documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/install). | ||
{% endhint %} | ||
|
||
## System Requirements | ||
|
||
To use Umbraco UI Builder, your setup must meet these minimum requirements: | ||
|
||
* **Umbraco CMS version 15+** | ||
* **SQL Server Database** (SQLite is acceptable for testing but not recommended for live deployments) | ||
|
||
## Versioning | ||
|
||
Umbraco UI Builder is an add-on product for Umbraco CMS, and follows the [versioning strategy laid out for Umbraco CMS](https://umbraco.com/products/knowledge-center/versioning-and-release-cadence/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,61 @@ | ||
--- | ||
description: Key User Interface Concepts used by Umbraco UI Builder, the backoffice UI builder for Umbraco. | ||
description: Key User Interface Concepts used by Umbraco UI Builder. | ||
--- | ||
|
||
# User Interface | ||
|
||
Before you get to know Umbraco UI Builder, you need to become familiar with the Umbraco UI and a few of its concepts. This is because Umbraco UI Builder reuses these same concepts for constructing its UI. | ||
Before diving into Umbraco UI Builder, it’s important to understand some of the fundamental concepts of the Umbraco UI. This knowledge will help you navigate and leverage the UI Builder more effectively, as it uses the same UI components to construct interfaces. | ||
|
||
 | ||
## Section | ||
|
||
**1. Section** A distinct area of the Umbraco backoffice. | ||
**2. Tree** A hierarchical structure to help organize a section. | ||
**3. Dashboard** An intro screen for a section, usually with useful links for that section. | ||
A section in Umbraco is a distinct area within the backoffice where related content and functionality are grouped. For example, the Content section is where content management happens, while the Media section handles media files. | ||
|
||
 | ||
 | ||
|
||
**4. List View** A list-based view of items in a tree node. | ||
## Tree | ||
|
||
 | ||
The tree represents the hierarchical structure of items within a section. It organizes content, settings, and data, for quick navigation and locating items. For example, the content tree shows the pages of a website in a nested format. | ||
|
||
**5. Editor** The main content editing area is made up of tabs, fieldsets, and fields. | ||
 | ||
|
||
 | ||
## Dashboard | ||
|
||
**6. Context Apps** A contextual section of a given editor UI. | ||
**7. Tabs** A tabbed container of content. | ||
Each section in the Umbraco backoffice typically starts with a dashboard. This is an introductory screen for the section. It often includes useful links or shortcuts, providing an overview or quick access to the most commonly used features. | ||
|
||
 | ||
 | ||
|
||
**8. Menu Item** A context menu item + action. | ||
## Collection | ||
|
||
 | ||
The collection displays a list of items in a tree or grid view. It provides an overview of content or data in a table format, with sortable columns and the option to filter or search through the items. This view is used when you need to work with multiple items at once. | ||
|
||
**9. Bulk Action** An action to perform on multiple list view items at once. | ||
 | ||
|
||
## Editor | ||
|
||
The editor is where the main content editing occurs. It is structured using tabs, fieldsets, and fields. Tabs organize different sections of content, and fieldsets group related fields together. Each field represents a specific piece of data, such as a text box or an image upload. | ||
|
||
 | ||
|
||
## Workspace Views | ||
|
||
Workspace Views are additional functionality that can be added to an editor. They provide extra features based on the content of the item being edited. For instance, a media content app might allow you to resize or crop an image directly from the editor. | ||
|
||
 | ||
|
||
## Tabs | ||
|
||
Tabs are used to organize content within the editor, allowing users to switch between different sections of a content item. For example, one tab might contain the general settings, while another contains media or advanced options. | ||
|
||
 | ||
|
||
## Menu Item | ||
|
||
A menu item represents an action within the context of a tree node or a list item. It is a clickable item that triggers specific tasks, such as deleting or editing an item. | ||
|
||
 | ||
|
||
## Bulk Action | ||
|
||
Bulk actions allow you to perform an operation on multiple items in the list view at once. For example, you might use a bulk action to delete multiple content items or update their status in a single step. | ||
|
||
 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.