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
Copy file name to clipboardExpand all lines: 14/umbraco-cms/customizing/extending-overview/extension-registry/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,15 @@ This page is a work in progress and may undergo further revisions, updates, or a
6
6
7
7
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.
The extension registry is a global registry that can be accessed and changed at anytime while Backoffice is running.
12
12
13
-
## [Extension Manifest](./extension-manifest.md)
13
+
## [Extension Manifest](extension-manifest.md)
14
14
15
15
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.
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.
Copy file name to clipboardExpand all lines: 14/umbraco-cms/customizing/extending-overview/extension-registry/extension-registry.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,18 @@
4
4
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.
5
5
{% endhint %}
6
6
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.
10
8
11
9
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.
12
10
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:
14
12
15
13
1. Via a manifest JSON file on the server.
16
14
2. In a JavaScript/TypeScript file.
17
15
18
16
These two options can be combined as you like.
19
17
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.
22
19
23
20
## Extension Manifest Data <ahref="#extension-manifest"id="extension-manifest"></a>
| authProvider | An authentication provider for [external login](../reference/security/external-login-providers.md). |
136
-
| appEntryPoint | An app entry point is a JavaScript module that is executed when any app is loaded (Login, Installer, Upgrader, and Backoffice). It will never be destroyed. Read more about [Entry Points](extending-overview/extension-types/entry-point.md).|
137
-
| backofficeEntryPoint | A backoffice entry point is a JavaScript module that is executed when the backoffice is loaded. It will be destroyed when the backoffice is closed or logged out. Read more about [Entry Points](extending-overview/extension-types/entry-point.md).|
136
+
| appEntryPoint | An app entry point is a JavaScript module that is executed when any app is loaded (Login, Installer, Upgrader, and Backoffice). It will never be destroyed. Read more about [Entry Points](extending-overview/extension-types/backoffice-entry-point.md). |
137
+
| backofficeEntryPoint | A backoffice entry point is a JavaScript module that is executed when the backoffice is loaded. It will be destroyed when the backoffice is closed or logged out. Read more about [Entry Points](extending-overview/extension-types/backoffice-entry-point.md). |
138
138
| blockEditorCustomView | A custom view for a block in the block editor. |
139
139
| bundle | A bundle is a collection of other manifests that can be loaded together. You would use this in lieu of a `backofficeEntryPoint` if all you needed was to load extensions through JavaScript. |
140
140
| condition | A condition that can be used to control the visibility of other UI Extensions. Read more about [Conditions](extending-overview/extension-types/condition.md). |
0 commit comments