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-tabs): emit cancelable BvEvent before changing tabs via new `activate-tab` event (closes #4273) #4274

Merged
merged 11 commits into from Oct 18, 2019

Conversation

@tmorehouse
Copy link
Member

tmorehouse commented Oct 18, 2019

Describe the PR

Emit new event activate-tab before changing tabs.

New event is emitted with three arguments:

  • newTabIndex tab index that will be activated
  • prevTabIndex tab index of the current active tab, or -1 if no active tab
  • bvEvt BvEvent object instance

Calling bvEvt.preventDefault() will prevent the tab from activating.

Ideally users should be setting the disabled prop on any <b-tab> they don't want users to activate (better for accessibility). If users do use this event to prevent a tab from activating, they should provide feedback to the user as to why the tab cannot be activated (i.e. an alert, etc).

Closes #4273

To Do:

  • meta data update
  • Get event working with v-model/value update
  • documentation update
  • unit tests

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

codecov bot commented Oct 18, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #4274      +/-   ##
==========================================
+ Coverage   99.91%   99.91%   +<.01%     
==========================================
  Files         237      237              
  Lines        4548     4550       +2     
  Branches     1280     1280              
==========================================
+ Hits         4544     4546       +2     
  Misses          3        3              
  Partials        1        1
Impacted Files Coverage Δ
src/components/tabs/tabs.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 009431e...cc7feff. Read the comment docs.

tmorehouse added 8 commits Oct 18, 2019
@tmorehouse tmorehouse removed the Status: WIP label Oct 18, 2019
@tmorehouse tmorehouse requested a review from jackmu95 Oct 18, 2019
@tmorehouse tmorehouse marked this pull request as ready for review Oct 18, 2019
@vincentdh

This comment has been minimized.

Copy link

vincentdh commented Oct 18, 2019

Thanks @tmorehouse! That was fast! Hopefully it will be approved and merged as quickly as you worked!

@tmorehouse tmorehouse added this to In progress in 2.1.0 via automation Oct 18, 2019
@tmorehouse

This comment has been minimized.

Copy link
Member Author

tmorehouse commented Oct 18, 2019

@vincentdh Not sure when it will be released yet... will be part of the 2.1.0 release.... hopefully out by the end of next week (maybe earlier)

@tmorehouse tmorehouse changed the title feat(b-tabs): emit cancelable BvEvent before changing tabs (closes #4273) feat(b-tabs): emit cancelable BvEvent before changing tabs via new `activate-tab` event (closes #4273) Oct 18, 2019
jackmu95 added 2 commits Oct 18, 2019
@tmorehouse tmorehouse merged commit 9b195dd into dev Oct 18, 2019
9 checks passed
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.91%)
Details
codecov/project 99.91% (+<.01%) compared to 009431e
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (pi0) No manifest changes detected
2.1.0 automation moved this from In progress to Done Oct 18, 2019
@tmorehouse tmorehouse deleted the issue/4273 branch Oct 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2.1.0
  
Done
3 participants
You can’t perform that action at this time.