Skip to content

useFilterSelect

useFilterSelect(rule): object

Defined in: filter/src/hooks/use-filter-select.ts:35

Parameters

rule

SingleFilter

Returns

object

fieldOptions

fieldOptions: object[]

filterableFields

filterableFields: FilterField[]

filterOptions

filterOptions: undefined | object[]

selectedField

selectedField: undefined | FilterField

selectedFilter

selectedFilter: undefined | StandardFnSchema

setField()

setField: (newField, __namedParameters) => void

Parameters

newField

FilterField

__namedParameters

UpdateFieldOptions = {}

Returns

void

setFilter()

setFilter: (filterSchema, __namedParameters) => void

Parameters

filterSchema

StandardFnSchema

__namedParameters

UpdateFilterOptions = {}

Returns

void

updateField()

updateField: (newField, __namedParameters) => void

Parameters

newField

FilterField

__namedParameters

UpdateFieldOptions = {}

Returns

void

updateFilter()

updateFilter: (filterSchema, __namedParameters) => void

Parameters

filterSchema

StandardFnSchema

__namedParameters

UpdateFilterOptions = {}

Returns

void