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

feat(b-table): better sort labeling for screen readers (closes #4487) #4488

Merged
merged 15 commits into from Dec 13, 2019

Conversation

@tmorehouse
Copy link
Member

tmorehouse commented Dec 11, 2019

Describe the PR

Switch click to sort .... label from aria-label to an .sr-only element in the field header

If aria-label is present, most screen readers will not read the content of the th cell

This moves the aria-label content into an sr-only hidden span within the header cell.

Closes #4487

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)

One notable change is that if users use labelHtml in a field definition, the html will now be placed into a div element instead of directly in the TH element, so allow for concatenation of the sr-only sort label

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, chore(docs): 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
  • CodeCov for patch has met target
  • 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)
@codecov

This comment has been minimized.

Copy link

codecov bot commented Dec 11, 2019

Codecov Report

Merging #4488 into dev will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #4488   +/-   ##
=======================================
  Coverage   99.91%   99.91%           
=======================================
  Files         247      247           
  Lines        4855     4855           
  Branches     1363     1366    +3     
=======================================
  Hits         4851     4851           
  Misses          3        3           
  Partials        1        1
Impacted Files Coverage Δ
src/components/table/helpers/mixin-thead.js 100% <100%> (ø) ⬆️
src/components/table/helpers/mixin-sorting.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 69edc0c...484ec69. Read the comment docs.

tmorehouse added 6 commits Dec 11, 2019
@tmorehouse tmorehouse changed the title feat(b-table): better sort labeling for screen readers feat(b-table): better sort labeling for screen readers (closes #4487) Dec 11, 2019
tmorehouse added 6 commits Dec 11, 2019
@tmorehouse tmorehouse marked this pull request as ready for review Dec 11, 2019
@tmorehouse tmorehouse removed the Status: WIP label Dec 11, 2019
@tmorehouse tmorehouse requested a review from jackmu95 Dec 11, 2019
@tmorehouse tmorehouse added this to In progress in 2.2.0 via automation Dec 11, 2019
@jackmu95 jackmu95 merged commit d4e66fa into dev Dec 13, 2019
9 checks passed
9 checks passed
License Compliance All checks passed.
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.91%)
Details
codecov/project 99.91% (+0%) compared to 69edc0c
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (pi0) No manifest changes detected
2.2.0 automation moved this from In progress to Done Dec 13, 2019
@jackmu95 jackmu95 deleted the table/a11y branch Dec 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2.2.0
  
Done
2 participants
You can’t perform that action at this time.