IBX-11549: name.help translation key described in Dev-doc#3294
Open
julitafalcondusza wants to merge 4 commits into
Open
IBX-11549: name.help translation key described in Dev-doc#3294julitafalcondusza wants to merge 4 commits into
name.help translation key described in Dev-doc#3294julitafalcondusza wants to merge 4 commits into
Conversation
Preview of modified filesPreview of modified Markdown: |
tbialcz
reviewed
Jul 16, 2026
tbialcz
approved these changes
Jul 16, 2026
mnocon
reviewed
Jul 16, 2026
mnocon
left a comment
Contributor
There was a problem hiding this comment.
One small comment, and the YAML example needs to be fixed
adriendupuis
approved these changes
Jul 16, 2026
adriendupuis
left a comment
Contributor
There was a problem hiding this comment.
I think it can be something else than translation key if working only in English or prototyping. Not sure about "array", it sounds more "PHP associative array"-ish than YAML
|
|
||
| For a full example of block configuration, see [Create custom Page block](create_custom_page_block.md). | ||
|
|
||
| ### Block name help text |
Contributor
There was a problem hiding this comment.
Suggested change
| ### Block name help text | |
| ### Block name and help |
|
|
||
| ### Block name help text | ||
|
|
||
| The `name` setting accepts either a single translation key, or an array with `text` and `help` keys. |
Contributor
There was a problem hiding this comment.
Suggested change
| The `name` setting accepts either a single translation key, or an array with `text` and `help` keys. | |
| The `name` setting accepts either a single translation key, an hard coded string of text that won't be translated, or an object with `text` and `help` property keys. |
| ``` | ||
|
|
||
| - `text` - corresponds to the block name. | ||
| - `help` - is an optional translation key whose translation is rendered as a helper text under the **Name** field in the block configuration form. |
Contributor
There was a problem hiding this comment.
Optionally a screenshot to show how it's rendered? Maybe from a built-in block.
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
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.
New
name.helptranslation key described in Dev-doc:Checklist