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-table): add filter-debounce prop for debouncing filter updates #3891

merged 18 commits into from Aug 16, 2019


Copy link

@tmorehouse tmorehouse commented Aug 15, 2019

Describe the PR

For improving responsiveness of large tables when users have the filter criteria bound to an input, in which case the filter runs each keystroke.

User can specify a debounce timeout (in ms) via the filter-debounce prop. Defaults to 0 ms, which preserves existing behaviour.

Users can provide a value in ms for debouncing user input of the filter prop. which will delay the filter process after x ms of keystroke idle time has expired.

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)

Copy link

@codecov codecov bot commented Aug 15, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #3891      +/-   ##
+ Coverage   99.32%   99.33%   +<.01%     
  Files         233      233              
  Lines        4467     4484      +17     
  Branches     1262     1266       +4     
+ Hits         4437     4454      +17     
  Misses         24       24              
  Partials        6        6
Impacted Files Coverage Δ
src/components/table/helpers/mixin-filtering.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 4672cc2...0376663. Read the comment docs.

@tmorehouse tmorehouse marked this pull request as ready for review Aug 15, 2019
@tmorehouse tmorehouse changed the title feat(b-table): add filter-debounce prop for debouncing filter updates feat(b-table): add filter-debounce prop for debouncing filter updates Aug 15, 2019
@tmorehouse tmorehouse requested a review from jacobmllr95 Aug 15, 2019
@tmorehouse tmorehouse merged commit 03536a5 into dev Aug 16, 2019
8 of 9 checks passed
@tmorehouse tmorehouse deleted the tmorehouse/table-filter branch Aug 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet

Successfully merging this pull request may close these issues.

None yet

2 participants