Fix and rename LandmarkHasLabel rule to NavigationHasLabel #64
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dd1574f to
5295b93
Compare
cc8a730 to
a95a56f
Compare
|
👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.
|
| include ERBLint::Linters::CustomHelpers | ||
| include LinterRegistry | ||
|
|
||
| MESSAGE = "The navigation landmark should have a unique accessible name via `aria-label` or `aria-labelledby`." |
There was a problem hiding this comment.
Should we say/ check that users do not include "navigaiton" in the name
There was a problem hiding this comment.
I added it to the message. As for it being a check, I'm open to following up on it separately, maybe as a distinct rule.
kendallgassner
approved these changes
Apr 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: https://github.com/github/accessibility/issues/3290
This is a lint rule that was written before our teams time that looks like we need to revisit.
This appears to be flagging all
<aside>,<nav>, and<section>without an accessible name.Flagging
<section>seems incorrect since we don’t know if the<section>is intended to be a landmark. A<section>only becomes a region landmark if its labelled, but we don't know if the developer intends it to be.Similarly, I am not sure we about flagging
<aside>.I think it makes sense to enforce a navigation landmark to have an accessible name given that GitHub sites usually have multiple navigation and it would help for those to be labelled.
I am simplifying this rule significantly from what it is currently doing so it only flag:
navorrole="navigation"has no label.navifrole="navigation"is being used.Consequently, I renamed the rule to be
NavigationHasLabel. If we decide we want to add more enforcements around landmark, it should be a more scoped rule.