Make Editor title configurable again to fix accessibility issues #15208
Labels
domain:accessibility
This issue reports an accessibility problem.
domain:dx
This issue reports a developer experience problem or possible improvement.
domain:integration-dx
This issue reports a problem with the developer experience when integrating CKEditor into a system.
type:feature
This issue reports a feature request (an idea for a new functionality or a missing option).
Milestone
📝 Provide a description of the new feature
For accessibility reasons, it would be great if CKEditor's voice-label
<label>
element could be configurable so that it could reflect the name of the field that CKEditor is replacing.Screen readers read the "voice label"
<label>
value that is generated by CKEditor, which is always "Rich Text Editor."For example, this instance:
has this
<label>
:For users who rely on screen readers, it would be much more helpful if the reader uttered "Comment," and not "Rich Text Editor." (See https://www.w3.org/WAI/WCAG21/Understanding/labels-or-instructions.html, https://wcag.com/developers/3-3-2-labels-instructions.)
This value was made configurable in CKEditor4 with the
config.title
property: https://dev.ckeditor.com/ticket/12204.After digging through CKEditor5 docs, I have not found a similar feature. I realize that the architecture of CKEditor 5 is vastly different than 4, but my proposal would be that the editor title/voice label be a configurable value -- if at all possible.
Additionally, thearia-label
on<div class="ck-content" ...>
should be removed.aria-label
is only necessary if there is not an associated<label>
tag. The effect of having both the<label>
and thearia-label
is that both are read by the screen reader -- which is confusing.What is the expected behavior of the proposed feature?
A developer could add a title config value to the editor's
create()
method, and the generated voice label element would contain that title.Something like:
would generate:
Additionally, thearia-label
would be removed from theck-content
<div>
:Edit 10/20/23:
After some further research, I see that the
aria-label
is important for multi-root editors. So, I've removed that part of this request.If you'd like to see this feature implemented, add a 👍 reaction to this post.
The text was updated successfully, but these errors were encountered: