You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Introducing Section extensions, a home for custom content and functionality.
3
3
---
4
4
5
-
# Sections
5
+
# Section
6
6
7
-
{% hint style="warning" %}
8
-
This page is a work in progress and may undergo further revisions, updates, or amendments. The information contained herein is subject to change without notice.
9
-
{% endhint %}
7
+
Umbraco extension authors can place their extension in the top-level navigation of the backoffice using Sections. The extension will be placed among the default options such as Content, Media, Settings, etc.
10
8
11
-
The Umbraco backoffice consists of Sections. Section is the main division shown in the top navigation.
12
-
13
-
For example, when you load the backoffice, you'll see the 'Content' section, 'Settings' section, and so on.
14
-
15
-
You can create your own sections to extend Umbraco with room for more features.
9
+
Within the section, authors can add menus, section views, workspace views, or any other content or interface they desire.
When creating a new section it's recommended to use a [Entry Point](../backoffice-entry-point.md)-extension in your [Umbraco Package Manifest](../../../umbraco-package.md). This is to get better control over all the additional extensions required for the new section.
17
+
Sections can be created by adding a definition in the extension's manifest file.
24
18
25
-
Create a section by defining a manifest for it:
26
-
27
-
```typescript
19
+
{% code title="umbraco-package.json" %}
20
+
```json
28
21
{
29
22
"type": "section",
30
23
"alias": "My.Section",
@@ -35,31 +28,33 @@ Create a section by defining a manifest for it:
35
28
}
36
29
}
37
30
```
31
+
{% endcode %}
38
32
39
-
Once registered, you will be able to select this action for your User Group Permissions. Once that is permitted, you can view your section.
To enable custom sections for backoffice users, site administrators must first assign permissions to those users. This involves configuring the permission for a user group and assigning users to that group.
36
+
37
+
To grant access to the custom section, open the Umbraco backoffice, navigate to the **Users** section, and select the **User groups** menu item. Site administrators can create a new user group or modify an existing one.
42
38
43
-
#### **Extend with Sidebar, Dashboards and more**
39
+
Once the user group is open, click the **Choose** button under the Sections section. Select the custom section from the slide-out modal to enable access.
44
40
45
-
Once a section is registered, it can be extended like any other section.
41
+
<figure><imgsrc="../../../../.gitbook/assets/sections-assigning.png"alt=""><figcaption><p>Enabling new Sections</p></figcaption></figure>
46
42
47
-
Here is a list of appropriate extensions to append to your section:
43
+
After assigning permission, users may need to reload the backoffice for the changes to take effect.
*[Creating a Custom Dashboard](../../../../tutorials/creating-a-custom-dashboard/)
50
-
*[Section Sidebar](section-sidebar.md)
51
-
*[Section View](section-view.md)
47
+
## **Extend with Sidebar, Dashboards, and more**
52
48
53
-
#### **Manifest with empty element**
49
+
Sections serve as blank canvases within the Umbraco backoffice. Extension authors can integrate other Umbraco extensions into sections, including [custom dashboards](../../../../tutorials/creating-a-custom-dashboard/), [sidebars](section-sidebar.md), and [section views](section-view.md).
54
50
55
-
If you prefer full control over the content of your section you can choose to define an element for the content of your section.
51
+
Section authors can also skip Umbraco backoffice components and build a fully custom view by creating an empty element.
56
52
57
-
{% hint style="warning" %}
58
-
This is not recommended as it limits the content of your section to this element. Instead, it is recommended to use a single Dashboard or Section View.
59
-
{% endhint %}
53
+
### **Manifest with empty element**
60
54
61
-
If you like to have full control, you can define an element like this:
55
+
Using a manifest with only an element is not recommended if you are shipping this as a package. This approach limits the Section to a single element. Instead, use a Dashboard or Section View for your main view, which allows additional Dashboards or Section Views to be added to the Section.
When creating a new section, create an [Entry Point](../backoffice-entry-point.md) extension in the [Umbraco Package Manifest](../../../umbraco-package.md) to complement it. Entry Point extensions add initialization and teardown lifecycle events that may be helpful in coordinating behavior inside the section.
50
-
51
47
## **Extend with Sidebar, Dashboards, and more**
52
48
53
49
Sections serve as blank canvases within the Umbraco backoffice. Extension authors can integrate other Umbraco extensions into sections, including [custom dashboards](../../../../tutorials/creating-a-custom-dashboard/), [sidebars](section-sidebar.md), and [section views](section-view.md).
@@ -56,9 +52,7 @@ Section authors can also skip Umbraco backoffice components and build a fully cu
56
52
57
53
### **Manifest with empty element**
58
54
59
-
{% hint style="warning" %}
60
-
This approach is not recommended because it restricts content to a single element. Instead, use a Dashboard or Section View.
61
-
{% endhint %}
55
+
Using a manifest with only an element is not recommended if you are shipping this as a package. This approach limits the Section to a single element. Instead, use a Dashboard or Section View for your main view, which allows additional Dashboards or Section Views to be added to the Section.
Copy file name to clipboardExpand all lines: 17/umbraco-cms/customizing/extending-overview/extension-types/sections/section.md
+3-10Lines changed: 3 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,18 +36,14 @@ To enable custom sections for backoffice users, site administrators must first a
36
36
37
37
To grant access to the custom section, open the Umbraco backoffice, navigate to the **Users** section, and select the **User groups** menu item. Site administrators can create a new user group or modify an existing one.
38
38
39
-
Once the user group is open, click the **Choose** button under the Sections section. Select the custom section from the slide-out modal to enable access.
39
+
Once the user group is open, click the **Choose** button under the Sections section. Select the custom section from the slide-out modal to enable access.
40
40
41
41
<figure><imgsrc="../../../../.gitbook/assets/sections-assigning.png"alt=""><figcaption><p>Enabling new Sections</p></figcaption></figure>
42
42
43
43
After assigning permission, users may need to reload the backoffice for the changes to take effect.
When creating a new section, create an [Entry Point](../backoffice-entry-point.md) extension in the [Umbraco Package Manifest](../../../umbraco-package.md) to complement it. Entry Point extensions add initialization and teardown lifecycle events that may be helpful in coordinating behavior inside the section.
50
-
51
47
## **Extend with Sidebar, Dashboards, and more**
52
48
53
49
Sections serve as blank canvases within the Umbraco backoffice. Extension authors can integrate other Umbraco extensions into sections, including [custom dashboards](../../../../tutorials/creating-a-custom-dashboard/), [sidebars](section-sidebar.md), and [section views](section-view.md).
@@ -56,9 +52,7 @@ Section authors can also skip Umbraco backoffice components and build a fully cu
56
52
57
53
### **Manifest with empty element**
58
54
59
-
{% hint style="warning" %}
60
-
This approach is not recommended because it restricts content to a single element. Instead, use a Dashboard or Section View.
61
-
{% endhint %}
55
+
Using a manifest with only an element is not recommended if you are shipping this as a package. This approach limits the Section to a single element. Instead, use a Dashboard or Section View for your main view, which allows additional Dashboards or Section Views to be added to the Section.
0 commit comments