use/useFilter
Overview
Builds and manages reactive filter form state, mapping model fields to their appropriate filter widgets and providing the filter context to child components.
Methods
- filterFieldEntries - The form fields one filter renders: the filter itself, plus one boundary field per suffix when it is a range.
- getMissingFilterInputSupport - What the client lacks to render an editable input for a filter.
- useFilter - Resolves each filterable field's form component and widget from the already-resolved
filterables/filterableDetailsgiven via props, and provides the resulting state as theFilterModelSymbolcontext for descendant components (e.g.
Types
FilterFieldEntry
FilterInputOverrides
UseFilterRawOverridableProps
UseFilterStateRawState
UseFilterRawProps
UseFilterRawProps = UseFilterRawOverridableProps | ThemeRawProps
UseFilterState
UseFilterState = DeepReadonly
Source
client/lib/use/useFilter.js:1