useFilterSelect
useFilterSelect(
rule):object
Defined in: filter/src/hooks/use-filter-select.ts:35
Parameters
Section titled “Parameters”Returns
Section titled “Returns”fieldOptions
Section titled “fieldOptions”fieldOptions:
object[]
filterableFields
Section titled “filterableFields”filterableFields:
FilterField[]
filterOptions
Section titled “filterOptions”filterOptions:
object[] |undefined
selectedField
Section titled “selectedField”selectedField:
FilterField|undefined
selectedFilter
Section titled “selectedFilter”selectedFilter:
StandardFnSchema|undefined
setField
Section titled “setField”setField: (
newField,__namedParameters) =>void
Parameters
Section titled “Parameters”newField
Section titled “newField”__namedParameters?
Section titled “__namedParameters?”UpdateFieldOptions = {}
Returns
Section titled “Returns”void
setFilter
Section titled “setFilter”setFilter: (
filterSchema,__namedParameters) =>void
Parameters
Section titled “Parameters”filterSchema
Section titled “filterSchema”__namedParameters?
Section titled “__namedParameters?”UpdateFilterOptions = {}
Returns
Section titled “Returns”void
updateField
Section titled “updateField”updateField: (
newField,__namedParameters) =>void
Parameters
Section titled “Parameters”newField
Section titled “newField”__namedParameters?
Section titled “__namedParameters?”UpdateFieldOptions = {}
Returns
Section titled “Returns”void
updateFilter
Section titled “updateFilter”updateFilter: (
filterSchema,__namedParameters) =>void
Parameters
Section titled “Parameters”filterSchema
Section titled “filterSchema”__namedParameters?
Section titled “__namedParameters?”UpdateFilterOptions = {}
Returns
Section titled “Returns”void