MultiList
creates a multiple selection based list UI component that is connected to a database field. It is similar to a SingleList except it can support multiple item selections.
Example uses:
- select category items from a list of categories in an e-commerce website.
- selecting airlines to fly by in a flight booking experience.
Usage
Basic Usage
<template>
<multi-list componentId="CitySensor" dataField="group.group_city.raw" title="Cities" />
</template>
Usage With All Props
<template>
<multi-list
componentId="CitySensor"
dataField="group_city.raw"
title="Cities"
sortBy="asc"
queryFormat="or"
selectAllLabel="All Cities"
placeholder="Search City"
filterLabel="City"
:showFilter="true"
:showCheckbox="true"
:showCount="true"
:showSearch="true"
:defaultValue="['San Francisco']"
:react="{ and: ['CategoryFilter', 'SearchFilter'] }"
:size="100"
:URLParams="false"
:endpoint="{
url:'https://appbase-demo-ansible-abxiydt-arc.searchbase.io/recipes-demo/_reactivesearch.v3',
headers: {
// put relevant headers
},
method: 'POST'
}"
/>
</template>
Props
componentId
Type | Optional |
---|---|
String |
No |
unique identifier of the component, can be referenced in other components' react
prop.
endpoint
Type | Optional |
---|---|
Object |
Yes |
endpoint prop provides the ability to query a user-defined backend service for this component, overriding the data endpoint configured in the ReactiveBase component. Accepts the following properties:
- url
String
[Required] URL where the data cluster is hosted. - headers
Object
[optional]
set custom headers to be sent with each server request as key/value pairs. - method
String
[optional]
set method of the API request. - body
Object
[optional]
request body of the API request. When body isn't set and method is POST, the request body is set based on the component's configured props.
- Overrides the endpoint property defined in ReactiveBase.
- If required, use
transformResponse
prop to transform response in component-consumable format.
dataField
Type | Optional |
---|---|
String |
No |
data field to be connected to the component's UI view. 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 type keyword
or not_analyzed
depending on your Elasticsearch cluster.
nestedField
Type | Optional |
---|---|
String |
Yes |
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 of nested
type.
title
Type | Optional |
---|---|
String or JSX |
Yes |
title of the component to be shown in the UI. Defaults to no title being shown.
size
Type | Optional |
---|---|
Number |
Yes |
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.
aggregationSize
To set the number of buckets to be returned by aggregations.
sortBy
Type | Optional |
---|---|
String |
Yes |
sort the list items by one of count
, asc
, or desc
. Defaults to count
, which sorts the list by the frequency of count value, most first.
defaultValue
Type | Optional |
---|---|
Array |
Yes |
pre-select one or more list items. Accepts an Array
object containing the items that should be selected. It is important for the passed value(s) to exactly match the field value(s) as stored in the DB.
value
Type | Optional |
---|---|
Array<String> |
Yes |
sets the current value of the component. It sets the value (on mount and on update). Use this prop in conjunction with the change
event.
queryFormat
Type | Optional |
---|---|
String |
Yes |
queries the selected items from the list in one of two modes: or
, and
.
- Defaults to
or
which queries for results where any of the selected list items are present. - In
and
mode, the applied query filters results where all of the selected items are present.
selectAllLabel
Type | Optional |
---|---|
String |
Yes |
add an extra Select all
item to the list with the provided label string.
showCheckbox
Type | Optional |
---|---|
Boolean |
Yes |
show checkbox icon for each list item. Defaults to true
.
showCount
Type | Optional |
---|---|
Boolean |
Yes |
show a count of the number of occurences besides each list item. Defaults to true
.
showFilter
Type | Optional |
---|---|
Boolean |
Yes |
show as filter when a value is selected in a global selected filters view. Defaults to true
.
filterLabel
Type | Optional |
---|---|
String |
Yes |
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 is componentId
.
renderItem
Type | Optional |
---|---|
Function|slot-scope |
Yes |
customize the rendered list via a function or slot-scope which receives the item label, count and isChecked & expects a JSX or String back. For example:
<multi-list>
<template #renderItem="{ label, count }">
<div>
{{label}}
<span :style="{ marginLeft: 5, color: 'dodgerblue' }">
{{count}}
</span>
</div>
</template>
</multi-list>
render
Type | Optional |
---|---|
Function|slot-scope |
Yes |
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
:array
current selected values.handleChange
:function
A callback function can be used to mark the list value as selected.
You can use render as a slot as shown below:
<multi-list
:showSearch="false"
componentId="BookSensor"
data-field="original_series.raw"
>
<template #render="{ data, handleChange }">
<div class="suggestions">
<ul>
<li
style="{ background-color: highlightedIndex ? 'grey' : 'transparent' }"
v-for="suggestion in (data || [])"
:key="suggestion._id"
v-on:click="handleChange(suggestion.key)"
>
{{ suggestion.key }}
</li>
</ul>
</div>
</template>
</multi-list>
renderError
Type | Optional |
---|---|
String|Function|slot-scope |
Yes |
can be used to render an error message in case of any error.
<template #renderError="error">
<div>Something went wrong!<br />Error details<br />{{ error }}</div>
</template>
renderNoResults
Type | Optional |
---|---|
String|Function|slot-scope |
Yes |
show custom message or component when no results found.
<template #renderNoResults>
<h4>No Results Found!</h4>
</template>
<!-- or -->
<multi-list
...
:renderNoResults="renderNoResults"
/>
export default {
...,
method: {
renderNoResults() {
return 'Try Again';
}
},
}
transformData
Type | Optional |
---|---|
Function |
Yes |
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:
showMissing
Type | Optional |
---|---|
Boolean |
Yes |
defaults to false
. When set to true
it also retrives the aggregations for missing fields under the label specified by missingLabel
.
missingLabel
Type | Optional |
---|---|
String |
Yes |
defaults to N/A
. Specify a custom label to show when showMissing
is set to true
.
showSearch
Type | Optional |
---|---|
Boolean |
Yes |
whether to show a searchbox to filter the list items locally. Defaults to true.
placeholder
Type | Optional |
---|---|
String |
Yes |
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".
URLParams
Type | Optional |
---|---|
Boolean |
Yes |
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
.
Demo
Styles
MultiList
component supports innerClass
prop with the following keys:
title
input
list
checkbox
label
count
Read more about it here.
Extending
MultiList
component can be extended to
- customize the look and feel with
className
, - update the underlying DB query with
customQuery
, - connect with external interfaces using
beforeValueChange
,value-change
andquery-change
, - specify how options should be filtered or updated using
react
prop.
<template>
<multi-list
className="custom-class"
:customQuery="getCustomQuery"
:react="react"
:beforeValueChange="handleBeforeValueChange"
@value-change="handleValueChange"
@query-change="handleQueryChange"
/>
</template>
<script>
export default {
name: 'app',
methods: {
getCustomQuery: (value, props) => {
return {
query: {
match: {
data_field: 'this is a test',
},
},
};
},
handleBeforeValueChange: value => {
// called before the value is set
// returns a promise
return new Promise((resolve, reject) => {
// update state or component props
resolve();
// or reject()
});
},
handleValueChange: value => {
console.log('current value: ', value);
// set the state
// use the value with other js code
},
handleQueryChange: (prevQuery, nextQuery) => {
// use the query with other js code
console.log('prevQuery', prevQuery);
console.log('nextQuery', nextQuery);
},
},
computed: {
react() {
return {
and: ['pricingFilter', 'dateFilter'],
or: ['searchFilter'],
};
},
},
};
</script>
className
Type | Optional |
---|---|
String |
Yes |
CSS class to be injected on the component container.
customQuery
Type | Optional |
---|---|
Function |
Yes |
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 MultiList component as long as the component is a part of react
dependency of at least one other component.
Note:
When extending with customQuery, the queryFormat
prop has no affect.
defaultQuery
Type | Optional |
---|---|
Function |
Yes |
takes value and props as parameters and returns the data query to be applied to the source component, as defined in Elasticsearch Query DSL.
Note:
defaultQuery doesn't get leaked to other components.
beforeValueChange
Type | Optional |
---|---|
Function |
Yes |
is a callback function which accepts component's future value as a parameter and returns a promise. It is called every time 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 >=
1.1.0
,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 = values => {
// The update is accepted by default
if (values.includes('Dirk Pitt')) {
// To reject the update, throw an error
throw Error('Selected values should not include Dirk Pitt.');
}
};
react
Type | Optional |
---|---|
Object |
Yes |
specify dependent components to reactively update MultiList'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.
index
Type | Optional |
---|---|
String |
Yes |
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 the app
prop defined in the ReactiveBase component.
Events
change
is an event that accepts component's current value as a parameter. It is called when you are using the value
prop and the component's value changes. This event is useful to control the value updates of search input.
<template>
<multi-list
// ...other props
value="value"
@change="handleChange"
/>
</template>
<script>
export default {
name: 'app',
data() {
return {
value: []
}
},
methods: {
handleChange(value) {
this.value = value;
}
}
};
</script>
query-change
is an event which accepts component's prevQuery and nextQuery as parameters. It is called everytime the component's query changes. This event is handy in cases where you want to generate a side-effect whenever the component's query would change.
value-change
is an event which accepts component's current value as a parameter. It is called everytime the component's value changes. This event 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.
error
gets triggered in case of an error and provides the error
object, which can be used for debugging or giving feedback to the user if needed.