Entity Actions, v16 & v17 #7681

bszyman · 2025-12-01T08:39:36Z

📋 Description

Update Entity Actions article to support Umbraco v16, v17. Refreshed and verified code samples. Formatting improvements. Additional clarity around entity action permissions.

📎 Related Issues (if applicable)

#7318

✅ Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

Code blocks are correctly formatted.
Sentences are short and clear (preferably under 25 words).
Passive voice and first-person language (“we”, “I”) are avoided.
Relevant pages are linked.
All links work and point to the correct resources.
Screenshots or diagrams are included if useful.
Any code examples or instructions have been tested.
Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

v16, v17

Deadline (if relevant)

N/A

📚 Helpful Resources

🧾 Umbraco Contribution Guidelines
✍️ Umbraco Documentation Style Guide

…and verified code samples. Formatting improvements. Additional clarity around entity action permissions.

Removed reference to "xgrid" (unsure what that meant here)

I thought it best to flesh out the example

since the current backoffice is now v17. Removed "Umb.DocumentRecycleBin.Restore" entry, as doesn't exist.

for consistency throughout the article.

as the flow felt confusing to display the default UI after mentioning it can be replaced.

Remove the `config` part as it does not exist in the codebase.

leekelleher

Reviewed the technical contents. I have made changes to the code snippets, (for consistency and TypeScript support).

@sofietoft I have left a comment about the extra anchor tags.

From a technical perspective, I am happy with these changes.

Thank you @bszyman for the herculean effort you've put into this! 💪 #h5yr

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

leekelleher · 2025-12-08T10:00:50Z

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

 | I                         | Umb.Document.CultureAndHostnames |
 | P                         | Umb.Document.PublicAccess        |
 | K                         | Umb.Document.Rollback            |
 | V                         | Umb.DocumentRecycleBin.Restore   |


I've removed the Umb.DocumentRecycleBin.Restore entry, as it does not exist. The user permission for recycle-bin restore is actually checked against Umb.Document.Move.

leekelleher · 2025-12-08T10:03:21Z

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


-| Current Backoffice Letter | Verb                             |
-| ------------------------- | -------------------------------- |
+| Current Backoffice letter | Verb                             |


I've renamed to "Legacy" (since the "current" backoffice is now v17).

Although I'm unsure if we need this section going forwards. It may be useful for package developers who need to migrate user-permissions from v13 to v17, but for newcomers it is not relevant.

leekelleher · 2025-12-08T10:20:38Z

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

+
+In the following example, the `conditions:alias` property of an `entityAction` extension matches the `alias` property of the `entityUserPermission` extension definition.
+
+Similarly, the `conditions:config:allOf` array must contain the one of the values from the `meta:verbs` array of the `entityUserPermission` extension definition.


The config part is incorrect, I have updated the code example.

sofietoft

Thanks for the PR @bszyman !

I've reviewed the article, adding a few suggestions here and there.
Let me know if something doesn't make sense.

Also, calling them "fly-out" menus - is that something you have discussed in the community docs team? To my knowledge, we haven't called the menus this before, and I just want to make sure we keep it consistent throughout the repository.

sofietoft · 2025-12-10T09:18:40Z

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

 {% endhint %}

-Entity Actions is a feature that provides a generic place for secondary or additional functionality for an entity type. An entity type can be a media, document and so on.
+Entity Actions is an extension type that provides a fly-out context menu for secondary or additional functionality to an entity (document, media, etc...).


Suggested change

Entity Actions is an extension type that provides a fly-out context menu for secondary or additional functionality to an entity (document, media, etc...).

Entity Actions is an extension type that provides a fly-out context menu for secondary or additional functionality to an entity (document, media, or the like).

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

sofietoft · 2025-12-10T09:24:44Z

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

-```typescript
-interface UmbEntityActionElement {}
-```
+Umbraco provides a few generic actions that can be used across silos, such as copy, move, trash, etc. Umbraco may include additional generic actions in the future.


Suggested change

Umbraco provides a few generic actions that can be used across silos, such as copy, move, trash, etc. Umbraco may include additional generic actions in the future.

Umbraco provides a few generic actions that can be used across silos, such as copy, move, and trash. Umbraco may include additional generic actions in the future.

sofietoft · 2025-12-10T09:25:34Z

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

+The entity action class will provide one of the following methods:
+* `getHref` - returns a URL that will be used for navigation
+* `execute` - programs custom imperative behaviors that can work with contexts and service APIs


Suggested change

The entity action class will provide one of the following methods:

* `getHref` - returns a URL that will be used for navigation

* `execute` - programs custom imperative behaviors that can work with contexts and service APIs

The Entity Action class will provide one of the following methods:

* `getHref` - returns a URL that will be used for navigation.

* `execute` - programs custom imperative behaviors that can work with contexts and service APIs.

sofietoft · 2025-12-10T09:27:48Z

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

+### The `getHref()` Method <a href="#get-href-method" id="get-href-method"></a>

-Example of providing a `getHref` method:
+Entity action extensions are provided `this.args` by the `UmbEntityActionBase` superclass. The `this.args` contains a property, `unique` that allows developers to identity which element the user selected.


I'm not entirely sure I understand the first sentence here. Is this.args provided by UmbEntityActionBase? If that's the case, it needs to be a little clearer.

Suggested change

