Skip to content

Conversation

@engijlr
Copy link
Contributor

@engijlr engijlr commented Oct 1, 2025

πŸ“‹ Description

This PR explains how to register an entitySign, bind it with forEntityFlags, and render an icon.

πŸ“Ž Related Issues (if applicable)

Relates to PR: umbraco/Umbraco-CMS#20328

βœ… 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)

CMS 16.4/17

Deadline (if relevant)

Expect this to be published along with the RC for 16.4 or 17.

@engijlr engijlr marked this pull request as ready for review October 20, 2025 07:55
Copy link
Contributor

@AndyButland AndyButland left a comment

Choose a reason for hiding this comment

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

Looks good to me @engijlr. I suggested a few small updates, partially addressing @nielslyngsoe's point in the copy.

I think it would be nice to present a second example under a heading like "Example: Rendering an Entity Sign with Custom Logic" where you show how to render a backoffice sign without server input. Presumably this won't have a forEntityFlags setting but will have a referenced .ts file where the logic is implemented. That'll handle the rest of Niel's point about showing that this isn't just an extension that depends on the data coming from the management API.

Maybe you can think of a good real-world example, but even an illustrative one adding a sign for any document that has been created in the last week would suffice. The create date for a document I believe is in the tree item response model, so you could read if from there,

Copy link
Contributor

@AndyButland AndyButland left a comment

Choose a reason for hiding this comment

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

Nice, all looks good from my perspective @engijlr,

Copy link
Contributor

@eshanrnh eshanrnh left a comment

Choose a reason for hiding this comment

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

The PR looks great.

@engijlr is there a specific date you would like this PR published or can it be published anytime?

@engijlr
Copy link
Contributor Author

engijlr commented Oct 30, 2025

Hi @eshanrnh,
In my opinion, it can be published anytime. @AndyButland and @nielslyngsoe, what do you think?

@AndyButland
Copy link
Contributor

AndyButland commented Oct 30, 2025

I agree, it can be published now. And actually @eshanrnh, if you could do as soon as you can please, that would be great (as I linked to this page in the docs expecting the updates to be there in today's blog post πŸ™ˆ).

@eshanrnh eshanrnh merged commit 659f4a1 into main Oct 30, 2025
48 of 65 checks passed
@eshanrnh eshanrnh deleted the cms/backoffice-signs branch November 3, 2025 09:58
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.

5 participants