Skip to content

Commit 8d0e466

Browse files
authored
Merge pull request #7079 from umbraco/extension-conditions
Moved Built-in Conditions Types info and added reference link
2 parents f0eca97 + e0a4fa7 commit 8d0e466

File tree

6 files changed

+66
-54
lines changed

6 files changed

+66
-54
lines changed

14/umbraco-cms/customizing/extending-overview/extension-conditions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ The example above requires the nearest Workspaces Alias to be equal to `'Umb.Wor
3333

3434
When declaring multiple conditions all of them must be permitted for the extension to be available.
3535

36+
## Built-in Conditions Types
37+
38+
For a list of available options, see the [Built-in Conditions Types](extension-types/condition.md#built-in-conditions-types) section.
39+
3640
## Condition Configuration
3741

3842
The conditions are defined as an array of condition configurations. Each entry can contain the following properties:

14/umbraco-cms/customizing/extending-overview/extension-types/condition.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ description: >-
66

77
# Extension Conditions
88

9-
Extension Conditions declare requirements that should be permitted for the extension to be available. Many, but not all, Extension Types support Conditions.
9+
Extension Conditions let you define specific requirements that must be met for an extension to be available. While not all Extension Types support Conditions, many do.
1010

11-
[Read about utilizing conditions in Manifests](../extension-conditions.md#utilizing-conditions-in-your-manifest).
11+
For information on how to utilize conditions in your Manifest, see the [Utilizing Conditions in your Manifest](../extension-conditions.md#utilizing-conditions-in-your-manifest) section.
1212

13-
## Built-in conditions types <a href="#core-conditions-types" id="core-conditions-types"></a>
13+
## Built-in Conditions Types
1414

1515
The following conditions are available out of the box, for all extension types that support Conditions.
1616

@@ -27,7 +27,7 @@ The following conditions are available out of the box, for all extension types t
2727
* `Umb.Condition.SectionUserPermission` - Requires the current user to have permissions to the given Section Alias.
2828
* `Umb.Condition.UserPermission.Document` - Requires the current user to have specific Document permissions. Example: 'Umb.Document.Save'
2929

30-
## Make your own conditions
30+
## Make your own Conditions
3131

3232
```html
3333
<a href="#make-your-own-conditions" id="make-your-own-conditions"></a>

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

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -33,26 +33,9 @@ The example above requires the nearest Workspaces Alias to be equal to `'Umb.Wor
3333

3434
When declaring multiple conditions all of them must be permitted for the extension to be available.
3535

36-
## Built-in conditions types <a href="#core-conditions-types" id="core-conditions-types"></a>
37-
38-
The following conditions are available out of the box, for all extension types that support Conditions.
39-
40-
* `Umb.Condition.Switch` - Toggles on and off based on the `frequency` set in seconds.
41-
* `Umb.Condition.MultipleAppLanguages` - Requires the app to have more than one language, such as a multi-language site.
42-
* `Umb.Condition.SectionAlias` - Requires the current Section Alias to match the one specified.
43-
* `Umb.Condition.MenuAlias` - Requires the current Menu Alias to match the one specified.
44-
* `Umb.Condition.WorkspaceAlias` - Requires the current Workspace Alias to match the one specified.
45-
* `Umb.Condition.WorkspaceEntityType` - Requires the current workspace to work on the given Entity Type. Examples: 'document', 'block' or 'user'.
46-
* `Umb.Condition.WorkspaceContentTypeAlias` - Requires the current workspace to be based on a Content Type which Alias matches the one specified.
47-
* `Umb.Condition.Workspace.ContentHasProperties` - Requires the Content Type of the current Workspace to have properties.
48-
* `Umb.Condition.WorkspaceHasCollection` - Requires the current Workspace to have a Collection.
49-
* `Umb.Condition.WorkspaceEntityIsNew` - Requires the current Workspace data to be new, not yet persisted on the server.
50-
* `Umb.Condition.EntityIsTrashed` - Requires the current entity to be trashed.
51-
* `Umb.Condition.EntityIsNotTrashed` - Requires the current entity to not be trashed.
52-
* `Umb.Condition.SectionUserPermission` - Requires the current user to have permissions to the given Section Alias.
53-
* `Umb.Condition.UserPermission.Document` - Requires the current user to have specific Document permissions. Example: 'Umb.Document.Save'.
54-
* `Umb.Condition.CurrentUser.GroupId` - Requires the current user to belong to a specific group by GUID. Accepts `match` (GUID), `oneOf` (array), `allOf` (array), and `noneOf` (array). Example: '8d2b3c4d-4f1f-4b1f-8e3d-4a6b7b8c4f1e'.
55-
* `Umb.Condition.CurrentUser.IsAdmin` - Requires the current user to be an admin as defined by the backend, for example, that they belong to the Administrator group.
36+
## Built-in Conditions Types
37+
38+
For a list of available options, see the [Built-in Conditions Types](extension-types/condition.md#built-in-conditions-types) section.
5639

5740
## Condition Configuration
5841

15/umbraco-cms/customizing/extending-overview/extension-types/condition.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,32 @@ description: >-
66

77
# Extension Conditions
88

9-
Extension Conditions declare requirements that should be permitted for the extension to be available. Many, but not all, Extension Types support Conditions.
10-
11-
[Read about utilizing conditions in Manifests](../extension-conditions.md#utilizing-conditions-in-your-manifest).
12-
13-
## Make your own conditions
9+
Extension Conditions let you define specific requirements that must be met for an extension to be available. While not all Extension Types support Conditions, many do.
10+
11+
For information on how to utilize conditions in your Manifest, see the [Utilizing Conditions in your Manifest](../extension-conditions.md#utilizing-conditions-in-your-manifest) section.
12+
13+
## Built-in Conditions Types
14+
15+
The following conditions are available out of the box, for all extension types that support Conditions.
16+
17+
* `Umb.Condition.Switch` - Toggles on and off based on the `frequency` set in seconds.
18+
* `Umb.Condition.MultipleAppLanguages` - Requires the app to have more than one language, such as a multi-language site.
19+
* `Umb.Condition.SectionAlias` - Requires the current Section Alias to match the one specified.
20+
* `Umb.Condition.MenuAlias` - Requires the current Menu Alias to match the one specified.
21+
* `Umb.Condition.WorkspaceAlias` - Requires the current Workspace Alias to match the one specified.
22+
* `Umb.Condition.WorkspaceEntityType` - Requires the current workspace to work on the given Entity Type. Examples: 'document', 'block' or 'user'.
23+
* `Umb.Condition.WorkspaceContentTypeAlias` - Requires the current workspace to be based on a Content Type which Alias matches the one specified.
24+
* `Umb.Condition.Workspace.ContentHasProperties` - Requires the Content Type of the current Workspace to have properties.
25+
* `Umb.Condition.WorkspaceHasCollection` - Requires the current Workspace to have a Collection.
26+
* `Umb.Condition.WorkspaceEntityIsNew` - Requires the current Workspace data to be new, not yet persisted on the server.
27+
* `Umb.Condition.EntityIsTrashed` - Requires the current entity to be trashed.
28+
* `Umb.Condition.EntityIsNotTrashed` - Requires the current entity to not be trashed.
29+
* `Umb.Condition.SectionUserPermission` - Requires the current user to have permissions to the given Section Alias.
30+
* `Umb.Condition.UserPermission.Document` - Requires the current user to have specific Document permissions. Example: 'Umb.Document.Save'.
31+
* `Umb.Condition.CurrentUser.GroupId` - Requires the current user to belong to a specific group by GUID. Accepts `match` (GUID), `oneOf` (array), `allOf` (array), and `noneOf` (array). Example: '8d2b3c4d-4f1f-4b1f-8e3d-4a6b7b8c4f1e'.
32+
* `Umb.Condition.CurrentUser.IsAdmin` - Requires the current user to be an admin as defined by the backend, for example, that they belong to the Administrator group.
33+
34+
## Make your own Conditions
1435

1536
```html
1637
<a href="#make-your-own-conditions" id="make-your-own-conditions"></a>

