Skip to content
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.

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

Add an option to customize editor's application region label #2445

Closed
Comandeer opened this issue Sep 29, 2018 · 3 comments · Fixed by #5146
Closed

Add an option to customize editor's application region label #2445

Comandeer opened this issue Sep 29, 2018 · 3 comments · Fixed by #5146
Labels
accessibility Issue related to accessibility. status:confirmed An issue confirmed by the development team. type:feature A feature request.
Milestone

Comments

@Comandeer
Copy link
Member

Type of report

Bug

Provide detailed reproduction steps (if any)

  1. Open http://ckeditor.test/ckeditor-dev/samples/.
  2. Navigate into the editor.
  3. Listen to JAWS announcing the editor.

Expected result

The name of the editor is announced once.

Actual result

The name of the editor is announced twice.

Other details

  • JAWS: 18

Iframe-based editor has its label in 3 different places:

  • [title] attribute;
  • title element;
  • dedicated element before the editable.

Not surprising that the name's announced twice…

@Comandeer
Copy link
Member Author

We decided to reorganize labels in the editor. Instead of using one label in two places, we decided to switch to two:

  • one is used as the label for the whole editor's application (editable area + toolbars),
  • one is used for the editable area only.

Each of these labels has corresponding config variable and editor's property:

Label Config variable Editor's property Default value
Application config.applicationTitle editor.applicationTitle Rich Text Editor, <editor name>
Editable area config.title editor.title Editor, <editor name>

These two labels are used by assistive technology in different contexts, e.g. application label is used to differentiate between editors on page and the editable area one can be used in navigation between form controls.

Such a change also makes the screen reader output more sensible for the user – instead of reading the same label twice, now there is a difference in the two labels:

  • new approach: "Rich Text Editor, <editor name> application. Editor, <editor name> edit multiline",
  • old approach: "Rich Text Editor, <editor name> application. Rich Text Editor, <editor name> edit multiline".

Additionally, these labels are fully customizable via config variables and can be even disabled if considered redundant.

Unfortunately, this labeling system does not work well with the iframe-based editing. For some reason, screen readers repeat the accessible name of the iframe for the document inside it, making the editable area label be heard twice. The best results can be achieved by using div-based editing – then labels are read only once.

@jacekbogdanski
Copy link
Member

Due to the explanation given in #2445 (comment) I'm changing this ticket into a feature request.

@jacekbogdanski jacekbogdanski added type:feature A feature request. and removed type:bug A bug. labels May 9, 2022
@jacekbogdanski jacekbogdanski changed the title Label for iframe-based editor is read twice in JAWS Add an option to customize editor's application region label May 9, 2022
@CKEditorBot CKEditorBot added this to the 4.19.0 milestone May 9, 2022
@CKEditorBot
Copy link
Collaborator

Closed in #5146

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility Issue related to accessibility. status:confirmed An issue confirmed by the development team. type:feature A feature request.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants