AdapTable Types Reference

QuickSearchOptions

Options for configuring Quick Search

TypeScript
export interface

Properties

PropertyDescriptionDefault
clearQuickSearchOnStartUpClears saved searches when AdapTable loadsfalse
filterGridAfterQuickSearchFilters Grid after quick search so only matching rows are displayedfalse
getCellSearchTextAllows a different value to be used for a cell when searching (instead of its raw value)
isCellSearchableDetermines whether Quick Search should be applied to a given cell
isQuickSearchCaseSensitiveRun Quick Search using Case Sensitivityfalse
quickSearchPlaceholderValue to use as placeholder in QuickSearch controls (e.g. in Dashboard)'Search'

Property Details

clearQuickSearchOnStartUp

Clears saved searches when AdapTable loads

TypeScript
clearQuickSearchOnStartUp?: boolean;
Default Value

false

Property Value

boolean

filterGridAfterQuickSearch

Filters Grid after quick search so only matching rows are displayed

TypeScript
filterGridAfterQuickSearch?: boolean;
Default Value

false

Property Value

boolean

getCellSearchText

Allows a different value to be used for a cell when searching (instead of its raw value)

TypeScript
getCellSearchText?: (quickSearchContext: QuickSearchContext) => string | null;
Property Value

(quickSearchContext:QuickSearchContext) => string | null

isCellSearchable

Determines whether Quick Search should be applied to a given cell

TypeScript
isCellSearchable?: (quickSearchContext: QuickSearchContext) => boolean;
Property Value

(quickSearchContext:QuickSearchContext) => boolean

isQuickSearchCaseSensitive

Run Quick Search using Case Sensitivity

TypeScript
isQuickSearchCaseSensitive?: boolean;
Default Value

false

Property Value

boolean

quickSearchPlaceholder

Value to use as placeholder in QuickSearch controls (e.g. in Dashboard)

TypeScript
quickSearchPlaceholder?: string;
Default Value

'Search'

Property Value

string

PreviousQuickSearchContextNextQuickSearchState