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, b-table-lite): use `aria-details` rather than `aria-describedby` when details row showing (addresses #3801) #3992

Merged
merged 3 commits into from Aug 31, 2019

Conversation

@tmorehouse
Copy link
Member

commented Aug 31, 2019

Describe the PR

Changed from attribute aria-describedby to aria-details when a row has details showing.

aria-describedby is read out by screen readers as a flattened string of the text content (which may not always make sense with complex markup such as sub tables). aria-details is similar, but just informs the user that there is a landmark region with additional details that they user can navigate to.

Addresses part of #3801

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)

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)
@codecov

This comment has been minimized.

Copy link

commented Aug 31, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #3992   +/-   ##
=======================================
  Coverage   99.86%   99.86%           
=======================================
  Files         238      238           
  Lines        4453     4453           
  Branches     1252     1252           
=======================================
  Hits         4447     4447           
  Misses          5        5           
  Partials        1        1
Impacted Files Coverage Δ
src/components/table/helpers/mixin-tbody-row.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 444d8b0...920ba7e. Read the comment docs.

@tmorehouse tmorehouse marked this pull request as ready for review Aug 31, 2019

@tmorehouse tmorehouse changed the title feat(b-table, b-table-lite): use `aria-details` rather than `aria-describedby` when details row showing feat(b-table, b-table-lite): use `aria-details` rather than `aria-describedby` when details row showing (addresses #3801) Aug 31, 2019

@tmorehouse tmorehouse requested a review from jackmu95 Aug 31, 2019

@tmorehouse tmorehouse merged commit f6f73c7 into dev Aug 31, 2019

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.86%)
Details
codecov/project 99.86% (+0%) compared to 444d8b0
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (pi0) No manifest changes detected

@tmorehouse tmorehouse deleted the tmorehouse/table-details branch Aug 31, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.