Entity action extensions are provided `this.args` by the `UmbEntityActionBase` superclass. The `this.args` contains a property, `unique` that allows developers to identity which element the user selected.

Entity action extensions are provided `this.args` by the `UmbEntityActionBase` superclass. The `this.args` contains a `unique` property that allows developers to identify which element the user selected.

sofietoft · 2025-12-10T10:19:01Z

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

+| Custom Backoffice letter | Verb                           |
+|--------------------------|--------------------------------|
+| ⌘                        | *Placeholder*                  |
+


Should this table also contain a column for the package name, and perhaps GitHub account name, of the one submitting the letters? 🤔

sofietoft · 2025-12-10T10:20:20Z

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

+
+### Entity User Permissions
+
+Entity user permissions are assigned to a document, media, member, etc., and are registered using the `entityUserPermission` type in the extension's manifest.


Suggested change

Entity user permissions are assigned to a document, media, member, etc., and are registered using the `entityUserPermission` type in the extension's manifest.

Entity user permissions are assigned to entities like documents, media, and members. They are registered using the `entityUserPermission` type in the extension's manifest.

bszyman changed the title ~~Entity Actions, v16~~ Entity Actions, v16 & v17 Dec 1, 2025

bszyman marked this pull request as ready for review December 1, 2025 08:41

bszyman force-pushed the entity-actions branch from 2233d8f to 623bd06 Compare December 1, 2025 08:44

Update Entity Actions article to support Umbraco v16, v17. Refreshed …

0bb891b

…and verified code samples. Formatting improvements. Additional clarity around entity action permissions.

bszyman force-pushed the entity-actions branch from 623bd06 to 0bb891b Compare December 1, 2025 08:57

bszyman mentioned this pull request Dec 1, 2025

Customizing > Extending Overview > Extension Types > Entity Actions #7318

Open

sofietoft added the community/docs-team label Dec 1, 2025

leekelleher self-requested a review December 4, 2025 12:05

leekelleher added 8 commits December 8, 2025 10:22

Update code snippets with Typescript support and lazy loading

748d07d

Acronym casing and formatting

c519e6f

Refactored fetch code example

aa29e5e

Removed reference to "xgrid" (unsure what that meant here)

Refactored custom modal code example

9052595

I thought it best to flesh out the example

Renamed "Current" to "Legacy"

e99196c

since the current backoffice is now v17. Removed "Umb.DocumentRecycleBin.Restore" entry, as doesn't exist.

Refactored "manifest.json" to use Typescript code example

1709252

for consistency throughout the article.

Rearranged the "Granular User Permission" contents

aa668f9

as the flow felt confusing to display the default UI after mentioning it can be replaced.

Refactored the conditions code example (to use Typescript)

5248292

Remove the `config` part as it does not exist in the codebase.

leekelleher approved these changes Dec 8, 2025

View reviewed changes

sofietoft reviewed Dec 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Entity Actions, v16 & v17 #7681

Entity Actions, v16 & v17 #7681

bszyman commented Dec 1, 2025 •

edited

Loading

Uh oh!

leekelleher left a comment

Uh oh!

Uh oh!

leekelleher Dec 8, 2025

Uh oh!

leekelleher Dec 8, 2025

Uh oh!

leekelleher Dec 8, 2025

Uh oh!

sofietoft left a comment

Uh oh!

sofietoft Dec 10, 2025

Uh oh!

Uh oh!

sofietoft Dec 10, 2025

Uh oh!

sofietoft Dec 10, 2025

Uh oh!

sofietoft Dec 10, 2025

Uh oh!

sofietoft Dec 10, 2025

Uh oh!

sofietoft Dec 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		In the following example, the `conditions:alias` property of an `entityAction` extension matches the `alias` property of the `entityUserPermission` extension definition.

		Similarly, the `conditions:config:allOf` array must contain the one of the values from the `meta:verbs` array of the `entityUserPermission` extension definition.

	Entity Actions is an extension type that provides a fly-out context menu for secondary or additional functionality to an entity (document, media, etc...).
	Entity Actions is an extension type that provides a fly-out context menu for secondary or additional functionality to an entity (document, media, or the like).

	Umbraco provides a few generic actions that can be used across silos, such as copy, move, trash, etc. Umbraco may include additional generic actions in the future.
	Umbraco provides a few generic actions that can be used across silos, such as copy, move, and trash. Umbraco may include additional generic actions in the future.

	Entity action extensions are provided `this.args` by the `UmbEntityActionBase` superclass. The `this.args` contains a property, `unique` that allows developers to identity which element the user selected.
	Entity action extensions are provided `this.args` by the `UmbEntityActionBase` superclass. The `this.args` contains a `unique` property that allows developers to identify which element the user selected.


		### Entity User Permissions

		Entity user permissions are assigned to a document, media, member, etc., and are registered using the `entityUserPermission` type in the extension's manifest.

Entity Actions, v16 & v17 #7681

Are you sure you want to change the base?

Entity Actions, v16 & v17 #7681

Conversation

bszyman commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📋 Description

📎 Related Issues (if applicable)

✅ Contributor Checklist

Product & Version (if relevant)

Deadline (if relevant)

📚 Helpful Resources

Uh oh!

leekelleher left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sofietoft left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bszyman commented Dec 1, 2025 •

edited

Loading