Function: shouldAutoRemoveFilter()#

function shouldAutoRemoveFilter<TFeatures, TData, TValue>(
   filterFn?, 
   value?, 
   column?): boolean;

function shouldAutoRemoveFilter<TFeatures, TData, TValue>(
   filterFn?, 
   value?, 
   column?): boolean;

Defined in: features/column-filtering/columnFilteringFeature.utils.ts:315

Returns whether a filter value should be removed from filter state.

This checks the filter function's autoRemove hook and built-in empty-value rules.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

filterFn?#

FilterFn<TFeatures, TData>

value?#

any

column?#

Column_Internal<TFeatures, TData, TValue>

Returns#

boolean

Example#

const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)

const removeFilter = shouldAutoRemoveFilter(filterFn, value, column)