16/umbraco-cms/customizing/extending-overview/extension-conditions.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -33,26 +33,9 @@ The example above requires the nearest Workspaces Alias to be equal to `'Umb.Wor
3333

3434
When declaring multiple conditions all of them must be permitted for the extension to be available.
3535

36-
## Built-in conditions types <a href="#core-conditions-types" id="core-conditions-types"></a>
37-
38-
The following conditions are available out of the box, for all extension types that support Conditions.
39-
40-
* `Umb.Condition.Switch` - Toggles on and off based on the `frequency` set in seconds.
41-
* `Umb.Condition.MultipleAppLanguages` - Requires the app to have more than one language, such as a multi-language site.
42-
* `Umb.Condition.SectionAlias` - Requires the current Section Alias to match the one specified.
43-
* `Umb.Condition.MenuAlias` - Requires the current Menu Alias to match the one specified.
44-
* `Umb.Condition.WorkspaceAlias` - Requires the current Workspace Alias to match the one specified.
45-
* `Umb.Condition.WorkspaceEntityType` - Requires the current workspace to work on the given Entity Type. Examples: 'document', 'block' or 'user'.
46-
* `Umb.Condition.WorkspaceContentTypeAlias` - Requires the current workspace to be based on a Content Type which Alias matches the one specified.
47-
* `Umb.Condition.Workspace.ContentHasProperties` - Requires the Content Type of the current Workspace to have properties.
48-
* `Umb.Condition.WorkspaceHasCollection` - Requires the current Workspace to have a Collection.
49-
* `Umb.Condition.WorkspaceEntityIsNew` - Requires the current Workspace data to be new, not yet persisted on the server.
50-
* `Umb.Condition.EntityIsTrashed` - Requires the current entity to be trashed.
51-
* `Umb.Condition.EntityIsNotTrashed` - Requires the current entity to not be trashed.
52-
* `Umb.Condition.SectionUserPermission` - Requires the current user to have permissions to the given Section Alias.
53-
* `Umb.Condition.UserPermission.Document` - Requires the current user to have specific Document permissions. Example: 'Umb.Document.Save'.
54-
* `Umb.Condition.CurrentUser.GroupId` - Requires the current user to belong to a specific group by GUID. Accepts `match` (GUID), `oneOf` (array), `allOf` (array), and `noneOf` (array). Example: '8d2b3c4d-4f1f-4b1f-8e3d-4a6b7b8c4f1e'.
55-
* `Umb.Condition.CurrentUser.IsAdmin` - Requires the current user to be an admin as defined by the backend, for example, that they belong to the Administrator group.
36+
## Built-in Conditions Types
37+
38+
For a list of available options, see the [Built-in Conditions Types](extension-types/condition.md#built-in-conditions-types) section.
5639

5740
## Condition Configuration
5841

16/umbraco-cms/customizing/extending-overview/extension-types/condition.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,32 @@ description: >-
66

77
# Extension Conditions
88

9-
Extension Conditions declare requirements that should be permitted for the extension to be available. Many, but not all, Extension Types support Conditions.
10-
11-
[Read about utilizing conditions in Manifests](../extension-conditions.md#utilizing-conditions-in-your-manifest).
12-
13-
## Make your own conditions
9+
Extension Conditions let you define specific requirements that must be met for an extension to be available. While not all Extension Types support Conditions, many do.
10+
11+
For information on how to utilize conditions in your Manifest, see the [Utilizing Conditions in your Manifest](../extension-conditions.md#utilizing-conditions-in-your-manifest) section.
12+
13+
## Built-in Conditions Types
14+
15+
The following conditions are available out of the box, for all extension types that support Conditions.
16+
17+
* `Umb.Condition.Switch` - Toggles on and off based on the `frequency` set in seconds.
18+
* `Umb.Condition.MultipleAppLanguages` - Requires the app to have more than one language, such as a multi-language site.
19+
* `Umb.Condition.SectionAlias` - Requires the current Section Alias to match the one specified.
20+
* `Umb.Condition.MenuAlias` - Requires the current Menu Alias to match the one specified.
21+
* `Umb.Condition.WorkspaceAlias` - Requires the current Workspace Alias to match the one specified.
22+
* `Umb.Condition.WorkspaceEntityType` - Requires the current workspace to work on the given Entity Type. Examples: 'document', 'block' or 'user'.
23+
* `Umb.Condition.WorkspaceContentTypeAlias` - Requires the current workspace to be based on a Content Type which Alias matches the one specified.
24+
* `Umb.Condition.Workspace.ContentHasProperties` - Requires the Content Type of the current Workspace to have properties.
25+
* `Umb.Condition.WorkspaceHasCollection` - Requires the current Workspace to have a Collection.
26+
* `Umb.Condition.WorkspaceEntityIsNew` - Requires the current Workspace data to be new, not yet persisted on the server.
27+
* `Umb.Condition.EntityIsTrashed` - Requires the current entity to be trashed.
28+
* `Umb.Condition.EntityIsNotTrashed` - Requires the current entity to not be trashed.
29+
* `Umb.Condition.SectionUserPermission` - Requires the current user to have permissions to the given Section Alias.
30+
* `Umb.Condition.UserPermission.Document` - Requires the current user to have specific Document permissions. Example: 'Umb.Document.Save'.
31+
* `Umb.Condition.CurrentUser.GroupId` - Requires the current user to belong to a specific group by GUID. Accepts `match` (GUID), `oneOf` (array), `allOf` (array), and `noneOf` (array). Example: '8d2b3c4d-4f1f-4b1f-8e3d-4a6b7b8c4f1e'.
32+
* `Umb.Condition.CurrentUser.IsAdmin` - Requires the current user to be an admin as defined by the backend, for example, that they belong to the Administrator group.
33+
34+
## Make your own Conditions
1435

1536
```html
1637
<a href="#make-your-own-conditions" id="make-your-own-conditions"></a>

0 commit comments

Comments
 (0)