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. Works only when enableAppbase is true.
Accepts the following properties:
urlString [Required]
URL where the data cluster is hosted.
headersObject [optional]
set custom headers to be sent with each server request as key/value pairs.
methodString [optional]
set method of the API request.
bodyObject [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
DB data field to be mapped with the component's UI view. The selected range creates a database query on this field.
range
Type
Optional
Object
Yes
an object with start and end keys and corresponding numeric values denoting the minimum and maximum possible slider values.
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.
defaultValue
Type
Optional
Object
Yes
selects a initial range values using start and end key values from one of the data elements.
value
Type
Optional
Object
Yes
controls the current value of the component.It selects the data from the range (on mount and on update). Use this prop in conjunction with change event.
validateRange
Type
Optional
function
Yes
is a callback function that can be used to validate the range input values before applying it. This function accepts an array of numbers where first element represents the start range and second element represents the end range. The following example prevents the users to type negative value for start range input.
an object with `start` and `end` keys and corresponding `String` labels to show labels near the ends of the `RangeInput` component.
showFilter
Type
Optional
Boolean
Yes
Copy
show the selected item as a filter in the selected filters view. Defaults to `true`.
snap
Type
Optional
Boolean
Yes
Copy
makes the slider snap on to points depending on the `stepValue` when the slider is released. Defaults to `true`. When set to `false`, `stepValue` is ignored.
stepValue
Type
Optional
Number
Yes
Copy
step value specifies the slider stepper. Value should be an integer greater than or equal to `1` and less than `Math.floor((range.end - range.start) / 2)`. Defaults to 1.
URLParams
Type
Optional
Boolean
Yes
Copy
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`.
includeNullValues
Type
Optional
Boolean
Yes
Copy
If you have sparse data or document or items not having the value in the specified field or mapping, then this prop enables you to show that data. Defaults to `false`.
Demo
Styles
RangeInput component supports innerClass prop with the following keys:
slider-container
input-container
The other innerClass properties are the same as supported by RangeSlider.
Extending
RangeInput 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, valueChange and queryChange,
filter data using a combined query context via the react prop,
as a controlled component using value prop and change event.
Copy
<template><range-inputclassName="custom-class":customQuery="getCustomQuery":react="react":beforeValueChange="handleBeforeValueChange"@valueChange="handleValueChange"@queryChange="handleQueryChange"/></template><script>exportdefault{name:'app',methods:{getCustomQuery:(value, props)=>{return{query:{match:{price:1000,},},};},handleBeforeValueChange:value=>{// called before the value is set// returns a promisereturnnewPromise((resolve, reject)=>{// update state or component propsresolve();// 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
Copy
CSS class to be injected on the component container.
customQuery
Type
Optional
Function
Yes
Copy
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 **RangeInput** component as long as the component is a part of
>`react` dependency of at least one other component.
beforeValueChange
Type
Optional
Function
Yes
Copy
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. For example,
```js
beforeValueChange = value => {
// The update is accepted by default
if (value.start > 3000) {
// To reject the update, throw an error
throw Error('Start value must be less than or equal to 3000.');
}
};
```
Events
queryChange
Copy
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.
valueChange
Copy
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 some range is selected in a “Discounted Price” RangeInput.
change
Copy
is an event which accepts component's current **value** as a parameter. It is called when you are using the value prop and the component's value changes.