SelectedFilters
creates a selectable filter UI view displaying the current selected values from other components. This component is useful for improving selection accessibility of other components.
Example uses:
- displaying all the user selected facet filters together in the main view area for better accessibility.
- building mobile responsive views where it is not practical to show all the UI components in the main view.
Usage
Basic Usage
<SelectedFilters />
Usage with All Props
<SelectedFilters showClearAll={true} clearAllLabel="Clear filters" />
Props
-
showClearAll
enum
('never', 'always', 'default', true, false)
[optional] (defaults totrue
). It behaves according to the following scenarios:never
: Clear All button is never shown.always
: Clear All button is shown based on values set by components.default
: Clear All button is shown for components which have selected values andshowFilter={true}
true
: Identical behavior toalways
.false
: Identical behavior tonever
.
Note: showFilter prop doesn't affect Clear All behavior when showClearAll="always".
-
clearAllLabel
string
[optional] (defaults to'Clear All'
) Sets the label for the clear all button. -
onChange
function
[optional] Provides access to the current selected values. This enables you to retrieve the selected filters and current search state in a convenient way. -
onClear
function
[optional] a callback function which will be called when a particular filter(value) has been removed from the selected filters, provides thecomponent
andvalue
.
Example:
<SelectedFilters
onClear={(component, value) => {
console.log(`${component} has been removed with value as ${value}`);
}}
/>
-
resetToDefault
boolean
[optional] When set to true and clearAll functionality is utilised, then it would set the filter's value to its default set value(thedefaultValue
prop) instead of null/ undefined. Defaults tofalse
. -
resetToValues
Object
[optional] It is a map ofcomponentId
to the component's value which would be used to set the component's value whenclearAll
action gets called. For example, the following configuration would reset theAuthorFilter
toNora Roberts
onclearAll
action.
<SelectedFilters
resetToValues={{
AuthorFilter: ['Nora Roberts']
}}
/>
-
clearAllBlacklistComponents
Array
[optional] allows defining a list of component IDs, which would reset their values whenclearAll
action gets triggered.The following example instructs the
SelectedFilters
component to not reset thesearchbox
component's value whenclearAll
button is clicked by the user.
<SelectedFilters
clearAllBlacklistComponents={['searchbox']}
/>
Note: The
clearAllBlacklistComponents
prop has priority overresetToValues
andresetToDefault
props which means component would retain its current value and would ignore the values defined inresetToValues
map ordefaultValue
prop.
Most ReactiveSearch filter components have a prop showFilter
(defaults to true
) which can be used to control whether the component's selected state appears in the SelectedFilters component. There is also a filterLabel
prop which controls how that component is displayed.
Note
The
showFilter
andfilterLabel
prop updates are only reflected if the underlying query of the associated component has changed.
As an example, check MultiList usage to see how showFilter
and filterLabel
can be used.
Demo
Styles
SelectedFilters
component supports innerClass
prop with the following keys:
button
Read more about it here.
Extending
SelectedFilters
component can be extended to customize the look and feel with className
, style
.
<SelectedFilters className="custom-class" style={{ paddingBottom: '10px' }} />
- className
String
CSS class to be injected on the component container. - style
Object
CSS styles to be applied to the SelectedFilters component. - render
Function
Enables custom rendering for SelectedFilters component. It provides an object as a param which contains all the props needed to render the custom selected-filters, including the functions to clear and update the component values. Check the usage here.
Examples
SelectedFilters work with most ReactiveSearch components. See more stories for SelectedFilters with a SingleList on playground.