MultiDropdownRange
creates a multiple selection dropdown based numeric range UI component.
Example uses:
- filtering search results by prices in an e-commerce or food delivery experience.
- browsing movies by a ratings filter.
Usage
Basic Usage
<MultiDropdownRange
componentId="PriceSensor"
dataField="price"
data={[
{ start: 0, end: 10, label: 'Cheap' },
{ start: 11, end: 20, label: 'Moderate' },
{ start: 21, end: 50, label: 'Pricey' },
{ start: 51, end: 1000, label: 'First Date' },
]}
/>
Usage With All Props
<MultiDropdownRange
componentId="PriceSensor"
dataField="price"
data={[
{ start: 0, end: 10, label: 'Cheap' },
{ start: 11, end: 20, label: 'Moderate' },
{ start: 21, end: 50, label: 'Pricey' },
{ start: 51, end: 1000, label: 'First Date' },
]}
defaultSelected={['Cheap']}
placeholder="Select price range"
showFilter={true}
filterLabel="Price"
/>
Props
- componentId
String
unique identifier of the component, can be referenced in other components'react
prop. - dataField
String
data field to be connected to the component's UI view. - data
Object Array
collection of UIlabels
with associatedstart
andend
range values. - defaultSelected
String Array
[optional] pre-select a label from thedata
array. - placeholder
String
[optional] placeholder to be displayed in the dropdown searchbox. Defaults to "Select a value". - showFilter
Boolean
[optional] show as filter when a value is selected in a global selected filters view. Defaults totrue
. - filterLabel
String
[optional] An optional label to display for the component in the global selected filters view. This is only applicable ifshowFilter
is enabled. Default value used here iscomponentId
. - innerProps
Object
[optional] specifies additional props for the internal components. Accepts an object with the specified keys. Read more about the usage here
Key |
Explanation |
---|---|
icon |
Icon component from native-base |
checkbox |
CheckBox component from native-base |
button |
Button component from native-base |
header |
Header component from native-base |
title |
Title component from native-base |
text |
Text component from react-native |
modal |
Modal component from react-native |
listView |
ListView component from react-native |
Demo
Styles
MultiDropdownRange
component supports style
prop. Read more about it here.
It also supports an innerStyle
prop with the following keys:
label
left
button
icon
right
body
title
checkbox
Read more about it here
Extending
MultiDropdownRange
component can be extended to
- customize the look and feel with
style
, - update the underlying DB query with
customQuery
, - connect with external interfaces using
beforeValueChange
,onValueChange
andonQueryChange
<MultiDropdownRange
...
style={{ paddingBottom: 10 }}
customQuery={
function(value, props) {
return {
match: {
data_field: "this is a test"
}
}
}
}
beforeValueChange={
function(value) {
// called before the value is set
// returns a promise
return new Promise((resolve, reject) => {
// update state or component props
resolve()
// or reject()
})
}
}
onValueChange={
function(value) {
console.log("current value: ", value)
// set the state
// use the value with other js code
}
}
onQueryChange={
function(prevQuery, nextQuery) {
// use the query with other js code
console.log('prevQuery', prevQuery);
console.log('nextQuery', nextQuery);
}
}
/>
- style
Object
CSS styles to be applied to the MultiDropdownRange component. - customQuery
Function
takes value and props as parameters and returns the data query to be applied to the component, as defined in Elasticsearch Query DSL.Note:
customQuery is called on value changes in the MultiDropdownRange component as long as the component is a part ofreact
dependency of at least one other component. - beforeValueChange
Function
is a callback function which accepts component's future value as a parameter and returns a promise. It is called everytime before a component's value changes. The promise, if and when resolved, triggers the execution of the component's query and if rejected, kills the query execution. This method can act as a gatekeeper for query execution, since it only executes the query after the provided promise has been resolved. - onValueChange
Function
is a callback function which accepts component's current value as a parameter. It is called everytime the component's value changes. This prop is handy in cases where you want to generate a side-effect on value selection. For example: You want to show a pop-up modal with the valid discount coupon code when a user searches for something in the MultiDropdownRange. - onQueryChange
Function
is a callback function which accepts component's prevQuery and nextQuery as parameters. It is called everytime the component's query changes. This prop is handy in cases where you want to generate a side-effect whenever the component's query would change.