Hotfix: UFM alias prefixes #2510
Merged
Conversation
This file contains 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
e.g. `{(alias:|marker)(text)}` would be `{umbContentName: propertyAlias}` or `{~propertyAlias}`
The `~` prefix will be deprecated in a future major release.
leekelleher
commented
Nov 4, 2024
nielslyngsoe
approved these changes
Nov 4, 2024
nielslyngsoe
pushed a commit
that referenced
this pull request
Nov 4, 2024
* Adds `alias` to UFM component registrations
* Adds support for `alias` prefix in UFM syntax
e.g. `{(alias:|marker)(text)}` would be `{umbContentName: propertyAlias}` or `{~propertyAlias}`
* UFM Content Name: adds warning for using the `~` prefix marker
The `~` prefix will be deprecated in a future major release.
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
Following internal review and feedback, the single character marker prefixes can be confusing. For established syntax like outputting a raw value or using a localization key, the respected marker prefixes
=and#are intuitive, however with the new UFM Content Name component, the chose marker prefix is~, which is not established and counter intuitive.To aid discovery, the use of a UFM component alias will be encouraged, e.g.
{umbContentName: propertyAlias}The
~marker prefix will still work and be supported in v15, but set to be deprecated in a future release, theumbContentNamealias prefix will be used going forwards.Types of changes
How to test?
First, test that the existing UFM syntaxes still work as expected. Then test that the "umbContentName" alias prefix works in various places, e.g. Block List, Collection Views, property descriptions.