Interface GlobalFilterOptions<Data>

Type interface for filtering options.

Type Parameters

Hierarchy

Properties - Custom Component

Component?

Properties - Other

autoResetGlobalFilter? defaultVisibleGlobalFilter? disableGlobalFilter? filterTypes? globalFilter? initialState? manualGlobalFilter? onStateChange?

Custom Component Properties

Optional Component

Component?: GlobalFilterComponent<Data>

Global filter component rendered for in table. This overrides the fallback text-input-field.

Other Properties

Optional autoResetGlobalFilter

autoResetGlobalFilter?: boolean

Reset filtering when data is changed.

Default

true

Optional defaultVisibleGlobalFilter

defaultVisibleGlobalFilter?: boolean

Should the Global Filter be visible by default.

Default

false

Optional disableGlobalFilter

disableGlobalFilter?: boolean

Disable global filtering for table.

Default

false

Optional filterTypes

filterTypes?: Record<string, FilterType<Data>>

Allows overriding or adding additional filter types. If "globalFilter" type isn't found on this object, it will default to using the built-in filter types. Must be memoised.

Optional globalFilter

globalFilter?: string | ((rows: Row<Data>[], columnIds: IdType<Data>[], globalFilterValue: string) => Row<Data>[])

Default

"text"

Optional initialState

initialState?: UseGlobalFiltersState<Data>

Initial settings of global filter.

Example

{ globalFilter: {} }

Optional manualGlobalFilter

manualGlobalFilter?: boolean

Manual filtering with custom logic, eg. server-side. Enables filter detection functionality, but does not automatically perform row filtering

Default

false

Optional onStateChange

onStateChange?: StateChangeHandler<UseGlobalFiltersState<Data>>

Callback executed when columns are sorted. The function must be wrapped in useCallback hook.

Settings

Member Visibility

Theme

Generated using TypeDoc