Skip to content

Register an entitySign and render an icon. #7457

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Oct 30, 2025
Merged

Register an entitySign and render an icon. #7457

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
40f04a3
Added documentation about displaying an icon and example
engijlr Sep 30, 2025
c368931
Added last example of the manifest.
engijlr Oct 20, 2025
d720be2
Updated sign with custom logic to add a sign.
engijlr Oct 21, 2025
93f5e48
Update 16/umbraco-cms/customizing/back-office-signs.md
eshanrnh Oct 28, 2025
a61367a
Update 16/umbraco-cms/customizing/back-office-signs.md
eshanrnh Oct 28, 2025
a8d36f1
Update 16/umbraco-cms/customizing/back-office-signs.md
eshanrnh Oct 28, 2025
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
28 changes: 27 additions & 1 deletion 16/umbraco-cms/customizing/back-office-signs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
A Flag can be the determinant for a Sign by declaring the `forEntityFlags` as part of its Manifest.

Example:

```json
...
forEntityFlags: "Umb.ScheduledForPublish",
Expand All @@ -33,7 +34,32 @@

## Displaying a Sign

To display a Sign in the backoffice, you register an entitySign extension and bind it to one or more flags using the forEntityFlags property. If you're using an icon variant, you must set kind: "icon" and provide both meta.iconName and meta.label, so the UI has the necessary visual and accessible information to render.

Check warning on line 37 in 16/umbraco-cms/customizing/back-office-signs.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.", "location": {"path": "16/umbraco-cms/customizing/back-office-signs.md", "range": {"start": {"line": 37, "column": 143}}}, "severity": "WARNING"}

Example:

```typescript
import type { UmbExtensionManifest } from "@umbraco-cms/backoffice/extension-registry";
import { UMB_DOCUMENT_ENTITY_TYPE } from "@umbraco-cms/backoffice/document";

export const manifests: UmbExtensionManifest = {
type: "entitySign",
kind: "icon",
alias: "Umb.EntitySign.Document.IsProtected",
name: "Is Protected Document Entity Sign",
forEntityTypes: [UMB_DOCUMENT_ENTITY_TYPE], // Where it can appear
forEntityFlags: ["Umb.IsProtected"], // <---Binding part-When it should appear
weight: 1000,
meta: {
iconName: "icon-lock", // Built-in or custom icon name
label: "Protected", // Visible/accessible label
iconColorAlias: "red",
},
};
```

When an entity includes the Umb.IsProtected flag, this Sign appears next to it in the UI, indicating that the item is protected.

{% hint style="info" %}
The client extension for backoffice signs will be available in Umbraco 16.4 / 17.0.
{% endhint %}

Loading