ToggleButton
creates a toggle button UI component that is connected to a database field. It is used for filtering results based on a fixed set of toggle-able options.
Example uses:
- filter movies by ratings between 1 and 5,
- display restaurants that accept delivery and are open now,
- show flight tickets by one way, round trip and multi-city options.
Usage
Basic Usage
<template>
<toggle-button
componentId="MeetupTops"
dataField="group_topics.topic_name.raw"
:data="[
{'label': 'Social', 'value': 'Social'},
{'label': 'Travel', 'value': 'Travel'},
{'label': 'Outdoors', 'value': 'Outdoors'}
]"
/>
</template>
Usage With All Props
<toggle-button
componentId="MeetupTops"
dataField="group_topics.topic_name.raw"
title="Meetups"
filterLabel="City"
:data="[
{'label': 'Social', 'value': 'Social'},
{'label': 'Travel', 'value': 'Travel'},
{'label': 'Outdoors', 'value': 'Outdoors'}
]"
:defaultValue="['Social']"
:multiSelect="true"
:showFilter="true"
:URLParams="false"
:endpoint="{
url:'https://appbase-demo-ansible-abxiydt-arc.searchbase.io/recipes-demo/_reactivesearch.v3',
headers: {
// put relevant headers
},
method: 'POST'
}"
/>
Props
componentId
Type | Optional |
---|---|
String |
No |
unique identifier of the component, can be referenced in other components' react
prop.
compoundClause
Type | Optional |
---|---|
String |
Yes |
Configure whether the DSL query is generated with the compound clause of must
or filter
. If nothing is passed the default is to use must
. Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn’t relevant (e.g. term, geo or range type of queries that act as filters on the data)
This property only has an effect when the search engine is either elasticsearch or opensearch.
Note:
compoundClause
is supported with v8.16.0 (server) as well as with serverless search.
dataField
Type | Optional |
---|---|
String |
No |
data field to be connected to the component's UI view.
data
Type | Optional |
---|---|
Object Array |
Yes |
collection of UI labels
with associated value
to be matched against the database field.
title
Type | Optional |
---|---|
String or JSX |
Yes |
title of the component to be shown in the UI.
defaultValue
Type | Optional |
---|---|
String or Array |
Yes |
an array of default selected label(s) to pre-select one or more buttons.
value
Type | Optional |
---|---|
String | Array<String> |
Yes |
controls the current value of the component. It selects the label (on mount and on update). Use this prop in conjunction with the change
event.
multiSelect
Type | Optional |
---|---|
Boolean |
Yes |
whether multiple buttons can be selected, defaults to true. When set to false, only one button can be selected.
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.
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 button via a function or slot-scope which receives the item object, isSelected
and handleClick
method to listen to the click events & expects the html back. For example:
<toggle-button>
<template #renderItem="{ item, handleClick, isSelected }">
<a
:href="item.url"
@click="handleClick"
:style="{ color: isSelected ? 'blue': 'dodgerblue'}"
/>
</template>
</toggle-button>
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
.
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.
enableStrictSelection
Type | Optional |
---|---|
Boolean |
Yes |
When set to true
, a selected option can't be unselected. Although, it is possible to change the selected option. Defaults to false
.
Note: This only works when
multiSelect
prop is set tofalse
.
Demo
Styles
ToggleButton
component supports innerClass
prop with the following keys:
title
button
Read more about it here.
Extending
ToggleButton
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
.
<template>
<toggle-button
className="custom-class"
:customQuery="getCustomQuery"
: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);
},
},
};
</script>
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 ToggleButton component as long as the component is a part of react
dependency of at least one other component.
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 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 >=
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('Social')) {
// To reject the update, throw an error
throw Error('Selected value should not include Social.');
}
};
Events
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.
change
gets triggered when you are using the value
props and the component's value changes.
<template>
<toggle-button
// ...other props
value="value"
@change="handleChange"
/>
</template>
<script>
export default {
name: 'app',
data() {
return {
value: ""
}
},
methods: {
handleChange(value) {
this.value = value;
}
}
};
</script>