Skip to content

Commit 7b134ba

Browse files
committed
Sync all changes in Customizing section
1 parent bb93310 commit 7b134ba

File tree

14 files changed

+68
-55
lines changed

14 files changed

+68
-55
lines changed

15/umbraco-cms/customizing/development-flow/vite-package-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ export default class MyElement extends LitElement {
171171
```
172172
{% endhint %}
173173

174-
Learn more about the abilities of the manifest file in the [Umbraco Package Manifest](../package-manifest.md) article.
174+
Learn more about the abilities of the manifest file in the [Umbraco Package Manifest](../../customize-the-backoffice/umbraco-package.md) article.
175175

176176
#### Testing your package
177177

15/umbraco-cms/customizing/extending-overview/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ description: Getting started with backoffice setup and configurations
44

55
# Extension Overview
66

7+
The Backoffice architecture is based on Extensions, making different UI parts extendable. Enabling you to append, replace, or remove parts.
8+
9+
You are not limited to any specific tech stack. UI Elements are based on Web Components and the Backoffice APIs are based on native code.
10+
11+
<figure><img src="../../.gitbook/assets/backoffice-overview-customizations.png" alt=""><figcaption></figcaption></figure>
12+
713
In this section you can find the common terms, concepts and guides used to extend the Umbraco backoffice.
814

915
{% hint style="warning" %}

15/umbraco-cms/customizing/extending-overview/extension-registry/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ This page is a work in progress and may undergo further revisions, updates, or a
66

77
Most of BackOffice is based on Extensions making it crucial to understand how to register your own extensions. This introduction will give you an outline of the abilities of the extension registry.
88

9-
## [Extension Registration](./extension-registry.md) <a href="#registration" id="registration"></a>
9+
## [Extension Registration](extension-registry.md) <a href="#registration" id="registration"></a>
1010

1111
The extension registry is a global registry that can be accessed and changed at anytime while Backoffice is running.
1212

13-
## [Extension Manifest](./extension-manifest.md)
13+
## [Extension Manifest](extension-manifest.md)
1414

1515
Each Extension Manifest has to declare its type, this is used to determine where it hooks into the system. It also looks at what data is required to declare within it.
1616

17-
## [Extension Types](../extension-types/README.md)
17+
## [Extension Types](../extension-types/)
1818

1919
### [Extension Conditions](../extension-types/condition.md) <a href="#conditions" id="conditions"></a>
2020

@@ -28,10 +28,10 @@ The kinds feature enables you to base your extension registration on a preset. A
2828
import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry';
2929
```
3030

31-
### [Entry Point](../extension-types/entry-point.md) <a href="#entry-point" id="entry-point"></a>
31+
### [Entry Point](../extension-types/backoffice-entry-point.md) <a href="#entry-point" id="entry-point"></a>
3232

3333
The Entry Point manifest type is used to register an entry point for the backoffice. An entry point is a single JavaScript file that is loaded when the backoffice is initialized. This file can be used to do anything, this enables more complex logic to take place on startup.
3434

35-
### [Bundle](../extension-types/bundle.md) <a href="#bundle-manifest" id="package-manifest"></a>
35+
### [Bundle](../extension-types/bundle.md) <a href="#package-manifest" id="package-manifest"></a>
3636

3737
The `bundle` extension type enables you to gather many extension manifests into one.

15/umbraco-cms/customizing/extending-overview/extension-registry/extension-registry.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,15 @@
44
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.
55
{% endhint %}
66

7-
The extension registry is the center piece of the Backoffice UI.
8-
It holds information about most of the Backoffice UI, as most are extensions. This includes the built-in UI.
9-
The registry can be manipulated at any time, meaning you can add or remove extensions at runtime.
7+
The extension registry is the center piece of the Backoffice UI. It holds information about most of the Backoffice UI, as most are extensions. This includes the built-in UI. The registry can be manipulated at any time, meaning you can add or remove extensions at runtime.
108

119
To provide new UI to the backoffice, you must register them via an extension manifest. This has to be initiated via an Umbraco Package JSON file on the server. This will be your starting point, which enables you to register one or more extensions.
1210

13-
Declaring a new extension is done by declaring an [extension manifest](./extension-manifest.md). This can be done in one of two ways:
11+
Declaring a new extension is done by declaring an [extension manifest](extension-manifest.md). This can be done in one of two ways:
1412

1513
1. Via a manifest JSON file on the server.
1614
2. In a JavaScript/TypeScript file.
1715

1816
These two options can be combined as you like.
1917

20-
A typical use case of such is achieved by registering a single extension manifest in your Umbraco Package JSON file. This manifest would then load a JS file, that registers the rest of your extensions.
21-
Learn more about these abilities in the [bundle](../extension-types/bundle.md) or [backoffice entry point](../extension-types/entry-point.md) articles.
18+
A typical use case of such is achieved by registering a single extension manifest in your Umbraco Package JSON file. This manifest would then load a JS file, that registers the rest of your extensions. Learn more about these abilities in the [bundle](../extension-types/bundle.md) or [backoffice entry point](../extension-types/backoffice-entry-point.md) articles.

15/umbraco-cms/customizing/extending-overview/extension-types/backoffice-entry-point.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Backoffice Entry Point
1+
# Entry Point
22

33
{% hint style="warning" %}
44
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.
@@ -15,14 +15,14 @@ The Entry Point manifest type is used to register an entry point for the backoff
1515

1616
```json
1717
{
18-
"name": "Name of your package",
19-
"extensions: [
20-
{
21-
"type": "backofficeEntryPoint",
22-
"alias": "My.EntryPoint",
23-
"js": "/App_Plugins/YourFolder/index.js"
24-
}
25-
]
18+
"name": "Name of your package",
19+
"extensions: [
20+
{
21+
"type": "backofficeEntryPoint",
22+
"alias": "My.EntryPoint",
23+
"js": "/App_Plugins/YourFolder/index.js"
24+
}
25+
]
2626
}
2727
```
2828

15/umbraco-cms/customizing/foundation/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,32 @@ description: Getting started with backoffice setup and configurations
44

55
# Foundation
66

7-
In this section you can find the common terms, concepts and guides used to extend the Umbraco backoffice.
7+
In this section, you can find the common terms, concepts, and guides used to extend the Umbraco backoffice.
88

99
{% hint style="warning" %}
1010
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.
1111
{% endhint %}
1212

13-
## [Working with Data](./working-with-data/README.md)
13+
## [Working with Bellissima](https://github.com/umbraco/Umbraco.Packages/tree/main/bellissima)
14+
15+
An overview of community articles related to the New backoffice "Bellissima".
16+
17+
## [Working with Data](working-with-data/)
1418

1519
An overview of concepts on how to work with data when extending the backoffice.
1620

17-
## [Contexts](./contexts/README.md)
21+
## [Contexts](contexts/)
1822

1923
An overview of concepts on how to work with contexts when extending the backoffice.
2024

21-
## [Umbraco Element](./umbraco-element/README.md)
25+
## [Umbraco Element](umbraco-element/)
2226

2327
An overview of concepts on how to work with Umbraco element when extending the backoffice.
2428

25-
## [Sorting](./sorting.md)
29+
## [Sorting](sorting.md)
2630

2731
An overview of concepts on how to work with sorting when extending the backoffice.
2832

29-
## [Routes](./routes.md)
33+
## [Routes](routes.md)
3034

3135
An overview of concepts on how to work with routes when extending the backoffice.

15/umbraco-cms/customizing/foundation/contexts/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ This page is a work in progress and may undergo further revisions, updates, or a
1010

1111
Below you can find some articles on how you can work with different contexts:
1212

13-
## [Global Context](global-context.md)
14-
15-
A global context manages the logic code from your Lit Element controllers.
16-
17-
## [Property Dataset Context](variant-context.md)
13+
## [Property Dataset Context](../../../customize-the-backoffice/foundation/contexts/property-dataset-context.md)
1814

1915
A Dataset Context is the connection point between a Property Editor and a Workspace and covers a set of properties.

15/umbraco-cms/customizing/foundation/routes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ This page is a work in progress and may undergo further revisions, updates, or a
1212

1313
The routing in the backoffice is flexible and customizable. In this article, you can find a couple of starting points for routing.
1414

15-
The overall **divider** is the [Section](../section-trees/sections/) which is a `ManifestSection` extension type. It is also used internally by the following sections: Content, Media, Settings, Members, and so on.
15+
The overall **divider** is the [Section](../../customize-the-backoffice/extending-overview/extension-types/section.md) which is a `ManifestSection` extension type. It is also used internally by the following sections: Content, Media, Settings, Members, and so on.
1616

1717
Depending on which section you are working on, there are different options:
1818

19-
* **SectionView**: The [Section View](../section-trees/sections/section-view.md) is a view in a section and one of the automatic router extension types. It can be an entry point to a section. If a section has multiple views defined (or both dashboards and views) then the tabs and icons will be rendered. As some examples, you can check the **Packages** and **Member** sections.
20-
* **Dashboard**: The [Dashboard](../dashboards.md) is an entry point to a section. If there is more than one section view or dashboard then the defined tabs and icons will be rendered to make it possible to navigate.
21-
* **Workspace**: The [Workspace](../workspaces/) concept has built-in features to facilitate editing of an entity of a certain entity type. It is used by many entities in the backoffice like content, media, content types, data types, dictionaries and so on.
19+
* **SectionView**: The [Section View](../../customize-the-backoffice/extending-overview/extension-types/section-view.md) is a view in a section and one of the automatic router extension types. It can be an entry point to a section. If a section has multiple views defined (or both dashboards and views) then the tabs and icons will be rendered. As some examples, you can check the **Packages** and **Member** sections.
20+
* **Dashboard**: The [Dashboard](../../customize-the-backoffice/extending-overview/extension-types/dashboard.md) is an entry point to a section. If there is more than one section view or dashboard then the defined tabs and icons will be rendered to make it possible to navigate.
21+
* **Workspace**: The [Workspace](../../customize-the-backoffice/workspaces.md) concept has built-in features to facilitate editing of an entity of a certain entity type. It is used by many entities in the backoffice like content, media, content types, data types, dictionaries and so on.
2222
* **Custom element**: A [Custom Element](umbraco-element/) is a section that can be configured to use any web component as the **entry point**. The `element()` can be configured in the manifest. By doing this we'll disable the possibility of using dashboards and section views for the section since they will not be automatically routed/rendered. This option should be used only when necessary.
2323

2424
### Building routing

15/umbraco-cms/customizing/foundation/working-with-data/context-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ The consumption of the Additional API will never happen as the token uses the sa
129129
This is only relevant if you are going to make multiple context API for the same context. Discriminator only gives value for consumption of Context APIs that have a varying interface. The backoffice uses this for the different types of Workspace Contexts.
130130
{% endhint %}
131131

132-
In some cases, it is needed to have different APIs for the same context. For example, the [Workspace Contexts](../../workspaces/workspace-context.md).
132+
In some cases, it is needed to have different APIs for the same context. For example, the [Workspace Contexts](../../../customize-the-backoffice/extending-overview/extension-types/workspace-context.md).
133133

134134
If someone wants the workspace name, they might not care about the specific API of the Workspace Context. These implementations can use a standard Context Token with a type of generic Workspace Context.
135135

15/umbraco-cms/customizing/project-bellissima.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,10 @@ description: >-
66

77
# Project Bellissima
88

9-
"Bellissima", the code name for the frontend code of the backoffice, is a re-creation of the backoffice of Umbraco. While replacing the deprecated angular code with [Vite](https://vitejs.dev/), [Lit](https://lit.dev/), and [TypeScript](https://www.typescriptlang.org/), you can customize and extend everything in the backoffice.
9+
"Bellissima", the code name for the frontend code of the backoffice, is a re-creation of the backoffice of Umbraco. While replacing the deprecated angular code with [Lit](https://lit.dev/) and [TypeScript](https://www.typescriptlang.org/), you can customize and extend everything in the backoffice.
1010

1111
<figure><img src="../.gitbook/assets/backoffice-overview-customizations.png" alt=""><figcaption><p>An overview of all the customizable sections and elements in the Umbraco CMS backoffice.</p></figcaption></figure>
1212

1313
Each block is an extension point that can be extended, customized, replaced, or removed.
1414

1515
You are not limited to the mentioned frameworks. You can use any other framework or library of your choice.
16-
17-
## Resources
18-
19-
{% hint style="info" %}
20-
You can find a list of other resources related to the new backoffice of Umbraco in the [Umbraco v14 "Bellissima" Resources](https://github.com/umbraco/Umbraco.Packages/tree/main/bellissima) article.
21-
{% endhint %}
22-
23-
<table data-view="cards"><thead><tr><th></th><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></td><td><a href="development-flow/"><strong>Setup Your Development Environment</strong></a></td><td>Discover how to get started with the new backoffice.</td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Fundamentals_Setup (1).png">Documentations Icons_Umbraco_CMS_Fundamentals_Setup (1).png</a></td><td><a href="development-flow/">development-flow</a></td></tr><tr><td></td><td><a href="ui-documentation.md"><strong>UI Documentation</strong></a></td><td>Discover how to extend the backoffice using the Umbraco UI Library, UI API and Storybook.</td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Fundamentals_Design.png">Documentations Icons_Umbraco_CMS_Fundamentals_Design.png</a></td><td><a href="ui-documentation.md">ui-documentation.md</a></td></tr><tr><td></td><td><a href="../tutorials/overview.md"><strong>Tutorials</strong></a></td><td><a href="../tutorials/creating-your-first-extension.md">Creating your first extension</a><br><br><a href="../tutorials/creating-a-custom-dashboard/">Creating a custom dashboard</a><br><br><a href="../tutorials/creating-a-property-editor/">Creating a property editor</a></td><td><a href="../.gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_the_Starter_Kit (1).png">Documentations Icons_Umbraco_CMS_Tutorials_the_Starter_Kit (1).png</a></td><td></td></tr></tbody></table>

0 commit comments

Comments
 (0)