SingleRange
creates a numeric range selector UI component that is connected to a database field.
Note
It is similar to a SingleList, except it is suited for numeric data.
Example uses:
<template>
<single-range
title="Prices"
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'}]
"
/>
</template>
Usage With All Props
<template>
<single-range
componentId="PriceSensor"
compoundClause="filter"
dataField="price"
title="Prices"
defaultValue="Cheap"
filterLabel="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'}]
"
:showRadio="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'
}"
/>
</template>
Props componentId
unique identifier of the component, can be referenced in other components' react
prop.
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.
endpointNote:
compoundClause
is supported with v8.16.0 (server) as well as with serverless search.
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:
String
[Required] URL where the data cluster is hosted.Object
[optional]String
[optional]Object
[optional]dataField
- Overrides the endpoint property defined in ReactiveBase.
- If required, use
transformResponse
prop to transform response in component-consumable format.
data field to be connected to the component's UI view. The range items are filtered by a database query on this field.
data Type OptionalObject Array
Yes
collection of UI labels
with associated start
and end
range values.
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.
String or JSX
Yes
title of the component to be shown in the UI.
defaultValuepre-select a label from the data
array.
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.
Boolean
Yes
show radio button icon for each range item. Defaults to true
.
Boolean
Yes
show as filter when a value is selected in a global selected filters view. Defaults to true
.
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
.
Boolean
Yes
enable creating a URL query string parameter based on the selected value of the range. This is useful for sharing URLs with the component state. Defaults to false
.
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.
SingleRange
component supports innerClass
prop with the following keys:
title
list
radio
label
Read more about it here.
ExtendingSingleRange
component can be extended to
className
, style
,customQuery
,beforeValueChange
, value-change
and query-change
.<template>
<single-range
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 => {
return new Promise((resolve, reject) => {
resolve();
});
},
handleValueChange: value => {
console.log('current value: ', value);
},
handleQueryChange: (prevQuery, nextQuery) => {
console.log('prevQuery', prevQuery);
console.log('nextQuery', nextQuery);
},
},
computed: {
react() {
return {
and: ['pricingFilter', 'dateFilter'],
or: ['searchFilter'],
};
},
},
};
</script>
className
CSS class to be injected on the component container.
customQuery Type OptionalFunction
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 SingleRange component as long as the component is a part of react
dependency of at least one other component.
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 = value => {
if (value.start < 4) {
throw Error('Rating must be greater than or equal to 4.');
}
};
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>
<single-range
// ...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-changeis 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 range item(s) is/are selected in a "Discounted Price" SingleRange.
ExamplesSingleRange with default props
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4