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-overlay): add support for overlay click event (closes #5243) #5248

Merged
merged 6 commits into from Apr 26, 2020

Conversation

jacobmllr95
Copy link
Member

@jacobmllr95 jacobmllr95 commented Apr 24, 2020

Describe the PR

This PR adds support for the click event on the <b-overlay> component's overlay.

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)

@jacobmllr95 jacobmllr95 added Type: Feature PR: Minor labels Apr 24, 2020
@jacobmllr95 jacobmllr95 requested a review from tmorehouse Apr 24, 2020
@jacobmllr95 jacobmllr95 added this to In progress in v2.13.0 via automation Apr 24, 2020
@vercel
Copy link

@vercel vercel bot commented Apr 24, 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/jptfijn5a
Preview: https://bootstrap-vue-git-feat-overlay-click-event.bootstrap-vue.now.sh

@codesandbox-ci
Copy link

@codesandbox-ci codesandbox-ci bot commented Apr 24, 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 492c154:

Sandbox Source
wizardly-swartz-57fgu Configuration

@codecov
Copy link

@codecov codecov bot commented Apr 24, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5248   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          279       279           
  Lines         8706      8707    +1     
  Branches      2489      2489           
=========================================
+ Hits          8706      8707    +1     
Flag Coverage Δ
#unittests 100.00% <100.00%> (ø)
Impacted Files Coverage Δ
src/components/overlay/overlay.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 0c57ffe...492c154. Read the comment docs.

@@ -146,7 +146,8 @@ export const BOverlay = /*#__PURE__*/ Vue.extend({
'position-absolute': !this.noWrap || (this.noWrap && !this.fixed),
'position-fixed': this.noWrap && this.fixed
},
style: { ...positionCover, zIndex: this.zIndex || 10 }
style: { ...positionCover, zIndex: this.zIndex || 10 },
on: { click: evt => this.$emit('click', evt) }
Copy link
Member

@tmorehouse tmorehouse Apr 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this should be overlay-click?

Copy link
Member Author

@jacobmllr95 jacobmllr95 Apr 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought about that too but I think it is fine like that.

Copy link
Member

@tmorehouse tmorehouse Apr 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vue 3 is going to make it difficult to use custom events names that are the same as native event names (they got rid of the .native modifier)

Copy link
Member

@tmorehouse tmorehouse Apr 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as all future events (Vue v3) will be added by onClick="handler" (i.e. as $attrs) where there is no option to bind a native listener (if users want to) to the root element 😿

@tmorehouse tmorehouse changed the title feat(overlay): add support for click event (closes #5243) feat(overlay): add support for overlay click event (closes #5243) Apr 24, 2020
@tmorehouse tmorehouse changed the title feat(overlay): add support for overlay click event (closes #5243) feat(b-overlay): add support for overlay click event (closes #5243) Apr 26, 2020
@tmorehouse tmorehouse mentioned this pull request Apr 26, 2020
9 tasks
@tmorehouse tmorehouse merged commit 582560f into dev Apr 26, 2020
13 of 14 checks passed
v2.13.0 automation moved this from In progress to Done Apr 26, 2020
@tmorehouse tmorehouse deleted the feat-overlay-click-event branch Apr 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Minor Type: Feature
Projects
No open projects
v2.13.0
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants