Skip to content

Conversation

@bszyman
Copy link
Contributor

@bszyman bszyman commented Dec 1, 2025

📋 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

@bszyman bszyman changed the title Entity Actions, v16 Entity Actions, v16 & v17 Dec 1, 2025
@bszyman bszyman marked this pull request as ready for review December 1, 2025 08:41
…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.
Copy link
Member

@leekelleher leekelleher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

<img src="../../../.gitbook/assets/entity-action-sidebar-context.svg" alt="graphic representation of the sidebar context menu">

### Workspace Entity Menu <a href="#workspace-entity-action-menu" id="workspace-entity-action-menu"></a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sofietoft Am I correct in thinking that we don't need this explicit anchor tags? As in Gitbook will auto-generate the anchor IDs for each heading?

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


| Current Backoffice Letter | Verb |
| ------------------------- | -------------------------------- |
| Current Backoffice letter | Verb |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants