UFM: Adds $index support to Block editors (fixes #20470)
#20488
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Which is always zero `0`. But has been wired up if we do implement the index order in future.
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for the $index token in UFM (Umbraco Friendly Markup) labels for Block editors, allowing authors to display a block's current zero-based index in the block label.
- Adds
$indexproperty to all block component elements (Block Grid, Block List, RTE Blocks) - Updates block rendering to include index in the block value object for UFM processing
- Implements index observation and propagation throughout the block editor hierarchy
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| ref-rte-block.element.ts | Adds index property and includes it in blockValue for RTE blocks |
| block-rte-entry.element.ts | Implements index observation and passes it to ref component |
| property-editor-ui-block-list.element.ts | Updates repeat key function and passes index to entries |
| ref-list-block.element.ts | Adds index property and includes it in blockValue for list blocks |
| inline-list-block.element.ts | Adds index property and includes it in blockValue for inline blocks |
| block-list-entry.element.ts | Implements index observation and passes it to view components |
| block-grid-entry.element.ts | Implements index observation and passes it to view components |
| block-grid-entries.element.ts | Updates repeat key function and passes index to entries |
| block-grid-block.element.ts | Adds index property and includes it in blockValue for grid blocks |
| block-grid-block-inline.element.ts | Adds index property and includes it in blockValue for inline grid blocks |
...UI.Client/src/packages/block/block-rte/components/block-rte-entry/block-rte-entry.element.ts
Show resolved
Hide resolved
...block/block-list/property-editors/block-list-editor/property-editor-ui-block-list.element.ts
Show resolved
Hide resolved
...nt/src/packages/block/block-grid/components/block-grid-entries/block-grid-entries.element.ts
Show resolved
Hide resolved
iOvergaard
approved these changes
Oct 14, 2025
iOvergaard
pushed a commit
that referenced
this pull request
Oct 17, 2025
* Block List: adds `$index` support for UFM labels * Block Grid: adds `$index` support for UFM labels * Block RTE: adds `$index` support for UFM labels Which is always zero `0`. But has been wired up if we do implement the index order in future.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #20470.
When authoring UFM labels for Block editors (Block Grid, Block List and RTE Blocks), you can now use a
$indextoken to display the block's current index (zero-based).To note, with RTE Blocks, the index will always be zero
0. It has been wired up so that if we do implement index ordering for RTE Blocks in future, then it will render correctly.How to test?
On a document that has a Block List or Block Grid, configure the corresponding data-type to have a label that utilizes the UFM syntax, e.g.
Block ${ $index + 1 }. When adding several blocks, the block label should render the$indexin a sequential order.