SingleList
creates a single selection based list UI component that is connected to a database field.
Example uses:
- select a category item from a list of categories in an e-commerce website.
- select a cuisine item from a list of cuisine items in a food delivery app.
Usage
Basic Usage
<SingleList componentId="CitySensor" dataField="group.group_city.raw" title="Cities" />
Usage With All Props
<SingleList
componentId="CitySensor"
dataField="group.group_city.raw"
title="Cities"
size={100}
sortBy="count"
defaultValue="London"
selectAllLabel="All Cities"
showRadio={true}
showCount={true}
showSearch={true}
placeholder="Search City"
react={{
and: ['CategoryFilter', 'SearchFilter'],
}}
showFilter={true}
filterLabel="City"
URLParams={false}
loader="Loading ..."
/>
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. The list items are filtered by a database query on this field. This field is used for doing an aggregation and returns the result. We're using a
.raw
multifield here. You can use a field of typekeyword
ornot_analyzed
depending on your Elasticsearch cluster. -
nestedField
String
[optional]use to set the
nested
mapping field that allows arrays of objects to be indexed in a way that they can be queried independently of each other. Applicable only when dataField is a part ofnested
type. -
title
String or JSX
[optional]title of the component to be shown in the UI.
-
loader
String or JSX
[optional]to display an optional loader while fetching the options.
-
size
Number
[optional] number of list items to be displayed.Note:
- Appbase users should use the
aggregationSize
prop instead. Thesize
prop would only set the size forhits
not theaggregations
. - We recommend Appbase users to not use the
size
prop unless they are usinghits
because it can impact the query performance.
- Appbase users should use the
-
aggregationSize To set the number of buckets to be returned by aggregations.
Note: This prop is only applicable when
enableAppbase
is set totrue
. -
sortBy
String
[optional]sort the list items by one of
count
,asc
,desc
. Defaults tocount
, which sorts the list by the frequency of count value, most first. -
defaultValue
string
[optional]selects an initial item from the list on mount.
-
value
string
[optional]controls the current value of the component. It selects the item from the list (on mount and on update). Use this prop in conjunction with
onChange
function. -
selectAllLabel
String
[optional]add an extra
Select all
item to the list with the provided label string. -
showRadio
Boolean
[optional]show radio button icon for each list item. Defaults to
true
. -
showCount
Boolean
[optional]show count value of the number of occurences besides a list item. Defaults to
true
. -
transformData
Function
[optional]allows transforming the data to render inside the list. You can change the order, remove, or add items, transform their values with this method. It provides the data as param which is an array of objects of shape
{ key: <string>, doc_count: <number> }
and expects you to return the array of objects of same shape. For example:
transformData={(list) => {
// sort or update the list
return list;
}}
-
showMissing
Boolean
[optional]defaults to
false
. When set totrue
it also retrives the aggregations for missing fields under the label specified bymissingLabel
. -
missingLabel
String
[optional]defaults to
N/A
. Specify a custom label to show whenshowMissing
is set totrue
. -
showSearch
Boolean
[optional]whether to show a searchbox to filter the list items locally. Defaults to
true
. -
placeholder
String
[optional]placeholder to be displayed in the searchbox, only applicable when the
showSearch
prop is set to true. When applicable, the default placeholder value is set to "Search". -
showFilter
Boolean
[optional]show as filter when a value is selected in a global selected filters view. Defaults to
true
. -
filterLabel
String
[optional]An optional label to display for the component in the global selected filters view. This is only applicable if
showFilter
is enabled. Default value used here iscomponentId
. -
URLParams
Boolean
[optional]enable creating a URL query string parameter based on the selected value of the list. This is useful for sharing URLs with the component state. Defaults to
false
. -
showLoadMore
Boolean
[optional]defaults to
false
and works only with elasticsearch >= 6 since it uses composite aggregations. This adds a "Load More" button to load the aggs on demand combined with thesize
prop. Composite aggregations are in beta and this is an experimental API which might change in a future release.Note:
Composite aggregations do not support sorting by
count
. Hence withshowLoadMore
, you can only sort by:asc
ordesc
order.sortBy
prop defaults toasc
whenshowLoadMore
prop is used. -
renderItem
Function
[optional]customize the rendered list via a function which receives the item label, count & isSelected and expects a JSX or String back. For example:
renderItem={(label, count, isSelected) => ( <div> {label} <span style={{ marginLeft: 5, color: isSelected ? 'red' : 'dodgerblue' }}> {count} </span> </div> )}
-
render
Function
[optional]an alternative callback function to
renderItem
, where user can define how to render the view based on all the data changes.
It accepts an object with these properties:loading
:boolean
indicates that the query is still in progresserror
:object
An object containing the error infodata
:array
An array of results obtained from the applied query.rawData
object
An object of raw response as-is from elasticsearch query.value
:string
current selected value.handleChange
:function
A callback function can be used to mark the list value as selected.
<SingleList
render={({ loading, error, data, handleChange }) => {
if (loading) {
return <div>Fetching Results.</div>;
}
if (error) {
return <div>Something went wrong! Error details {JSON.stringify(error)}</div>;
}
return (
<ul>
{data.map(item => (
<li>
<input type="radio" value={item.key} onChange={handleChange} />
{item.key}-{item.count}
</li>
))}
</ul>
);
}}
/>
Or you can also use render function as children
<SingleList>
{
({
loading,
error,
data,
value,
handleChange,
}) => (
// return UI to be rendered
)
}
</SingleList>
-
renderError
String or JSX or Function
[optional] can be used to render an error message in case of any error.renderError={(error) => ( <div> Something went wrong!<br/>Error details<br/>{error} </div> ) }
-
renderNoResults
Function
[optional] can be used to render a message in case of no list items.renderNoResults={() => <p>No Results Found!</p>}
-
onChange
function
[optional] is a callback function which accepts component's current value as a parameter. It is called when you are using thevalue
props and the component's value changes. This prop is used to implement the controlled component behavior. -
onError
Function
[optional] gets triggered in case of an error and provides theerror
object, which can be used for debugging or giving feedback to the user if needed. -
index
String
[optional] The index prop can be used to explicitly specify an index to query against for this component. It is suitable for use-cases where you want to fetch results from more than one index in a single ReactiveSearch API request. The default value for the index is set to theapp
prop defined in the ReactiveBase component.Note: This only works when
enableAppbase
prop is set to true inReactiveBase
. -
enableStrictSelection
Boolean
[optional] When set totrue
, a selected option can't be unselected. Although, it is possible to change the selected option. Defaults tofalse
.
Demo
Styles
SingleList
component supports innerClass
prop with the following keys:
title
input
list
radio
label
count
Read more about it here.
Extending
SingleList
component can be extended to
- customize the look and feel with
className
,style
, - update the underlying DB query with
customQuery
,defaultQuery
, - connect with external interfaces using
beforeValueChange
,onValueChange
andonQueryChange
, - specify how options should be filtered or updated using
react
prop.
<SingleList
...
className="custom-class"
style={{"paddingBottom": "10px"}}
customQuery={
function(value, props) {
return {
query: {
match: {
data_field: "this is a test"
}
}
}
}
}
defaultQuery={
function(value, props) {
return {
timeout: "1s"
}
}
}
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);
}
}
// specify how and which options are filtered using `react` prop.
react={
"and": ["pricingFilter", "dateFilter"],
"or": ["searchFilter"]
}
/>
-
className
String
CSS class to be injected on the component container. -
style
Object
CSS styles to be applied to the SingleList component. -
customQuery
Function
is a callback function which accepts component's current value as a parameter 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 SingleList component as long as the component is a part ofreact
dependency of at least one other component. -
defaultQuery
Function
takes value and props as parameters and returns the data query to be applied to the source component, as defined in Elasticsearch Query DSL, which doesn't get leaked to other components. Read more about it here. -
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.Note:
If you're using Reactivesearch version >=
3.3.7
,beforeValueChange
can also be defined as a synchronous function.value
is updated by default, unless you throw anError
to reject the update. For example:beforeValueChange = value => { // The update is accepted by default if (value === 'In Death') { // To reject the update, throw an error throw Error('Selected value should not be equal to In Death.'); } };
-
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 list item is selected in a "Discounted Price" SingleList. -
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. -
react
Object
specify dependent components to reactively update SingleList's options.- key
String
one ofand
,or
,not
defines the combining clause.- and clause implies that the results will be filtered by matches from all of the associated component states.
- or clause implies that the results will be filtered by matches from at least one of the associated component states.
- not clause implies that the results will be filtered by an inverse match of the associated component states.
- value
String or Array or Object
String
is used for specifying a single component by itscomponentId
.Array
is used for specifying multiple components by theircomponentId
.Object
is used for nesting other key clauses.
- key