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-sidebar): add optional backdrop support #5182

merged 70 commits into from Apr 19, 2020


Copy link

@tmorehouse tmorehouse commented Apr 19, 2020

Describe the PR

Adds optional backdrop to sidebar

Makes the sidebar DOM structure slightly different, but shouldn't be a breaking change to most users

To Do:

  • adjust tests for new DOM structure
  • add unit tests for backdrop
  • update docs
  • add focus constraint control (borrowing from modal) and set `aria-modal="true"

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)

Copy link

@vercel vercel bot commented Apr 19, 2020

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

🔍 Inspect:

@tmorehouse tmorehouse added Status: WIP PR: Minor Type: Feature labels Apr 19, 2020
Copy link

@codecov codecov bot commented Apr 19, 2020

Codecov Report

Merging #5182 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5182   +/-   ##
  Coverage   100.00%   100.00%           
  Files          279       279           
  Lines         8697      8697           
  Branches      2486      2486           
  Hits          8697      8697           
Flag Coverage Δ
#unittests 100.00% <0.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 728348a...728348a. Read the comment docs.

@vercel vercel bot temporarily deployed to Preview Apr 19, 2020 Inactive
@vercel vercel bot temporarily deployed to Preview Apr 19, 2020 Inactive
@vercel vercel bot temporarily deployed to Preview Apr 19, 2020 Inactive
@vercel vercel bot temporarily deployed to Preview Apr 19, 2020 Inactive
@vercel vercel bot temporarily deployed to Preview Apr 19, 2020 Inactive
@vercel vercel bot temporarily deployed to Preview Apr 19, 2020 Inactive
@jacobmllr95 jacobmllr95 merged commit c6375e5 into dev Apr 19, 2020
14 checks passed
v2.12.0 automation moved this from In progress to Done Apr 19, 2020
@jacobmllr95 jacobmllr95 deleted the feat-sidebar-backdrop branch Apr 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
PR: Minor Type: Feature
No open projects

Successfully merging this pull request may close these issues.

None yet

2 participants