Skip to content

Commit b6af5b2

Browse files
committed
correct links and text
1 parent c357ec8 commit b6af5b2

File tree

2 files changed

+32
-24
lines changed

2 files changed

+32
-24
lines changed

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

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,38 @@
1-
# Extension Manifest
1+
---
2+
description:
3+
---
24

3-
{% hint style="warning" %}
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-
{% endhint %}
5+
# Extension Manifest
66

77
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.
88

99
The abilities of the extensions rely on the specific extension type. The Type sets the scene for what the extension can do and what it needs to be utilized. Some extension types rely on a reference to other extensions.
1010

11-
The pages of this article describe all the extension types that Backoffice supports. Here is a list of the most common types:
11+
The following overview lists all the available extension types:
1212

13-
{% content-ref url="../../../tutorials/creating-a-custom-dashboard/" %}
14-
[creating-a-custom-dashboard](../../../tutorials/creating-a-custom-dashboard/)
13+
{% content-ref url="../extension-types/" %}
14+
[extension-types](../extension-types/)
1515
{% endcontent-ref %}
1616

17-
{% content-ref url="../../property-editors/composition/" %}
18-
[composition](../../property-editors/composition/)
19-
{% endcontent-ref %}
2017

21-
{% content-ref url="../../section-trees/" %}
22-
[section-trees](../../section-trees/)
23-
{% endcontent-ref %}
18+
## Extension Manifest Format
19+
20+
A Extension Manifest can be written either as JavaScript Object or a JSON Object.
21+
22+
There is a few general properties, the required set of properties consists of the `type`, `alias` and `name`.
23+
24+
```typescript
25+
const manifest = {
26+
type: '...',
27+
alias: 'my.customization',
28+
name: 'My customization'
29+
...
30+
};
31+
```
32+
33+
The `type` defined what it is declaring
34+
The `alias` is a unique identifier for this manifest. It must be globally unique, so make sure to prefix with something that makes your extension unique.
35+
The `name` is a representational name of this manifest, this does not need to be unique but such can be beneficial when debugging extensions.
2436

2537
## Declare Extension Manifest
2638

@@ -47,7 +59,7 @@ The bundle extension type can be used for declaring multiple Extension Manifests
4759

4860
The bundle declares a single JavaScript file that will be loaded at startup. All the Extension Manifests exported from this Module will be registered in the Extension Registry.
4961

50-
Read more about the `bundle` extension type in the [Bundle](../../../extending/extending-overview/extension-registry/bundle.md) article.
62+
Read more about the `bundle` extension type in the [Bundle](../extension-types/bundle.md) article.
5163

5264
### Using `backofficeEntryPoint` as your foundation
5365

@@ -57,4 +69,4 @@ The entry point declares a single JavaScript file that will be loaded and run wh
5769

5870
The `entryPbackofficeEntryPointoint` extension is also the way to go if you want to load in external libraries such as jQuery, Angular, React, etc. You can use the `backofficeEntryPoint` to load in the external libraries to be shared by all your extensions. Loading **global CSS files** can also be used in the `backofficeEntryPoint` extension.
5971

60-
Read more about the `backofficeEntryPoint` extension type in the [Entry Point](../../../extending/extending-overview/extension-registry/entry-point.md) article.
72+
Read more about the `backofficeEntryPoint` extension type in the [Entry Point](../extension-types/entry-point.md) article.

15/umbraco-cms/customizing/package-manifest.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
description: An extension begins with a Package Manifest
2+
description: An extension begins with a Umbraco Package Manifest
33
---
44

5-
# Package Manifest
5+
# Umbraco Package Manifest
66

7-
A Package is declared via an Umbraco Package Manifest. This describes the Package and declares one or more UI Extensions. The Package Manifest is a JSON file that is stored in the `App_Plugins/{YourPackageName}` folder. The file is named `umbraco-package.json`.
7+
A Package is declared via an Umbraco Package Manifest. This describes the Package and declares one or more UI Extensions. The Manifest is a JSON file that is stored in the `App_Plugins/{YourPackageName}` folder. The file is named `umbraco-package.json`.
88

99
## Sample Manifest
1010

@@ -120,13 +120,9 @@ Umbraco supports the current specification of the property as outlined on MDN We
120120

121121
### Extensions
122122

123-
The `extensions` field is an array of UI Extension objects. Each object describes a single UI Extension.
123+
The `extensions` field is an array of Extension Manifest objects. Each object describes a single client extension.
124124

125-
There are three generic fields that are common to all UI Extensions:
126-
127-
* `type` - The type of the UI Extension.
128-
* `alias` - The alias of the UI Extension. This must be unique.
129-
* `name` - The name of the UI Extension.
125+
Read more about these in the [Extension Manifests article](./extending-overview/extension-registry/extension-manifest.md).
130126

131127
These are the current types of UI Extensions:
132128

0 commit comments

Comments
 (0)