Defined in: features/global-filtering/globalFilteringFeature.types.ts:32

TFeatures extends TableFeatures

TData extends RowData

optional enableGlobalFilter: boolean;

Defined in: features/global-filtering/globalFilteringFeature.types.ts:39

Enables/disables global filtering for all columns.

optional getColumnCanGlobalFilter: <TFeatures, TData, TValue>(column) => boolean;

Defined in: features/global-filtering/globalFilteringFeature.types.ts:44

If provided, this function will be called with the column and should return true or false to indicate whether this column should be used for global filtering. This is useful if the column can contain data that is not string or number (i.e. undefined).

TFeatures extends TableFeatures

TData extends RowData

TValue extends unknown = unknown

Column<TFeatures, TData, TValue>

boolean

optional globalFilterFn: FilterFnOption<TFeatures, TData>;

Defined in: features/global-filtering/globalFilteringFeature.types.ts:57

The filter function to use for global filtering.

• A string referencing a built-in filter function
• A string that references a custom filter functions provided via the tableOptions.filterFns option
• A custom filter function

optional onGlobalFilterChange: OnChangeFn<any>;

Defined in: features/global-filtering/globalFilteringFeature.types.ts:61

If provided, this function will be called with an updaterFn when state.globalFilter changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.