Skip to content

feat(b-table): make sorting by formated value opt-in per field + add TypeScript declarations for locale options #3778

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 19 commits into from
Jul 30, 2019

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented Jul 29, 2019

Describe the PR

Makes sorting by formatted value opt-in_ on a per-field basis, by adding a new field property sortByFormatted. Defaults to false. If true, then internal sorting will use the result of the field's formatter (if provided) for sorting.

This change is based on user feedback regarding the ability to sort virtual columns, and regular columns, and the preference to optionally enable this feature (i.e., opt-in).

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) Behavioural change versus versions 2.0.0-rc.25 to 2.0.0-rc.27

Sorting by formatted value was introduced in v2.0.0-rc.25, but it was not opt-in. This PR makes sorting by formatted value opt-in, which is the opposite in version 2.0.0-rc.25 to .27.

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

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #3778      +/-   ##
==========================================
+ Coverage   99.29%   99.29%   +<.01%     
==========================================
  Files         223      223              
  Lines        4384     4385       +1     
  Branches     1237     1238       +1     
==========================================
+ Hits         4353     4354       +1     
  Misses         25       25              
  Partials        6        6
Impacted Files Coverage Δ
src/components/table/helpers/mixin-sorting.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 6432f22...3a027dc. Read the comment docs.

@tmorehouse tmorehouse changed the title feat(b-table): make sorting by formated value opt-in per field feat(b-table): make sorting by formated value opt-in per field + add TypeScript declarations for locale options Jul 30, 2019
@tmorehouse tmorehouse marked this pull request as ready for review July 30, 2019 03:43
@tmorehouse tmorehouse requested a review from jacobmllr95 July 30, 2019 04:04
@tmorehouse tmorehouse merged commit 9716850 into dev Jul 30, 2019
@tmorehouse tmorehouse deleted the tmorehouse/table-sort branch July 30, 2019 13:52
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.

2 participants