Skip to content

Commit 52f87e6

Browse files
sofietoftsofietoft
committed
Duplicate uiBuilder docs
1 parent 73876ca commit 52f87e6

File tree

92 files changed

+4108
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+4108
-0
lines changed

‎15/umbraco-ui-builder/.gitbook.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root: ./
2+
3+
​structure:
4+
readme: README.md
5+
summary: SUMMARY.md
6+
7+
redirects:
8+
getting-started/upgrading/README: upgrading/upgrade.md
9+
getting-started/upgrading/version-specific-upgrades: upgrading/version-specific.md
10+
getting-started/installation: installation/installation.md
11+
getting-started/licensing-model: installation/licensing-model.md
12+
guides/migrating-from-konstrukt-to-umbraco-ui-builder: upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md

‎15/umbraco-ui-builder/README.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
description: Documentation for Umbraco UI Builder, the backoffice UI builder for Umbraco.
3+
---
4+
5+
# Umbraco UI Builder Documentation
6+
7+
Umbraco UI Builder is the backoffice UI builder for custom data structures configured via a fluent API.
8+
9+
![Example Umbraco UI Builder UI](images/listview.png)
10+
11+
If you have a custom data store that you want to content manage from within Umbraco, then you can use Umbraco UI Builder. With some lines of code, you can configure a custom administration UI, and reuse many core components with a consistent look and feel.
12+
13+
With Umbraco UI Builder, custom backoffice integrations can now take a matter of minutes, rather than days.
14+
15+
## Using the Documentation
16+
17+
**This documentation is aimed at developers** who have at least a basic understanding of Umbraco, as well as C#/MVC principles.
18+
19+
If you are new to Umbraco UI Builder, it is recommended that you start by taking a look at the [Getting Started](./getting-started/overview.md) section. This provides details on the system requirements and how to install Umbraco UI Builder.
20+
21+
Once you have Umbraco UI Builder installed and are wondering "What next?" then you'll want to take a look at the [Guides](./guides/creating-your-first-integration.md) section. This provides a quick-start example of how to configure Umbraco UI Builder.
22+
23+
Use the main menu to dive deeper into Umbraco UI Builder and get to know all of its features in detail. You can then jump to the specific topic you are interested in to find out more.
24+
25+
Finally, for all other resources/useful information you can head over to the [Miscellaneous](./miscellaneous/conventions.md) section.
26+
27+
## Getting Help
28+
29+
If you require assistance you can use our support channels to seek assistance.

‎15/umbraco-ui-builder/SUMMARY.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Table of contents
2+
3+
* [Umbraco UI Builder Documentation](README.md)
4+
* [Known Issues](known-issues.md)
5+
* [Release Notes](release-notes.md)
6+
7+
## Installation
8+
9+
* [Installing Umbraco UI Builder](installation/installation.md)
10+
* [Licensing](installation/licensing-model.md)
11+
12+
## Upgrading
13+
14+
* [Upgrading Umbraco UI Builder](upgrading/upgrade.md)
15+
* [Version Specific Upgrade Notes](upgrading/version-specific.md)
16+
* [Migrate from Konstrukt to Umbraco UI Builder](upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md)
17+
18+
## Getting Started
19+
20+
* [Overview](getting-started/overview.md)
21+
* [Configuration](getting-started/configuration.md)
22+
* [User Interface](getting-started/user-interface.md)
23+
24+
## How-to Guides
25+
26+
* [Creating your first integration](guides/creating-your-first-integration.md)
27+
28+
## Areas
29+
30+
* [Overview](areas/overview.md)
31+
* [Sections](areas/sections.md)
32+
* [Summary Dashboards](areas/summary-dashboards.md)
33+
* [Trees](areas/trees.md)
34+
* [Folders](areas/folders.md)
35+
* [Dashboards](areas/dashboards.md)
36+
* [Context Apps](areas/context-apps.md)
37+
38+
## Collections
39+
40+
* [Overview](collections/overview.md)
41+
* [The Basics](collections/the-basics.md)
42+
* [List Views](collections/list-views.md)
43+
* [Field Views](collections/field-views.md)
44+
* [Editors](collections/editors.md)
45+
* [Child Collections](collections/child-collections.md)
46+
* [Child Collection Groups](collections/child-collection-groups.md)
47+
* [Retrieve Child Collections](collections/retrieve-child-collections.md)
48+
* [Related Collections](collections/related-collections.md)
49+
50+
## Searching
51+
52+
* [Overview](searching/overview.md)
53+
* [Searchable Properties](searching/searchable-properties.md)
54+
55+
## Filtering
56+
57+
* [Overview](filtering/overview.md)
58+
* [Global Filters](filtering/global-filters.md)
59+
* [Data Views](filtering/data-views.md)
60+
* [Data Views Builders](filtering/data-views-builders.md)
61+
* [Filterable Properties](filtering/filterable-properties.md)
62+
63+
## Actions
64+
65+
* [Overview](actions/overview.md)
66+
* [The Basics](actions/the-basics.md)
67+
* [Action Visibility](actions/action-visibility.md)
68+
* [Inbuilt Actions](actions/inbuilt-actions.md)
69+
70+
## Cards
71+
72+
* [Overview](cards/overview.md)
73+
* [Count Cards](cards/count-cards.md)
74+
* [Custom Cards](cards/custom-cards.md)
75+
76+
## Property Editors
77+
78+
* [Overview](property-editors/overview.md)
79+
* [Entity Picker](property-editors/entity-picker.md)
80+
81+
## Advanced
82+
83+
* [Virtual Sub Trees](advanced/virtual-sub-trees.md)
84+
* [Encrypted Properties](advanced/encrypted-properties.md)
85+
* [Value Mappers](advanced/value-mappers.md)
86+
* [Repositories](advanced/repositories.md)
87+
* [Events](advanced/events.md)
88+
89+
## Miscellaneous
90+
91+
* [Conventions](miscellaneous/conventions.md)
92+
* [Umbraco Aliases](miscellaneous/umbraco-aliases.md)

‎15/umbraco-ui-builder/actions/action-visibility.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
description: Controlling the visibility of actions in Umbraco UI Builder, the backoffice UI builder for Umbraco.
3+
---
4+
5+
# Action Visibility
6+
7+
By default actions are not visible in the UI and you must expressly define when and where an action should display. This can be achieved in two ways, either on the action definition itself or at the point of registration on the collections config.
8+
9+
## Controlling the default action visibility
10+
11+
To define the default visibility of an action at the action level you can do this by overriding the `IsVisible` method of the `Action<>` base class.
12+
13+
````csharp
14+
// Example
15+
public class MyAction : Action<ActionResult>
16+
{
17+
...
18+
public override bool IsVisible(ActionVisibilityContext ctx)
19+
{
20+
return ctx.ActionType == ActionType.Bulk
21+
|| ctx.ActionType == ActionType.Row;
22+
}
23+
...
24+
}
25+
````
26+
27+
The `IsVisible` method is passed a `ActionVisibilityContext` which you should use to decide whether the action should display, returning `true` if it should, or `false` if it should not. For more information check the [Action visibility context](#action-visibility-context).
28+
29+
## Overriding an actions visibility
30+
31+
Overriding an actions visibility is controlled via the [collections](../collections/overview.md) configuration.
32+
33+
### **AddAction&lt;TMenuActionType&gt;(Lambda actionConfig = null) : CollectionConfigBuilder&lt;TEntityType&gt;**
34+
35+
Adds an action of the given type to the collection with the given visibility.
36+
37+
````csharp
38+
// Example
39+
collectionConfig.AddAction<ExportMenuAction>(actionConfig => actionConfig
40+
.SetVisibility(x => x.ActionType == ActionType.Bulk
41+
|| x.ActionType == ActionType.Row)
42+
);
43+
````
44+
45+
### **AddAction(Type actionType, Lambda actionConfig = null) : CollectionConfigBuilder&lt;TEntityType&gt;**
46+
47+
Adds an action of the given type to the collection with the given visibility.
48+
49+
````csharp
50+
// Example
51+
collectionConfig.AddAction(typeof(ExportMenuAction), actionConfig => actionConfig
52+
.SetVisibility(x => x.ActionType == ActionType.Bulk
53+
|| x.ActionType == ActionType.Row)
54+
);
55+
````
56+
57+
### **AddAction(IAction action, Lambda actionConfig = null) : CollectionConfigBuilder&lt;TEntityType&gt;**
58+
59+
Adds the given action to the collection with the given visibility.
60+
61+
````csharp
62+
// Example
63+
collectionConfig.AddAction(action, actionConfig => actionConfig
64+
.SetVisibility(x => x.ActionType == ActionType.Bulk
65+
|| x.ActionType == ActionType.Row)
66+
);
67+
````
68+
69+
## Action visibility context
70+
71+
When controlling the visibility of an action you will be given a `ActionVisibilityContext` object from which you can decide whether to show the action or not. The visibility context contains two key pieces of information on which you can base this decision.
72+
73+
### ActionType
74+
75+
The action type property is an enum property that define which area of the UI it is that wishes to access this action. Enabling an action to display for a given action type will determine where an action is displayed.
76+
77+
#### ContainerMenu
78+
79+
The `ContainerMenu` action type determines that the action will be displayed in both the tree of the collection and its list view actions menu.
80+
81+
![Container Menu](../images/container_actions_menu.png)
82+
83+
#### EntityMenu
84+
85+
The `EntityMenu` action type determines that the action will be displayed in the actions menu of a collection editor UI.
86+
87+
![Entity Menu](../images/entity_actions_menu.png)
88+
89+
#### Bulk
90+
91+
The `Bulk` action type determines that the action will be displayed in the collection list view bulk actions menu.
92+
93+
![Bulk Actions](../images/bulk_actions_menu.png)
94+
95+
#### Row
96+
97+
The `Row` action type determines that the action will be displayed in the collection list view action row menu.
98+
99+
![Row Actions](../images/row_actions_menu.png)
100+
101+
#### Save
102+
103+
The `Save` action type determines that the action will be displayed as a sub button in an entity editors save button. All `Save` action types trigger a save before the action is executed and so to convey this, all `Save` action type button labels are prefixed `Save & [Action Name]`
104+
105+
![Save Actions](../images/save_actions_menu.png)
106+
107+
### UserGroups
108+
109+
The user groups collection contains a list of Umbraco `IReadOnlyUserGroup` objects for the current logged-in backoffice user. This allows you to control the visibility of actions for given user group members.

‎15/umbraco-ui-builder/actions/inbuilt-actions.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
description: A list of inbuilt actions that come with Umbraco UI Builder, the backoffice UI builder for Umbraco.
3+
---
4+
5+
# Inbuilt Actions
6+
7+
Umbraco UI Builder comes with some inbuilt actions that are available for you to use straight away.
8+
9+
## ExportEntityAction
10+
11+
**Namespace** Umbraco.UIBuilder.Infrastructure.Configuration.Actions
12+
13+
Provides a Comma-Separated Values (CSV) export functionality converting all properties to column headings and rendering each entity property values on each row.
14+
15+
## ImportEntityAction
16+
17+
**Namespace** Umbraco.UIBuilder.Infrastructure.Configuration.Actions
18+
19+
Provides a Comma-Separated Values (CSV) import functionality matching column headings with entity properties and mapping row values to an entity.

‎15/umbraco-ui-builder/actions/overview.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
description: Configuring actions in Umbraco UI Builder, the backoffice UI builder for Umbraco.
3+
---
4+
5+
# Actions
6+
7+
Actions provide an API to perform custom tasks against a collection and its entities from multiple locations in the UI. Examples: menu actions, bulk actions, or individual table row actions.
8+
9+
![Bulk Actions UI](../images/bulk_actions.png)
10+
11+
Get started with actions by learning about the basics.
12+
13+
{% content-ref url="the-basics.md" %}
14+
[the-basics.md](the-basics.md)
15+
{% endcontent-ref %}

0 commit comments

Comments
 (0)