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 aria label to editor view for accessibility purposes #35

Closed
wants to merge 1 commit into from

Conversation

sfc-gh-klin
Copy link

This is the second of two PRs I have opened for accessibility (the first was here).

I'm interested in adding an aria-label field for the editor textbox to meet the guidelines of this accessibility check.

I went with the value "editor" to try to stay succinct and convey that the textbox is for the code editor that the user interacts with on their screen. What do you think?

@marijnh
Copy link
Member

marijnh commented May 19, 2022

I think "editor" conveys zero additional information, since the screen reader will already announce it as an editable input, and only clutters up the reading. People are encouraged to add a meaningful label via contentAttributes, but this doesn't seem helpful. Was it inspired by actual feedback from a screen reader user, or are you just trying to hush an automatic checker?

@sfc-gh-klin
Copy link
Author

The latter--an automatic checker. What do you suggest for the aria-label field?

@marijnh
Copy link
Member

marijnh commented May 20, 2022

Same as with other input fields—something that tells the user what it is they are editing. But that is context-dependent, and thus not something that should be baked into the library itself.

@marijnh marijnh closed this May 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants