Skip to content

Commit 48cea2a

Browse files
eshanrnhgitbook-bot
authored andcommitted
GITBOOK-4: Created Landing Pages
1 parent b7e39f9 commit 48cea2a

File tree

37 files changed

+74
-66
lines changed

37 files changed

+74
-66
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading

15/umbraco-ui-builder/SUMMARY.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
## Getting Started
88

9+
* [First Steps with UI Builder](getting-started/first-steps-with-ui-builder.md)
910
* [Requirements](getting-started/requirements.md)
1011
* [Installing Umbraco UI Builder](getting-started/installation.md)
1112
* [Licensing](getting-started/licensing-model.md)
@@ -14,6 +15,7 @@
1415

1516
## Upgrading
1617

18+
* [Upgrade your UI Builder setup](upgrading/upgrade-your-ui-builder-setup.md)
1719
* [Upgrading Umbraco UI Builder](upgrading/upgrade.md)
1820
* [Version Specific Upgrade Notes](upgrading/version-specific.md)
1921
* [Migrate from Konstrukt to Umbraco UI Builder](upgrading/migrating-from-konstrukt-to-umbraco-ui-builder.md)
@@ -24,7 +26,7 @@
2426

2527
## Areas
2628

27-
* [Overview](areas/overview.md)
29+
* [Explore Areas in UI Builder](areas/overview.md)
2830
* [Sections](areas/sections.md)
2931
* [Summary Dashboards](areas/summary-dashboards.md)
3032
* [Trees](areas/trees.md)
@@ -34,7 +36,7 @@
3436

3537
## Collections
3638

37-
* [Overview](collections/overview.md)
39+
* [Work with Collections in UI Builder](collections/overview.md)
3840
* [The Basics](collections/the-basics.md)
3941
* [List Views](collections/list-views.md)
4042
* [Field Views](collections/field-views.md)
@@ -47,37 +49,38 @@
4749

4850
## Searching
4951

50-
* [Overview](searching/overview.md)
52+
* [Add Search to Your Collections](searching/overview.md)
5153
* [Searchable Properties](searching/searchable-properties.md)
5254

5355
## Filtering
5456

55-
* [Overview](filtering/overview.md)
57+
* [Filter Your Data with Ease](filtering/overview.md)
5658
* [Global Filters](filtering/global-filters.md)
5759
* [Data Views](filtering/data-views.md)
5860
* [Data Views Builders](filtering/data-views-builders.md)
5961
* [Filterable Properties](filtering/filterable-properties.md)
6062

6163
## Actions
6264

63-
* [Overview](actions/overview.md)
65+
* [Trigger Actions in UI Builder](actions/overview.md)
6466
* [The Basics](actions/the-basics.md)
6567
* [Action Visibility](actions/action-visibility.md)
6668
* [Inbuilt Actions](actions/inbuilt-actions.md)
6769

6870
## Cards
6971

70-
* [Overview](cards/overview.md)
72+
* [Display Insights with Cards](cards/overview.md)
7173
* [Count Cards](cards/count-cards.md)
7274
* [Custom Cards](cards/custom-cards.md)
7375

7476
## Property Editors
7577

76-
* [Overview](property-editors/overview.md)
78+
* [Enhance Input with Property Editors](property-editors/overview.md)
7779
* [Entity Picker](property-editors/entity-picker.md)
7880

7981
## Advanced
8082

83+
* [Ready to go deeper?](advanced/ready-to-go-deeper.md)
8184
* [Virtual Sub Trees](advanced/virtual-sub-trees.md)
8285
* [Encrypted Properties](advanced/encrypted-properties.md)
8386
* [Value Mappers](advanced/value-mappers.md)
+7-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
2-
description: Learn how to configure actions in Umbraco UI Builder.
2+
description: >-
3+
Actions allow users to interact with data—like saving, deleting, or running
4+
custom processes.
35
---
46

5-
# Actions
7+
# Trigger Actions in UI Builder
68

7-
Actions allow you to perform custom tasks on collections and their entities from different areas in the UI. For Example: menu actions, bulk actions, or individual table row actions.
9+
Actions allow you to perform custom tasks on collections and their entities from different areas in the UI. For Example, menu actions, bulk actions, or individual table row actions.
810

9-
![Bulk Actions UI](../images/bulk_actions.png)
11+
This section covers the basics of configuring actions, controlling their visibility, and using inbuilt options for quick setup.
1012

11-
To get started with actions, check out the basics:
12-
13-
{% content-ref url="the-basics.md" %}
14-
[the-basics.md](the-basics.md)
15-
{% endcontent-ref %}
13+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>The Basics</strong></td><td><p>Understand what actions are, how they work, and how to set them up in UI Builder.</p><p></p></td><td><a href="the-basics.md">the-basics.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_Basic_Website.png">Documentations Icons_Umbraco_CMS_Tutorials_Basic_Website.png</a></td></tr><tr><td><strong>Action Visibility</strong></td><td><p>Control when and where actions are visible based on context or conditions.</p><p></p></td><td><a href="action-visibility.md">action-visibility.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_Deploy_Setup.png">Documentations Icons_Umbraco_Deploy_Setup.png</a></td></tr><tr><td><strong>Inbuilt Actions</strong></td><td>Use UI Builder’s pre-defined actions to handle common tasks with minimal setup.</td><td><a href="inbuilt-actions.md">inbuilt-actions.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_Umbraco_Forms_and_Zapier.png">Documentations Icons_Umbraco_CMS_Tutorials_Umbraco_Forms_and_Zapier.png</a></td></tr></tbody></table>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Ready to go deeper?
2+
3+
This section includes advanced concepts for extending UI Builder’s functionality—from handling data encryption to customizing how values are mapped and stored.
4+
5+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Virtual Sub Trees</strong></td><td><p>Add dynamic, data-driven subtrees under your tree nodes for more flexible navigation.</p><p></p></td><td><a href="virtual-sub-trees.md">virtual-sub-trees.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Extending_Sections_and_Trees.png">Documentations Icons_Umbraco_CMS_Extending_Sections_and_Trees.png</a></td></tr><tr><td><strong>Encrypted Properties</strong></td><td><p>Secure sensitive data by enabling encryption on selected properties.</p><p></p></td><td><a href="encrypted-properties.md">encrypted-properties.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_Google_Authentification.png">Documentations Icons_Umbraco_CMS_Tutorials_Google_Authentification.png</a></td></tr><tr><td><strong>Value Mappers</strong></td><td><p>Transform data between your models and the UI using custom value mappers.</p><p></p></td><td><a href="value-mappers.md">value-mappers.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_Sustainability_Best_Practices_Infrastructure.png">Documentations Icons_Umbraco_Sustainability_Best_Practices_Infrastructure.png</a></td></tr><tr><td><strong>Repositories</strong></td><td><p>Customize how data is queried and saved by working with repositories.</p><p></p></td><td><a href="repositories.md">repositories.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Reference_Caching.png">Documentations Icons_Umbraco_CMS_Reference_Caching.png</a></td></tr><tr><td><strong>Events</strong></td><td>Hook into UI Builder events to execute custom logic during CRUD operations.</td><td><a href="events.md">events.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Reference_Notifications.png">Documentations Icons_Umbraco_CMS_Reference_Notifications.png</a></td></tr></tbody></table>
+9-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
---
2-
description: Learn how to choose and configure the appropriate area for connecting Umbraco UI builder for Umbraco.
2+
description: >-
3+
Learn how to choose and configure the appropriate area for connecting Umbraco
4+
UI builder for Umbraco.
35
---
46

5-
# Areas
7+
# Explore Areas in UI Builder
68

79
Umbraco UI Builder can be integrated into different areas of the Umbraco Backoffice. Before you start managing content, it is essential to decide which area best suits the presentation of your data. Each area offers unique features for displaying and interacting with content.
810

911
Once you have identified the most appropriate area, you can proceed with configuring it to suit your needs.
1012

11-
## Key Areas for Integration
13+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Sections</strong></td><td>Learn how to organize your content in a structured layout, enabling users to navigate different parts of the backoffice.</td><td><a href="sections.md">sections.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_Workflow_Section_Overview.png">Documentations Icons_Umbraco_Workflow_Section_Overview.png</a></td></tr><tr><td><strong>Dashboards</strong></td><td>Understand how to create custom views that provide quick access to key information and statistics.</td><td><a href="dashboards.md">dashboards.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Extending_Dashboards.png">Documentations Icons_Umbraco_CMS_Extending_Dashboards.png</a></td></tr><tr><td><strong>Context Apps</strong></td><td>Enhance the editing experience by adding context-aware apps to specific tree nodes.</td><td><a href="context-apps.md">context-apps.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Fundamentals.png">Documentations Icons_Umbraco_CMS_Fundamentals.png</a></td></tr></tbody></table>
1214

13-
- [Sections](sections.md): The Sections area allows you to organize your content in a structured layout, enabling users to navigate different parts of the backoffice.
14-
- [Dashboards](dashboards.md): The Dashboards area is ideal for creating custom views that provide quick access to key information and statistics.
15-
- [Context Apps](context-apps.md): Context Apps provide contextual tools and information based on the specific content a user is working with.
15+
## Also in this section
1616

17-
Selecting the correct area is essential to ensure your UI is both functional and user-friendly. Consider the nature of your content and the tasks users need to perform when deciding which area to use.
17+
{% content-ref url="trees.md" %}
18+
[trees.md](trees.md)
19+
{% endcontent-ref %}
+4-12
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,11 @@
11
---
2-
description: Learn how to configure cards in Umbraco UI Builder.
2+
description: Cards provide a visual summary of data, like counts or custom metrics.
33
---
44

5-
# Cards
5+
# Display Insights with Cards
66

77
Cards provide an API to display summary information in a card-based format, which is useful for displaying key metrics about a collection.
88

9-
![Cards](../images/cards.png)
9+
This section shows you how to use and create cards in your collections.
1010

11-
Cards can be defined in two ways:
12-
13-
{% content-ref url="count-cards.md" %}
14-
[Count Cards](count-cards.md)
15-
{% endcontent-ref %}
16-
17-
{% content-ref url="custom-cards.md" %}
18-
[Custom Cards](custom-cards.md)
19-
{% endcontent-ref %}
11+
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Count Cards</strong></td><td><p>Display simple number-based summaries of your collection data.</p><p></p></td><td><a href="count-cards.md">count-cards.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_Multilingual_Website.png">Documentations Icons_Umbraco_CMS_Tutorials_Multilingual_Website.png</a></td></tr><tr><td><strong>Custom Cards</strong></td><td>Create custom cards to visualize metrics, statuses, or trends relevant to your content.</td><td><a href="custom-cards.md">custom-cards.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Reference_Templating.png">Documentations Icons_Umbraco_CMS_Reference_Templating.png</a></td></tr></tbody></table>

15/umbraco-ui-builder/collections/overview.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
description: Configuring collection in Umbraco UI Builder to manage entity groups and define their UI integration.
2+
description: >-
3+
Configuring collection in Umbraco UI Builder to manage entity groups and
4+
define their UI integration.
35
---
46

5-
# Collections
7+
# Work with Collections in UI Builder
68

79
A collection in Umbraco UI Builder represents a group of entities for a specific data model. It serves as the primary configuration object for defining how the collection integrates into the UI.
810

9-
You can configure its list view appearance and editing options.
11+
This section guides you through the basics of creating collections, customizing list views and editors, and linking related data types together.
1012

11-
![A collection list view](../images/listview.png)
12-
13-
Get started by reviewing the basics of collection configuration.
13+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>The Basics</strong></td><td>Learn the fundamentals of collections and how they’re used to manage data in UI Builder.</td><td><a href="the-basics.md">the-basics.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_Basic_Website.png">Documentations Icons_Umbraco_CMS_Tutorials_Basic_Website.png</a></td></tr><tr><td><strong>List Views</strong></td><td>Customize how data is displayed in collections using flexible list view options.</td><td><a href="list-views.md">list-views.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_Custom_Views_Block_List.png">Documentations Icons_Umbraco_CMS_Tutorials_Custom_Views_Block_List.png</a></td></tr><tr><td><strong>Editors</strong></td><td>Configure how items in a collection are created, edited, and saved using custom editors.</td><td><a href="editors.md">editors.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_Sustainability_Best_Practices_Editors.png">Documentations Icons_Umbraco_Sustainability_Best_Practices_Editors.png</a></td></tr><tr><td><strong>Child Collections</strong></td><td>Nest collections inside others to manage complex data relationships.</td><td><a href="child-collections.md">child-collections.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_Multilingual_Website.png">Documentations Icons_Umbraco_CMS_Tutorials_Multilingual_Website.png</a></td></tr><tr><td><strong>Related Collections</strong></td><td>Create connections between different collections to allow for relational data management.</td><td><a href="related-collections.md">related-collections.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_MultiSite_Setup.png">Documentations Icons_Umbraco_CMS_Tutorials_MultiSite_Setup.png</a></td></tr><tr><td><strong>Entity Identifier Converters</strong></td><td>Use identifier converters to customize how related entities are referenced and stored.</td><td><a href="entity-identifier-converters.md">entity-identifier-converters.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_Deploy_Deployment_Workflow.png">Documentations Icons_Umbraco_Deploy_Deployment_Workflow.png</a></td></tr></tbody></table>
1414

1515
{% content-ref url="the-basics.md" %}
1616
[the-basics.md](the-basics.md)
+4-16
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
11
---
2-
description: Learn how to configure filtering in Umbraco UI Builder.
2+
description: Enhance your collections by adding powerful filtering options.
33
---
44

5-
# Filtering
5+
# Filter Your Data with Ease
66

7-
In addition to [Searching](../searching/overview.md), you may need to create specific views of a collection's data. Umbraco UI Builder provides multiple filtering mechanisms to help with this.
7+
This section explains how to configure global filters, create data views, and define filterable properties to streamline data management.
88

9-
![Filterable Properties](../images/filterable_properties.png)
10-
11-
Choose a filtering method from the list below to find out more.
12-
13-
{% content-ref url="global-filters.md" %}
14-
[global-filters.md](global-filters.md)
15-
{% endcontent-ref %}
16-
{% content-ref url="data-views.md" %}
17-
[data-views.md](data-views.md)
18-
{% endcontent-ref %}
19-
{% content-ref url="filterable-properties.md" %}
20-
[filterable-properties.md](filterable-properties.md)
21-
{% endcontent-ref %}
9+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Global Filters</strong></td><td><p>Apply filters across multiple collections or views to maintain a consistent filtering experience.</p><p></p></td><td><a href="global-filters.md">global-filters.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_Sustainability_Best_Practices_Infrastructure.png">Documentations Icons_Umbraco_Sustainability_Best_Practices_Infrastructure.png</a></td></tr><tr><td><strong>Data Views</strong></td><td><p>Create alternate views of your data using predefined filters and custom layouts.</p><p></p></td><td><a href="data-views.md">data-views.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Fundamentals_Data.png">Documentations Icons_Umbraco_CMS_Fundamentals_Data.png</a></td></tr><tr><td><strong>Filterable Properties</strong></td><td>Define which properties users can filter by within a collection to narrow down visible data.</td><td><a href="filterable-properties.md">filterable-properties.md</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_Forms_Creating_A_Form.png">Documentations Icons_Umbraco_Forms_Creating_A_Form.png</a></td></tr></tbody></table>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: >-
3+
Everything you need to set up, configure, and explore the basics of UI
4+
Builder.
5+
---
6+
7+
# First Steps with UI Builder
8+
9+
Begin your journey with UI Builder by learning the essential setup steps, requirements, and how the interface works.
10+
11+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Requirements</strong></td><td>Understand the prerequisites needed to use Umbraco UI Builder effectively, including supported versions and dependencies.</td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_Cloud_Setup.png">Documentations Icons_Umbraco_Cloud_Setup.png</a></td><td><a href="requirements.md">requirements.md</a></td></tr><tr><td><strong>Installing Umbraco UI Builder</strong></td><td>Step-by-step guide to installing UI Builder in your Umbraco project, from package setup to first launch.</td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Install.png">Documentations Icons_Umbraco_CMS_Install.png</a></td><td><a href="installation.md">installation.md</a></td></tr><tr><td><strong>Licensing</strong></td><td>Find out how licensing works, what’s included, and how to activate your license key.</td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_Google_Authentification.png">Documentations Icons_Umbraco_CMS_Tutorials_Google_Authentification.png</a></td><td><a href="licensing-model.md">licensing-model.md</a></td></tr><tr><td><strong>Configuration</strong></td><td>Learn how to configure UI Builder to suit your project needs.</td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Implementation_Data_Persistence.png">Documentations Icons_Umbraco_CMS_Implementation_Data_Persistence.png</a></td><td><a href="configuration.md">configuration.md</a></td></tr><tr><td><strong>User Interface</strong></td><td>Explore the UI Builder interface and get familiar with its layout, tools, and navigation elements.</td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Extending_Dashboards.png">Documentations Icons_Umbraco_CMS_Extending_Dashboards.png</a></td><td><a href="user-interface.md">user-interface.md</a></td></tr></tbody></table>
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
description: Available property editors in Umbraco UI Builder for managing data in Umbraco content nodes.
2+
description: Property Editors let you customize the editing experience in your collections.
33
---
44

5-
# Property Editors
5+
# Enhance Input with Property Editors
66

77
Umbraco UI Builder provides property editors for managing data inside Umbraco content nodes.
88

9-
The available property editors are:
9+
This section helps you implement advanced fields like pickers and converters.
1010

1111
{% content-ref url="entity-picker.md" %}
12-
[Entity Picker](entity-picker.md)
12+
[entity-picker.md](entity-picker.md)
1313
{% endcontent-ref %}

0 commit comments

Comments
 (0)