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(b-nav-form, b-nav-text): ensure these sub-components have `<li>` as root element for accessibility #4100

Merged
merged 20 commits into from Oct 11, 2019

Conversation

@tmorehouse
Copy link
Member

tmorehouse commented Sep 15, 2019

Describe the PR

b-nav and b-navbar-nav use <ul> as their root elements. So all direct children should be wrapped in <li> elements for proper element semantic hierarchy and accessibility (a11y).

For b-nav-form, a new prop form-class is introduced for placing classes on the nested form element.

PR checklist

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

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe)

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

  • No
  • Yes (please describe)

For users targeting specific child elements via CSS, they may need to adjust their selectors.
For general users, it should work as expected without any code changes.

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, fix typos, chore: fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
…for a11y
tmorehouse added 3 commits Sep 15, 2019
@codecov

This comment has been minimized.

Copy link

codecov bot commented Sep 15, 2019

Codecov Report

Merging #4100 into dev will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #4100      +/-   ##
==========================================
+ Coverage   99.86%   99.86%   +<.01%     
==========================================
  Files         237      237              
  Lines        4534     4538       +4     
  Branches     1280     1280              
==========================================
+ Hits         4528     4532       +4     
  Misses          5        5              
  Partials        1        1
Impacted Files Coverage Δ
src/components/nav/nav-text.js 100% <100%> (ø) ⬆️
src/components/nav/nav-form.js 100% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4aeef50...7c62e4a. Read the comment docs.

tmorehouse added 2 commits Sep 15, 2019
@tmorehouse tmorehouse changed the title feat(b-nav-*): ensure `b-nav-*` sub-components are wrapped in `<li>` for a11y feat(b-nav-form, b-nav-text): ensure these sub-components have `<li>` as root element for a11y Sep 15, 2019
tmorehouse added 4 commits Sep 15, 2019
@tmorehouse tmorehouse removed the Status: WIP label Sep 15, 2019
@tmorehouse tmorehouse marked this pull request as ready for review Sep 15, 2019
@tmorehouse tmorehouse requested a review from jackmu95 Sep 15, 2019
@tmorehouse tmorehouse changed the title feat(b-nav-form, b-nav-text): ensure these sub-components have `<li>` as root element for a11y feat(b-nav-form, b-nav-text): ensure these sub-components have `<li>` as root element for accessibility Sep 15, 2019
@tmorehouse tmorehouse added this to In progress in 2.1.0 via automation Sep 15, 2019
@tmorehouse

This comment has been minimized.

Copy link
Member Author

tmorehouse commented Sep 15, 2019

This shouldn't be a breaking change for the majority of users, but those that might be expecting a certain root element for styling it might be. b-nav-form is the only one where the original root element (the <form> has been moved one level deeper (inside the <li>).

for b-form-text the root element is now an <li> instead of a <span>, and the tag prop has been removed (since the root element should always be an <li>)

But thinking it might be a big enough change that is should be in a minor release, rather than a patch release.

tmorehouse and others added 3 commits Sep 16, 2019
tmorehouse and others added 4 commits Sep 19, 2019
tmorehouse added 3 commits Oct 6, 2019
@tmorehouse tmorehouse changed the title feat(b-nav-form, b-nav-text): ensure these sub-components have `<li>` as root element for accessibility fix(b-nav-form, b-nav-text): ensure these sub-components have `<li>` as root element for accessibility Oct 11, 2019
@tmorehouse tmorehouse merged commit 6774800 into dev Oct 11, 2019
8 of 9 checks passed
8 of 9 checks passed
License Compliance FOSSA is analyzing this commit
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
codecov/patch 100% of diff hit (target 99.86%)
Details
codecov/project 99.86% (+<.01%) compared to 4aeef50
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (pi0) No manifest changes detected
2.1.0 automation moved this from In progress to Done Oct 11, 2019
@tmorehouse tmorehouse deleted the tmorehouse/nav-a11y branch Oct 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2.1.0
  
Done
2 participants
You can’t perform that action at this time.