Skip to content

Commit 451b795

Browse files
committed
Incorporated review comments
1 parent 0cb546d commit 451b795

File tree

1 file changed

+120
-30
lines changed

1 file changed

+120
-30
lines changed

15/umbraco-ui-builder/areas/sections.md

Lines changed: 120 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -34,26 +34,38 @@ config.AddSection("Repositories", sectionConfig => {
3434

3535
This method adds a section before another section with the specified alias, allowing for customized ordering of sections in the backoffice.
3636

37+
#### Method Syntax
38+
39+
```cs
40+
AddSectionBefore(string beforeAlias, string name, Lambda sectionConfig = null) : SectionConfigBuilder
41+
```
42+
43+
#### Example
44+
3745
```csharp
3846
config.AddSectionBefore("settings", "Repositories", sectionConfig => {
3947
...
4048
});
4149
```
4250

43-
**Code Reference:** `AddSectionBefore(string beforeAlias, string name, Lambda sectionConfig = null) : SectionConfigBuilder`
44-
4551
### Using the `AddSectionAfter()` Method
4652

4753
This method adds a section after another section with the specified alias, allowing for a custom order of sections in the backoffice.
4854

55+
#### Method Syntax
56+
57+
```cs
58+
AddSectionAfter(string afterAlias, string name, Lambda sectionConfig = null) : SectionConfigBuilder
59+
```
60+
61+
#### Example
62+
4963
```csharp
5064
config.AddSectionAfter("media", "Repositories", sectionConfig => {
5165
...
5266
});
5367
```
5468

55-
**Code Reference:** `AddSectionAfter(string afterAlias, string name, Lambda sectionConfig = null) : SectionConfigBuilder`
56-
5769
## Customizing the Section Alias
5870

5971
### Setting a Custom Alias with `SetAlias()` Method
@@ -62,64 +74,94 @@ This method sets a custom alias for the section.
6274

6375
*Optional:* By default, an alias is automatically generated from the section's name. To customize the alias, the `SetAlias()` method can be used.
6476

77+
#### Method Syntax
78+
79+
```cs
80+
SetAlias(string alias) : SectionConfigBuilder
81+
```
82+
83+
#### Example
84+
6585
```csharp
6686
sectionConfig.SetAlias("repositories");
6787
```
6888

69-
**Code Reference:** `SetAlias(string alias) : SectionConfigBuilder`
70-
7189
## Configuring the Section Tree
7290

7391
### Using the `Tree()` Method for Configuration
7492

7593
This method configures the tree structure for the section, which is used to organize content types. For more information, see the [Trees](trees.md) article.
7694

95+
#### Method Syntax
96+
97+
```cs
98+
Tree(Lambda treeConfig = null) : TreeConfigBuilder
99+
```
100+
101+
#### Example
102+
77103
````csharp
78104
sectionConfig.Tree(treeConfig => {
79105
...
80106
});
81107
````
82108

83-
**Code Reference:** `Tree(Lambda treeConfig = null) : TreeConfigBuilder`
84-
85109
## Adding Dashboards to the Section
86110

87111
### Adding a Dashboard with the `AddDashboard()` Method
88112

89113
This method adds a dashboard to the section with the specified alias, providing tools and features for content management. For more information, see the [Dashboards](dashboards.md) article.
90114

115+
#### Method Syntax
116+
117+
```cs
118+
AddDashboard(string name, Lambda dashboardConfig = null) : DashboardConfigBuilder
119+
```
120+
121+
#### Example
122+
91123
```csharp
92124
sectionConfig.AddDashboard("Team", dashboardConfig => {
93125
...
94126
});
95127
```
96128

97-
**Code Reference:** AddDashboard(string name, Lambda dashboardConfig = null) : DashboardConfigBuilder
98-
99129
### Using `AddDashboardBefore()` to Place a Dashboard
100130

101131
This method adds a dashboard before another dashboard with the specified alias, allowing custom placement in the section. For more information, see the [Dashboards](dashboards.md) article.
102132

133+
#### Method Syntax
134+
135+
```cs
136+
AddDashboardBefore(string beforeAlias, string name, Lambda dashboardConfig = null) : DashboardConfigBuilder
137+
```
138+
139+
#### Example
140+
103141
```csharp
104142
sectionConfig.AddDashboardBefore("contentIntro", "Team", dashboardConfig => {
105143
...
106144
});
107145
```
108146

109-
**Code Reference:** `AddDashboardBefore(string beforeAlias, string name, Lambda dashboardConfig = null) : DashboardConfigBuilder`
110-
111147
### Using `AddDashboardAfter()` to Place a Dashboard
112148

113149
This method adds a dashboard after another dashboard with the specified alias, giving control over dashboard order. For more information, see the [Dashboards](dashboards.md) article.
114150

151+
#### Method Syntax
152+
153+
```cs
154+
AddDashboardAfter(string afterAlias, string name, Lambda dashboardConfig = null) : DashboardConfigBuilder
155+
```
156+
157+
#### Example
158+
115159
```csharp
116160
sectionConfig.AddDashboardAfter("contentIntro", "Team", dashboardConfig => {
117161
...
118162
});
119163
```
120164

121-
**Code Reference:** `AddDashboardAfter(string afterAlias, string name, Lambda dashboardConfig = null) : DashboardConfigBuilder`
122-
123165
## Extending Existing Sections
124166

125167
You can extend existing sections by adding Umbraco UI Builder trees and dashboards, context apps, and virtual subtrees. This can be done by calling the `WithSection` method on the root-level `UIBuilderConfigBuilder` instance.
@@ -128,100 +170,148 @@ You can extend existing sections by adding Umbraco UI Builder trees and dashboar
128170

129171
This method extends an existing section with additional configuration, enabling more customization for existing areas.
130172

173+
#### Method Syntax
174+
175+
```cs
176+
WithSection(string alias, Lambda sectionConfig = null) : WithSectionConfigBuilder
177+
```
178+
179+
#### Example
180+
131181
```csharp
132182
config.WithSection("member", withSectionConfig => {
133183
...
134184
});
135185
```
136186

137-
**Code Reference:** `WithSection(string alias, Lambda sectionConfig = null) : WithSectionConfigBuilder`
138-
139187
## Adding Trees to an Existing Section
140188

141189
### Using the `AddTree()` Method
142190

143191
This method adds a tree to the section, helping to visualize and organize content types. For more information, see the [Trees](trees.md) article.
144192

193+
#### Method Syntax
194+
195+
```cs
196+
AddTree(string name, string icon, Lambda treeConfig = null) : TreeConfigBuilder
197+
```
198+
199+
#### Example
200+
145201
````csharp
146202
withSectionConfig.AddTree("My Tree", "icon-folder", treeConfig => {
147203
...
148204
});
149205
````
150206

151-
**Code Reference:** `AddTree(string name, string icon, Lambda treeConfig = null) : TreeConfigBuilder`
152-
153207
### Grouping Trees with `AddTree()` Method
154208

155209
This method adds a tree within a specified group, improving content organization by grouping related trees together. For more information, see the [Trees](trees.md) article.
156210

211+
#### Method Syntax
212+
213+
```cs
214+
AddTree(string groupName, string name, string icon, Lambda treeConfig = null) : TreeConfigBuilder
215+
```
216+
217+
#### Example
218+
157219
````csharp
158220
withSectionConfig.AddTree("My Group", "My Tree", "icon-folder", treeConfig => {
159221
...
160222
});
161223
````
162224

163-
**Code Reference:** `AddTree(string groupName, string name, string icon, Lambda treeConfig = null) : TreeConfigBuilder`
164-
165225
## Adding a Tree Before or After an Existing Tree
166226

167227
### Using `AddTreeBefore()` to Position a Tree
168228

169229
This method adds a tree before another tree within the section, allowing you to customize the tree order. For more information, see the [Trees](trees.md) article.
170230

231+
#### Method Syntax
232+
233+
```cs
234+
AddTreeBefore(string treeAlias, string name, string icon, Lambda treeConfig = null) : TreeConfigBuilder
235+
```
236+
237+
#### Example
238+
171239
````csharp
172240
withSectionConfig.AddTreeBefore("member", "My Tree", "icon-folder", treeConfig => {
173241
...
174242
});
175243
````
176244

177-
**Code Reference:** `AddTreeBefore(string treeAlias, string name, string icon, Lambda treeConfig = null) : TreeConfigBuilder`
178-
179245
### Using `AddTreeAfter()` to Position a Tree
180246

181247
This method adds a tree after another tree within the section, enabling specific ordering of trees. For more information, see the [Trees](trees.md) article.
182248

249+
#### Method Syntax
250+
251+
```cs
252+
AddTreeAfter(string treeAlias, string name, string icon, Lambda treeConfig = null) : TreeConfigBuilder
253+
```
254+
255+
#### Example
256+
183257
````csharp
184258
withSectionConfig.AddTreeAfter("member", "My Tree", "icon-folder", treeConfig => {
185259
...
186260
});
187261
````
188262

189-
**Code Reference:** `AddTreeAfter(string treeAlias, string name, string icon, Lambda treeConfig = null) : TreeConfigBuilder`
190-
191263
## Adding a Dashboard to an Existing Section
192264

193265
### Using the `AddDashboard()` Method
194266

195267
This method adds a new dashboard to the section with the specified name. For more information, see the [Dashboards](dashboards.md) article.
196268

269+
#### Method Syntax
270+
271+
```cs
272+
AddDashboard (string name, Lambda dashboardConfig = null) : DashboardConfigBuilder
273+
```
274+
275+
#### Example
276+
197277
```csharp
198278
withSectionConfig.AddDashboard("Team", dashboardConfig => {
199279
...
200280
});
201281
```
202282

203-
**Code Reference:** `AddDashboard (string name, Lambda dashboardConfig = null) : DashboardConfigBuilder`
204-
205283
### Using the `AddDashboardBefore()` Method
206284

207285
This method adds a dashboard before the dashboard with the specified alias. For more information, see the [Dashboards](dashboards.md) article.
208286

287+
#### Method Syntax
288+
289+
```cs
290+
AddDashboardBefore (string beforeAlias, string name, Lambda dashboardConfig = null) : DashboardConfigBuilder
291+
```
292+
293+
#### Example
294+
209295
```csharp
210296
withSectionConfig.AddDashboardBefore("contentIntro", "Team", dashboardConfig => {
211297
...
212298
});
213299
```
214300

215-
**Code Reference:** `AddDashboardBefore (string beforeAlias, string name, Lambda dashboardConfig = null) : DashboardConfigBuilder`
216-
217301
### Using the `AddDashboardAfter()` Method
218302

219303
This method adds a dashboard after the dashboard with the specified alias. For more information, see the [Dashboards](dashboards.md) article.
220304

305+
#### Method Syntax
306+
307+
```cs
308+
AddDashboardAfter (string afterAlias, string name, Lambda dashboardConfig = null) : DashboardConfigBuilder
309+
```
310+
311+
#### Example
312+
221313
```csharp
222314
withSectionConfig.AddDashboardAfter("contentIntro", "Team", dashboardConfig => {
223315
...
224316
});
225317
```
226-
227-
**Code Reference:** `AddDashboardAfter (string afterAlias, string name, Lambda dashboardConfig = null) : DashboardConfigBuilder`

0 commit comments

Comments
 (0)