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

fix: adds accessibility to code-group component #2630

Merged
merged 1 commit into from Oct 2, 2020
Merged

fix: adds accessibility to code-group component #2630

merged 1 commit into from Oct 2, 2020

Conversation

lbenie
Copy link
Contributor

@lbenie lbenie commented Sep 29, 2020

Summary

Fixes the code-group component by wrapping the buttons in a list for accessibility purpose.

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Before on the left
After on the right
image

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

@d-pollard d-pollard self-requested a review October 1, 2020 15:38
Copy link
Collaborator

@d-pollard d-pollard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you happen to have an a11y resource that would explain how this improves accessibility vs what was previously there?

Other than the comment I made, it looks good!

@lbenie
Copy link
Contributor Author

lbenie commented Oct 1, 2020

Do you happen to have an a11y resource that would explain how this improves accessibility vs what was previously there?

Other than the comment I made, it looks good!

Sure!

Some guidelines about list usage in regards to WCAG AA

https://www.a11yproject.com/checklist/#use-list-elements-lesscodegreaterolless/codegreater-lesscodegreaterulless/codegreater-and-lesscodegreaterdlless/codegreater-elements-for-list-content

Since the component is listing a bunch of related buttons, it makes more sense to group them under a list tag.

Although thinking on the nav element should be removed since it relates to navigation links. I'll update the PR to remove the nav and fix the CSS

@lbenie
Copy link
Contributor Author

lbenie commented Oct 1, 2020

@d-pollard

I've updated the PR with the requested changes let me know if I need to do something else :)

@d-pollard d-pollard self-requested a review October 1, 2020 23:37
Copy link
Collaborator

@d-pollard d-pollard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thank you for making these changes!

@bencodezen bencodezen merged commit 35865ec into vuejs:master Oct 2, 2020
@bencodezen
Copy link
Member

Thanks @lbenie for your work on this! Appreciate it!

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.

None yet

3 participants