Skip to content

IBX-11549: name.help translation key described in Dev-doc #3294

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

Open
julitafalcondusza wants to merge 5 commits into
base: 5.0
Choose a base branch
from
Open

IBX-11549: name.help translation key described in Dev-doc #3294

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3e240de
name.help translation key described
julitafalcondusza Jul 16, 2026
9ab1abe
configuration splitted
julitafalcondusza Jul 16, 2026
46489fb
code fixed
julitafalcondusza Jul 16, 2026
c7c8661
fix after doc rev
julitafalcondusza Jul 16, 2026
94ae960
fixes, img added
julitafalcondusza Jul 17, 2026
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
24 changes: 23 additions & 1 deletion docs/content_management/pages/page_blocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

| Setting | Description |
|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | Name of the block used in the Page Builder interface. Translatable using the `ibexa_page_fieldtype` translation domain. |
| `name` | Name of the block used in the Page Builder interface. Translatable using the `ibexa_page_fieldtype` translation domain. Also accepts a [`help` key](#block-name-help-text) that adds a helper text under the **Name** field in the block configuration form. |

Check notice on line 24 in docs/content_management/pages/page_blocks.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/pages/page_blocks.md#L24 

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output 
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/content_management/pages/page_blocks.md", "range": {"start": {"line": 24, "column": 97}}}, "severity": "INFO"}
| `category` | Category in the Page Builder **Page blocks** toolbox that the block is shown in. Translatable using the `ibexa_page_fieldtype` translation domain. |
| `thumbnail` | Thumbnail used in the Page Builder **Page blocks** toolbox. |
| `views` | Available [templates for the block](#block-templates). |
Expand All @@ -40,6 +40,28 @@

For a full example of block configuration, see [Create custom Page block](create_custom_page_block.md).

### Block name help text
Comment thread
julitafalcondusza marked this conversation as resolved.
Outdated

The `name` setting accepts either a single translation key, or an array with `text` and `help` keys.
Comment thread
julitafalcondusza marked this conversation as resolved.
Outdated
Both `text` and `help` are translatable using the `ibexa_page_fieldtype` translation domain.

Check notice on line 46 in docs/content_management/pages/page_blocks.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/pages/page_blocks.md#L46 

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output 
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/content_management/pages/page_blocks.md", "range": {"start": {"line": 46, "column": 28}}}, "severity": "INFO"}

``` yaml
Comment thread
julitafalcondusza marked this conversation as resolved.
ibexa_fieldtype_page:
blocks:
my_block:
# legacy scalar form (still supported)
name: my_block.name.key
# new structured form
name:
text: my_block.name.key
help: my_block.name.help.key
```

- `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.

Check notice on line 61 in docs/content_management/pages/page_blocks.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/pages/page_blocks.md#L61 

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output 
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/pages/page_blocks.md", "range": {"start": {"line": 61, "column": 61}}}, "severity": "INFO"}
Comment thread
julitafalcondusza marked this conversation as resolved.

The same format is available for [React App blocks](react_app_block.md).

### Overwriting existing blocks

You can overwrite the following properties in the existing blocks:
Expand Down
2 changes: 1 addition & 1 deletion docs/content_management/pages/react_app_block.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Each configured React app block has an identifier and the following settings:

| Setting | Description |
|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | Name of the block used in the Page Builder interface. |
| `name` | Name of the block used in the Page Builder interface. Also accepts a [`help` key](page_blocks.md#block-name-help-text) that adds a helper text under the **Name** field in the block configuration form. |
| `category` | Category in the Page Builder **Page blocks** toolbox that the block is shown in. |
| `thumbnail` | Thumbnail used in the Page Builder **Page blocks** toolbox. |
| `component` | React App Component name used in `assets/page-builder/react/blocks` directory. |
Expand Down
Loading