Added filterFields to Sorting

[Vanderslice]

Purpose: We want to be able to pass an object containing fields for filtering, like search terms, to the sort to allow for remote sorting to maintain those filters.

Concerns:

• Just wanted to get a quick pair of eyes on the changes
• Not sure if I should move this to the Column Manager's plugins
• Wanted to get another opinion on referring to these as filterFields vs filterParams

[codecov-io]

Codecov Report

❗ No coverage uploaded for pull request base (master@9e1b8f1). Click here to learn what that means.
The diff coverage is 70%.

@@            Coverage Diff            @@
##             master     #162   +/-   ##
=========================================
  Coverage          ?   76.87%           
=========================================
  Files             ?      112           
  Lines             ?     4558           
  Branches          ?      275           
=========================================
  Hits              ?     3504           
  Misses            ?      847           
  Partials          ?      207

Impacted Files	Coverage Δ
src/components/core/ColumnManager.js	94.93% <ø> (ø)
src/components/layout/FixedHeader.jsx	50.68% <ø> (ø)
src/actions/GridActions.js	76.7% <0%> (ø)
src/components/Grid.jsx	80.64% <100%> (ø)
src/components/layout/header/Column.jsx	79.41% <83.33%> (ø)

---

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 9e1b8f1...f8a26c8. Read the comment docs.

[bencripps]

Can you explain the use case a little more, and perhaps provide an example?

[Vanderslice]

Use Case: We have a search field that allows for filtering records in the grid and we want to maintain that filter when remote sorting. Unless I'm overlooking something, we currently don't have a way to pass along those extra values we want to be maintained to the the remoteSort so when you sort it returns the unfiltered data.

Our setup is:
Container
-Nav/Search
-Grid - React-Redux-Grid

1. When we search we're storing that as an object in the state which is used as a query string on our GETs.
2. When we remoteSort it doesn't have access to the search term
3. The GET is done without our search term as a query string

[bencripps]

Changeset looks good. 1 thing I'd like changed (see comment). I'd also like to see filterFields added to the readme. Would you mind adding that?

[bencripps]

This becomes a breaking change if filterFields is ordered before sortParams, whereas it's probably just a minor change if it comes second. Do you think it's OK if we keep the order as it was before, appending the new arg?

[Vanderslice]

Updated this to include group pageIndex and pageSize as a pagingParams object to match pager's setPageIndexAsync's pattern: dataSource({ pageIndex, pageSize }, filterFields, sortParams)

[Vanderslice]

This will have to be a breaking change to either doRemoteSort or setPageIndexAsync. I chose to change doRemote sort since it seems likely that doRemoteSort will have the smallest impact and the pattern for setPageIndexAsync seems more self explanatory.

[bencripps]

Changes look good, would you mind updating the docs?