Skip to content

useFilter ​

Overview ​

Resolves each filterable field's form component and widget from the already-resolved filterables/filterableDetails given via props, and provides the resulting state as the FilterModelSymbol context for descendant components (e.g. FilterFieldForm, FilterChip). Does not fetch, merge, or hold its own copy of the filterable field list or details — see useFilterables for that.

Signature ​

useFilter(props)

Parameters ​

NameTypeRequiredDescription
propsReactiveyesThe reactive arguments.

Returns ​

The reactive state.

Source ​

client/lib/use/useFilter.js:212