Block Editor: UI message keys do not match the behavior they describe
@KevinDavilaDotCMS is already working on this.
Since Sep 18, 2026.
- Dominant language
- Java
- Stars
- 970
- Forks
- 486
- Avg merge
- 3d 33m
- Merged PRs (30d)
- 170
Description
Problem Statement
Several message keys in the Block Editor UI (libs/new-block-editor) carry copy that does not describe what the control actually does. The label text and the underlying behavior have drifted apart, so content authors are told one thing and get another.
Confirmed example — image properties dialog:
dotCMS/src/main/webapp/WEB-INF/messages/Language.properties:6516
dot.block.editor.dialog.image-properties.field.tooltip.placeholder=Add a caption…
That placeholder sits on an input bound to form.controls.title in image-popover.component.html. The title attribute is the browser tooltip, not a caption — and the sibling keys confirm it:
| Key | Value | Correct? |
|---|---|---|
...field.tooltip.label |
Tooltip |
❌ |
...field.tooltip.hint |
Text shown when hovering over the image |
✅ |
...field.tooltip.placeholder |
Add a caption… |
❌ describes a caption, field is the tooltip |
Impact: Content authors type caption text into a field that renders as a hover tooltip. The text never appears on the page, and there is no visible error — the author simply believes the caption is set. This will get worse once a real Caption field ships (#37496), because two fields will appear to do the same thing.
The image dialog is the one instance we have verified. This defect covers auditing the whole Block Editor UI for the same class of mismatch and fixing every instance found.
Browser & OS: not browser-specific — the copy is wrong in all browsers.
Steps to Reproduce
- Log in to the dotCMS admin and edit a contentlet that has a Block Editor field.
- Insert an image into the Block Editor (toolbar → Insert image, or the slash menu).
- Select the image, then click Edit image properties in the image toolbar.
- Look at the second field, labeled Tooltip.
- Observe the placeholder text reads "Add a caption…".
- Type text into that field and click Save.
- Publish/preview the page.
- Expected: the text appears as a caption below the image, as the placeholder promised.
- Actual: the text is written to the
<img title="…">attribute and only appears as a hover tooltip. No caption is rendered anywhere.
Acceptance Criteria
Audit
- Every
dot.block.editor.*key used bylibs/new-block-editoris reviewed against the control it is bound to and the behavior that control triggers - The audit covers labels, hints, placeholders,
aria-labels, tooltips, toolbar item text, slash-menu entries, and dialog titles - The audit findings are recorded as a comment on this issue — one line per mismatch, giving the key, the current value, the actual behavior, and the corrected value
- Every key referenced from
libs/new-block-editortemplates and TypeScript resolves to an existing entry inLanguage.properties(no missing keys rendering as raw key strings) - Every
dot.block.editor.*entry inLanguage.propertiesis still referenced bylibs/new-block-editor(orphaned keys are reported, not silently removed)
Confirmed fix
-
dot.block.editor.dialog.image-properties.field.tooltip.placeholderno longer mentions "caption" and describes tooltip text instead - The Tooltip field's label, hint, and placeholder all consistently describe the browser tooltip behavior
Remaining fixes
- Every mismatch found in the audit is corrected in
Language.properties - No message key is renamed unless its current name is itself misleading; where a rename is required, all references are updated in the same change
No regressions
- Every corrected key still renders through the
| dmpipe with no missing-key fallbacks in the UI -
aria-labelcorrections keep every interactive control in the Block Editor labeled for screen readers
Tests
- Unit specs in
libs/new-block-editor/assert the corrected keys are the ones bound to their respective controls
dotCMS Version
Latest from main (verified at commit 66bb905280).
Severity
Low - Minor issue or cosmetic
Links
- NA — no Freshdesk ticket. Found during Block Editor development.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.