Row API Reference

createFilteredRowModel

Function: createFilteredRowModel()

ts
function createFilteredRowModel<TFeatures, TData>(): (table) => () => RowModel<TFeatures, TData>;

Defined in: features/column-filtering/createFilteredRowModel.ts:32

Creates a memoized filtered row model factory.

The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.

Register the filter functions you use with the filterFns slot on the features option: tableFeatures({ columnFilteringFeature, filteredRowModel: createFilteredRowModel(), filterFns: { includesString: filterFn_includesString } }). Importing individual filterFn_* functions keeps unused built-ins out of your bundle; filter functions passed directly to the filterFn column option need no registration at all.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData = any

Returns

ts
(table): () => RowModel<TFeatures, TData>;

Parameters

table

Table<TFeatures, TData>

Returns

ts
(): RowModel<TFeatures, TData>;

Returns

RowModel<TFeatures, TData>