Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Placeholder Structure for Extension Types #6695

Merged
merged 4 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions 15/umbraco-cms/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,13 +172,15 @@
* [Extension Registration](customizing/extending-overview/extension-registry/extension-registry.md)
* [Extension Manifest](customizing/extending-overview/extension-registry/extension-manifest.md)
* [Extension Types](customizing/extending-overview/extension-types/README.md)
* [Sections](customizing/extending-overview/extension-types/sections/README.md)
* [Workspaces](customizing/extending-overview/extension-types/workspaces/README.md)
* [Modals](customizing/extending-overview/extension-types/modals/README.md)
* [Confirm Dialog](customizing/extending-overview/extension-types/modals/confirm-dialog.md)
* [Custom Modals](customizing/extending-overview/extension-types/modals/custom-modals.md)
* [Route Registration](customizing/extending-overview/extension-types/modals/route-registration.md)
* [Menu](customizing/extending-overview/extension-types/menu.md)
* [Header Apps](customizing/extending-overview/extension-types/header-apps.md)
* [Icons](customizing/extending-overview/extension-types/icons.md)
* [Modals](customizing/extending-overview/extension-types/modals/README.md)
* [Confirm Dialog](customizing/extending-overview/extension-types/modals/confirm-dialog.md)
* [Custom Modals](customizing/extending-overview/extension-types/modals/custom-modals.md)
* [Route Registration](customizing/extending-overview/extension-types/modals/route-registration.md)
* [Bundle](customizing/extending-overview/extension-types/bundle.md)
* [Kind](customizing/extending-overview/extension-types/kind.md)
* [Backoffice Entry Point](customizing/extending-overview/extension-types/backoffice-entry-point.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,23 @@ The example above requires the nearest Workspaces Alias to be equal to `'Umb.Wor

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

## Built-in conditions types <a href="#core-conditions-types" id="core-conditions-types"></a>

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

* `Umb.Condition.SectionAlias` - Requires the current Section Alias to match the one specified.
* `Umb.Condition.MenuAlias` - Requires the current Menu Alias to match the one specified.
* `Umb.Condition.WorkspaceAlias` - Requires the current Workspace Alias to match the one specified.
* `Umb.Condition.WorkspaceEntityType` - Requires the current workspace to work on the given Entity Type. Examples: 'document', 'block' or 'user'.
* `Umb.Condition.WorkspaceContentTypeAlias` - Requires the current workspace to be based on a Content Type which Alias matches the one specified.
* `Umb.Condition.Workspace.ContentHasProperties` - Requires the Content Type of the current Workspace to have properties.
* `Umb.Condition.WorkspaceHasCollection` - Requires the current Workspace to have a Collection.
* `Umb.Condition.WorkspaceEntityIsNew` - Requires the current Workspace data to be new, not yet persisted on the server.
* `Umb.Condition.EntityIsTrashed` - Requires the current entity to be trashed.
* `Umb.Condition.EntityIsNotTrashed` - Requires the current entity to not be trashed.
* `Umb.Condition.SectionUserPermission` - Requires the current user to have permissions to the given Section Alias.
* `Umb.Condition.UserPermission.Document` - Requires the current user to have specific Document permissions. Example: 'Umb.Document.Save'

## Condition Configuration

The conditions are defined as an array of condition configurations. Each entry can contain the following properties:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: >-
An overview of the available extension types related to collections.
---

# Extension Types: Collections
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,6 @@ Extension Conditions declare requirements that should be permitted for the exten

[Read about utilizing conditions in Manifests](../extension-conditions.md#utilizing-conditions-in-your-manifest).

## Built-in conditions types <a href="#core-conditions-types" id="core-conditions-types"></a>

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

* `Umb.Condition.SectionAlias` - Requires the current Section Alias to match the one specified.
* `Umb.Condition.MenuAlias` - Requires the current Menu Alias to match the one specified.
* `Umb.Condition.WorkspaceAlias` - Requires the current Workspace Alias to match the one specified.
* `Umb.Condition.WorkspaceEntityType` - Requires the current workspace to work on the given Entity Type. Examples: 'document', 'block' or 'user'.
* `Umb.Condition.WorkspaceContentTypeAlias` - Requires the current workspace to be based on a Content Type which Alias matches the one specified.
* `Umb.Condition.Workspace.ContentHasProperties` - Requires the Content Type of the current Workspace to have properties.
* `Umb.Condition.WorkspaceHasCollection` - Requires the current Workspace to have a Collection.
* `Umb.Condition.WorkspaceEntityIsNew` - Requires the current Workspace data to be new, not yet persisted on the server.
* `Umb.Condition.EntityIsTrashed` - Requires the current entity to be trashed.
* `Umb.Condition.EntityIsNotTrashed` - Requires the current entity to not be trashed.
* `Umb.Condition.SectionUserPermission` - Requires the current user to have permissions to the given Section Alias.
* `Umb.Condition.UserPermission.Document` - Requires the current user to have specific Document permissions. Example: 'Umb.Document.Save'

## Make your own conditions

```html
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: >-
An overview of the availabe extension types related to sections.
---

# Extension Types: Sections
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: >-
An overview of the available extension types related to stores and repositories.
---

# Extension Types: Stores and repositories
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description: >-
An overview of the available extension types related to workspaces.
---

# Extension Types: Workspaces
Loading