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(v-b-toggle): support specifying target ID via directive argument, and array of target IDs via directive value (closes #4834) #5336

merged 96 commits into from May 11, 2020


Copy link

@tmorehouse tmorehouse commented May 9, 2020

Describe the PR

  • Allows directive argument to be a target ID (previously only modifiers and value were checked)
  • Allows directive value to be an array of target IDs (handy for toggling multiple collapses)
  • Allows directive value to be a space delimited string of target IDs (handy for toggling multiple collapses)
  • Adds the class not-collapsed to the trigger element when the target(s) are expanded
  • Improves codebase size by removing duplicated code an using utilities where possible

Closes #4834

To Do:

  • simplify code by moving applicable utils/target code to v-b-toggle directive code, and remove utils/target since v-b-toggle is the only directive that uses it
  • support target as directive argument
  • support directive value as a string or array of target IDs
  • support passing value as a string of space delimited target IDs
  • ensure that duplicate target IDs are filtered out to prevent multiple toggle events
  • have v-b-toggle check if evt.defaultPrevented before calling handler(s)
  • add class not-collapsed to trigger element when target is not collapsed
  • ensures that elements that are not buttons or links have the appropriate tabindex and keydown handlers for accessibility
  • directive meta.json update
  • switch <b-navbar-toggle> to use v-b-toggle directive
  • optimize toggle directive code
  • new unit tests (multiple target testing)
  • docs update / examples update:
    • v-b-toggle
    • collapse
    • sidebar
    • b-navbar-toggle (to note that it can be used to control sidebars as well, and note that it uses v-b-toggle directive internally)

Future (separate PRs, after this PR is merged):

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 bot commented May 9, 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:

@tmorehouse tmorehouse added this to In progress in v2.14.0 via automation May 9, 2020
Copy link

codesandbox-ci bot commented May 9, 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 aa41484:

Sandbox Source
funny-chandrasekhar-97duz Configuration

Copy link

codecov bot commented May 9, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #5336   +/-   ##
  Coverage   100.00%   100.00%           
  Files          280       280           
  Lines         8793      8793           
  Branches      2509      2509           
  Hits          8793      8793           
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 aa41484...aa41484. Read the comment docs.

@tmorehouse tmorehouse marked this pull request as ready for review May 11, 2020
@tmorehouse tmorehouse merged commit 260ef72 into dev May 11, 2020
14 checks passed
v2.14.0 automation moved this from In progress to Done May 11, 2020
@tmorehouse tmorehouse deleted the feat-toggle-targets branch May 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
No open projects

Successfully merging this pull request may close these issues.

2 participants