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-modal): remove role="document" from .modal-content #5345

Merged
merged 5 commits into from May 12, 2020
Merged

Conversation

jacobmllr95
Copy link
Member

@jacobmllr95 jacobmllr95 commented May 11, 2020

Describe the PR

This PR removes the no longer needed role="document" from .modal-content.

Ref: twbs/bootstrap#30687

PR checklist

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

  • Bugfix (fixes a boo-boo in the code) - fix(...), requires a patch version update
  • Feature (adds a new feature to BootstrapVue) - feat(...), requires a minor version update
  • Enhancement (augments an existing feature) - feat(...), requires a minor version update
  • ARIA accessibility (fixes or improves ARIA accessibility) - fix(...), requires a patch or minor version update
  • Documentation update (improves documentation or typo fixes) - chore(docs), requires a patch version update
  • Other (please describe)

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

  • No
  • Yes (please describe since breaking changes require a minor version update)

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, and determines the next version type (patch or minor).

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

  • Includes documentation updates
  • Includes component package.json meta section updates (prop, slot and event changes/updates)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (required for new features and enhancements)
  • Existing test suites are passing
  • CodeCov for patch has met target (all changes/updates have been tested)
  • 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)

…et `role="dialog"` when `.modal` is visible
@vercel
Copy link

@vercel vercel bot commented May 11, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/bootstrap-vue/bootstrap-vue/kst0d9kbz
Preview: https://bootstrap-vue-git-fix-modal-aria.bootstrap-vue.now.sh

@codesandbox-ci
Copy link

@codesandbox-ci codesandbox-ci bot commented May 11, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 6759967:

Sandbox Source
determined-framework-hw9cc Configuration

@codecov
Copy link

@codecov codecov bot commented May 11, 2020

Codecov Report

Merging #5345 into dev will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5345   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          281       281           
  Lines         8828      8829    +1     
  Branches      2505      2505           
=========================================
+ Hits          8828      8829    +1     
Flag Coverage Δ
#unittests 100.00% <100.00%> (ø)
Impacted Files Coverage Δ
src/components/modal/modal.js 100.00% <100.00%> (ø)

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 c5ed437...6759967. Read the comment docs.

src/components/modal/modal.js Outdated Show resolved Hide resolved
@jacobmllr95 jacobmllr95 changed the title fix(b-modal): remove role="document" from .modal-content and only set role="dialog" when .modal is visible fix(b-modal): remove role="document" from .modal-content May 11, 2020
@jacobmllr95 jacobmllr95 requested a review from tmorehouse May 11, 2020
@tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented May 11, 2020

Will just have to test with a few screen readers to ensure the modal is properly announced (title, etc) when it opens.

@jacobmllr95 jacobmllr95 added this to In progress in v2.14.0 May 11, 2020
@jacobmllr95 jacobmllr95 merged commit 0c2b406 into dev May 12, 2020
14 checks passed
v2.14.0 automation moved this from In progress to Done May 12, 2020
@jacobmllr95 jacobmllr95 deleted the fix-modal-aria branch May 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
v2.14.0
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants