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): new custom component <b-sidebar> (closes #3324, #3210, #1702) #5021

Merged
merged 161 commits into from Mar 29, 2020

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Mar 26, 2020

Describe the PR

New <b-sidebar> component, for creating fixed viewport (left or right) slide out drawers.

Users can place any arbitrary content they wish in the sidebars.

Very basic component, that leaves the majority of styling and content layout up to the user.

Roughly based on the Bootstrap offcanvas example.

Closes #3324
Closes #3210
Closes #1702

To Do:

  • make header with close button optional
  • optional footer slot
  • accessibility docs
  • lazy prop docs
  • unit testing
  • SASS variables
  • other stuff (TBD)
    • close on ESC keypress (opt-out)
    • close on route change (opt-out) uses fullPath including query and hash
    • add optional lazy content rendering
    • handle tooltips/popover inside sidebars
    • close on clickout/focusout? (opt-in or out ? as it may close on things like interactive popovers) leaving out for now.
    • add docs page for v-b-toggle directive (make a separate PR)

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, 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
Copy link

codecov bot commented Mar 26, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #5021      +/-   ##
==========================================
+ Coverage   99.93%   99.93%   +<.01%     
==========================================
  Files         275      277       +2     
  Lines        6423     6509      +86     
  Branches     1620     1639      +19     
==========================================
+ Hits         6419     6505      +86     
  Misses          3        3              
  Partials        1        1
Impacted Files Coverage Δ
src/components/form-timepicker/form-timepicker.js 100% <ø> (ø) ⬆️
src/components/index.js 100% <ø> (ø) ⬆️
src/components/modal/modal.js 99.59% <ø> (ø) ⬆️
src/index.js 100% <ø> (ø) ⬆️
src/components/tooltip/helpers/bv-tooltip.js 99.6% <100%> (ø) ⬆️
src/components/sidebar/index.js 100% <100%> (ø)
src/components/sidebar/sidebar.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 f378aef...bcff309. Read the comment docs.

@tmorehouse tmorehouse added PR: Minor Requires minor version bump Status: WIP Type: Feature labels Mar 26, 2020
@tmorehouse tmorehouse added this to In progress in 2.10.0 Mar 26, 2020
@tmorehouse tmorehouse added this to Custom Components in Roadmap Mar 26, 2020
@ghost
Copy link

ghost commented May 28, 2020

is this already implemented ? i am looking for a sidebar offcanvas menu in bootstrap-vue. Thanks

@tmorehouse
Copy link
Member Author

@jensgeffken it has been available since BootstrapVue v2.10.0

@bbugh
Copy link
Contributor

bbugh commented Jun 17, 2020

Is bootstrap-vue breaking from feature parity Bootstrap, or will this sidebar be updated to use the offcanvas component from Bootstrap 5 (if it is merged)?

@jacobmllr95
Copy link
Member

@bbugh It will be updated to match Bootstrap v5's Offcanvas component in the future.

@ghost
Copy link

ghost commented Jun 17, 2020

does anyone knows how many breaking changes are coming. in bootstrap 5 ??? 😟

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Roadmap
Completed
2.10.0
  
Done
3 participants