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-form-input, b-form-textarea): add `v-model` debouncing feature, and deprecate `<b-table>` prop `filter-debounce` (closes #4150) #4314

Merged
merged 23 commits into from Oct 30, 2019

Conversation

@tmorehouse
Copy link
Member

tmorehouse commented Oct 29, 2019

Describe the PR

Adds a new prop debounce that will allow users to specify a debounce timeout for updating the v-model.

Internally debounces the v-model update event. Note change/blur events will immediately update the v-model.

If prop lazy is set, then no debouncing is used.

Defaults to no debouncing (0 ms)

Addresses #4150 as a preferred way of debouncing table filter criteria

Probably closes #4288 for similar reasons

To Do:

  • unit testing
  • b-form-input documentation update
  • b-form-textarea documentation update
  • table documentation update, recommending users use the debounce feature of b-form-input
  • deprecate filter-debounce prop in <b-table>
  • package prop meta update

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 29, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #4314      +/-   ##
==========================================
+ Coverage   99.91%   99.91%   +<.01%     
==========================================
  Files         237      237              
  Lines        4560     4575      +15     
  Branches     1282     1284       +2     
==========================================
+ Hits         4556     4571      +15     
  Misses          3        3              
  Partials        1        1
Impacted Files Coverage Δ
src/mixins/form-text.js 100% <100%> (ø) ⬆️
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 8740210...ed0f3a5. Read the comment docs.

tmorehouse added 6 commits Oct 29, 2019
tmorehouse added 6 commits Oct 29, 2019
@tmorehouse tmorehouse changed the title feat(b-form-input, b-form-textarea): add `v-model` debouncing feature feat(b-form-input, b-form-textarea): add `v-model` debouncing feature, deprecate `<b-table>`'s `filter-debounce` Oct 29, 2019
@tmorehouse tmorehouse changed the title feat(b-form-input, b-form-textarea): add `v-model` debouncing feature, deprecate `<b-table>`'s `filter-debounce` feat(b-form-input, b-form-textarea): add `v-model` debouncing feature, deprecate `<b-table>`'s `filter-debounce` (closes #4150) Oct 29, 2019
@tmorehouse tmorehouse requested a review from jackmu95 Oct 29, 2019
@tmorehouse tmorehouse marked this pull request as ready for review Oct 29, 2019
tmorehouse added 4 commits Oct 29, 2019
@tmorehouse tmorehouse removed the Status: WIP label Oct 29, 2019
@tmorehouse tmorehouse added this to In progress in 2.1.0 via automation Oct 29, 2019
tmorehouse and others added 3 commits Oct 29, 2019
@tmorehouse tmorehouse changed the title feat(b-form-input, b-form-textarea): add `v-model` debouncing feature, deprecate `<b-table>`'s `filter-debounce` (closes #4150) feat(b-form-input, b-form-textarea): add `v-model` debouncing feature, and deprecate `<b-table>`'s `filter-debounce` (closes #4150) Oct 30, 2019
@tmorehouse tmorehouse changed the title feat(b-form-input, b-form-textarea): add `v-model` debouncing feature, and deprecate `<b-table>`'s `filter-debounce` (closes #4150) feat(b-form-input, b-form-textarea): add `v-model` debouncing feature, and deprecate `<b-table>` prop `filter-debounce` (closes #4150) Oct 30, 2019
@tmorehouse tmorehouse merged commit 3ecdfa2 into dev Oct 30, 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 8740210
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 30, 2019
@tmorehouse tmorehouse deleted the tmorehouse/input-debounce branch Oct 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2.1.0
  
Done
2 participants
You can’t perform that action at this time.