Skip to content

feat(b-table): allow users to specify top-level keys to be ignored or included when filtering, + option to filter based on formatted value (closes #3749) #3786

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

Merged
merged 43 commits into from
Jul 30, 2019

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Jul 30, 2019

Describe the PR

Adds a new prop filter-ignored-fields, which accepts an array of top-level fields that should be ignored when filtering the rows.

Adds a new prop filter-included-fields, which accepts and array of top-level fields that filtering should be restricted to.

Adds option on a per field basis to filter by result of field's formatter function

All three new features are only applicable to built in filtering.

Closes #3749

To Do:

  • add filter ignore
  • add filter included
  • add support for filtering by formatted value
  • update docs
  • update complete example to filter and sort by formatted value, and selective filtering

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
Copy link

codecov bot commented Jul 30, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #3786      +/-   ##
==========================================
+ Coverage   99.29%   99.29%   +<.01%     
==========================================
  Files         223      224       +1     
  Lines        4385     4391       +6     
  Branches     1238     1244       +6     
==========================================
+ Hits         4354     4360       +6     
  Misses         25       25              
  Partials        6        6
Impacted Files Coverage Δ
src/components/table/helpers/sanitize-row.js 100% <100%> (ø) ⬆️
src/components/table/helpers/mixin-filtering.js 100% <100%> (ø) ⬆️
src/components/table/helpers/mixin-items.js 100% <100%> (ø) ⬆️
...omponents/table/helpers/stringify-record-values.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 bcb132e...b368e60. Read the comment docs.

@tmorehouse tmorehouse changed the title feat(b-table): allow users to specify top-level keys to be ignored (closes #3749) feat(b-table): allow users to specify top-level keys to be ignored when filtering (closes #3749) Jul 30, 2019
@tmorehouse tmorehouse changed the title feat(b-table): allow users to specify top-level keys to be ignored when filtering (closes #3749) feat(b-table): allow users to specify top-level keys to be ignored or included when filtering (closes #3749) Jul 30, 2019
@tmorehouse tmorehouse changed the title feat(b-table): allow users to specify top-level keys to be ignored or included when filtering (closes #3749) feat(b-table): allow users to specify top-level keys to be ignored or included when filtering, and option to filter based on formatted value (closes #3749) Jul 30, 2019
@tmorehouse tmorehouse changed the title feat(b-table): allow users to specify top-level keys to be ignored or included when filtering, and option to filter based on formatted value (closes #3749) feat(b-table): allow users to specify top-level keys to be ignored or included when filtering, + option to filter based on formatted value (closes #3749) Jul 30, 2019
@tmorehouse tmorehouse requested a review from jacobmllr95 July 30, 2019 19:20
@tmorehouse tmorehouse marked this pull request as ready for review July 30, 2019 20:09
@tmorehouse tmorehouse merged commit 142b31b into dev Jul 30, 2019
@tmorehouse tmorehouse deleted the tmorehouse/table-filter branch July 30, 2019 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow b-table internal filtering to ignore specific keys in an item
2 participants