FilterFnDef | TanStack Table Docs

Defined in: features/column-filtering/columnFilteringFeature.types.ts:102

The definition object accepted by constructFilterFn.

filter is a value-level comparator: it receives the row's (resolved) data value and the (resolved) filter value instead of the whole row, so normalization concerns stay in resolveDataValue/resolveFilterValue.

Extended by

CreatedFilterFn

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

autoRemove?

optional autoRemove?: (filterValue) => boolean;

optional autoRemove?: (filterValue) => boolean;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:113

Parameters

filterValue

any

Returns

boolean

filter

filter: (dataValue, filterValue, row, columnId, addMeta?) => boolean;

filter: (dataValue, filterValue, row, columnId, addMeta?) => boolean;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:106

Parameters

dataValue

any

filterValue

any

row

Row<TFeatures, TData>

columnId

string

addMeta?

(meta) => void

Returns

boolean

resolveDataValue?

optional resolveDataValue?: TransformDataValueFn;

optional resolveDataValue?: TransformDataValueFn;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:115

resolveFilterValue?

optional resolveFilterValue?: (filterValue) => any;

optional resolveFilterValue?: (filterValue) => any;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:114

Parameters

filterValue

any

Returns

any