-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Mike Murray <hellomikemurray@gmail.com>
- Loading branch information
1 parent
8228b90
commit 3487b62
Showing
1 changed file
with
130 additions
and
0 deletions.
There are no files selected for viewing
130 changes: 130 additions & 0 deletions
130
package/src/components/DataTable/helpers/useDataTableManualFilter.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
/** | ||
* useDataTableManualFilter hook | ||
* Based on the `useFilters` hook from react-table https://github.com/tannerlinsley/react-table/blob/master/src/plugin-hooks/useFilters.js | ||
* This hook provides a methods for setting a set of manual filters, that aren't restricted by columns | ||
*/ | ||
import { | ||
actions, | ||
useMountedLayoutEffect, | ||
functionalUpdate, | ||
useGetLatest | ||
} from "react-table"; | ||
|
||
// Actions | ||
actions.resetManualFilters = "resetManualFilters"; | ||
actions.setManualFilters = "setManualFilters"; | ||
actions.setAllManualFilters = "setAllManualFilters"; | ||
|
||
const useManualFilters = (hooks) => { | ||
hooks.stateReducers.push(reducer); | ||
hooks.useInstance.push(useInstance); | ||
}; | ||
|
||
useManualFilters.pluginName = "useManualFilters"; | ||
|
||
/** | ||
* State reducer | ||
* @param {Object} state State | ||
* @param {String} action Action name | ||
* @param {Object} previousState Previous state object | ||
* @param {Object} instance Table instance | ||
* @returns {Object} New state | ||
*/ | ||
function reducer(state, action, previousState, instance) { | ||
if (action.type === actions.init) { | ||
return { | ||
manualFilters: [], | ||
...state | ||
}; | ||
} | ||
|
||
if (action.type === actions.resetManualFilters) { | ||
return { | ||
...state, | ||
manualFilters: instance.initialState.manualFilters || [] | ||
}; | ||
} | ||
|
||
if (action.type === actions.setManualFilters) { | ||
const { manualFilterId, manualFilterValue } = action; | ||
|
||
const previousManualFilter = state.manualFilters.find((filter) => filter.id === manualFilterId); | ||
|
||
const newManualFilterValue = functionalUpdate( | ||
manualFilterValue, | ||
previousManualFilter && previousManualFilter.value | ||
); | ||
|
||
if (previousManualFilter) { | ||
return { | ||
...state, | ||
manualFilters: state.manualFilters.map((filter) => { | ||
if (filter.id === manualFilterId) { | ||
return { id: manualFilterId, value: newManualFilterValue }; | ||
} | ||
return filter; | ||
}).filter(({ value }) => ( | ||
typeof value !== "undefined" && value !== null | ||
)) | ||
}; | ||
} | ||
|
||
return { | ||
...state, | ||
manualFilters: [...state.manualFilters, { id: manualFilterId, value: newManualFilterValue }] | ||
}; | ||
} | ||
|
||
if (action.type === actions.setAllManualFilters) { | ||
const { manualFilters } = action; | ||
|
||
return { | ||
...state, | ||
manualFilters: functionalUpdate(manualFilters, state.manualFilters).filter(({ value }) => ( | ||
typeof value !== "undefined" && value !== null | ||
)) | ||
}; | ||
} | ||
|
||
return state; | ||
} | ||
|
||
/** | ||
* | ||
* @param {Object} instance Table instance | ||
* @returns {undefined} No return value | ||
*/ | ||
function useInstance(instance) { | ||
const { | ||
data, | ||
manualFilters, | ||
dispatch, | ||
autoResetManualFilters = true | ||
} = instance; | ||
|
||
const setManualFilters = (manualFilterId, manualFilterValue) => { | ||
dispatch({ type: actions.setManualFilters, manualFilterId, manualFilterValue }); | ||
}; | ||
|
||
const setAllManualFilters = (manualFiltersParam) => { | ||
dispatch({ | ||
type: actions.setAllManualFilters, | ||
manualFilters: manualFiltersParam | ||
}); | ||
}; | ||
|
||
const getAutoResetManualFilters = useGetLatest(autoResetManualFilters); | ||
|
||
useMountedLayoutEffect(() => { | ||
if (getAutoResetManualFilters()) { | ||
dispatch({ type: actions.resetManualFilters }); | ||
} | ||
}, [dispatch, manualFilters ? null : data]); | ||
|
||
Object.assign(instance, { | ||
setManualFilters, | ||
setAllManualFilters | ||
}); | ||
} | ||
|
||
export default useManualFilters; |