RangeSlider

Image to be displayed

RangeSlider creates a numeric range slider UI component. It is used for granular filtering of numeric data.

Example uses:

  • filtering products from a price range in an e-commerce shopping experience.
  • filtering flights from a range of departure and arrival times.

Usage

Basic Usage

<RangeSlider
  componentId="RangeSliderSensor"
  dataField="guests"
  title="Guests"
  range={{
    "start": 0,
    "end": 10
  }}
/>

While RangeSlider only requires the above props to be used, it comes with many additional props for pre-setting default range values, setting the step value of the range slider, specifying labels for the range endpoints, whether to display histogram etc.

Usage With All Props

<RangeSlider
  componentId="RangeSliderSensor"
  dataField="guests"
  title="Guests"
  range={{
    "start": 0,
    "end": 10
  }}
  defaultSelected={{
    "start": 1,
    "end": 5
  }}
  rangeLabels={{
    "start": "Start",
    "end": "End"
  }}
  stepValue={1}
  showHistogram={true}
  showFilter={true}
  interval={2}
  react={{
    and: ["CategoryFilter", "SearchFilter"]
  }}
  URLParams={false}
/>

Props

  • componentId String
    unique identifier of the component, can be referenced in other components’ react prop.
  • dataField String
    DB data field to be mapped with the component’s UI view. The selected range creates a database query on this field.
  • range Object an object with start and end keys and corresponding numeric values denoting the minimum and maximum possible slider values.
  • title String or JSX [optional]
    title of the component to be shown in the UI.
  • defaultSelected Object [optional]
    an object with start and end keys and corresponding numeric values denoting the pre-selected range values.
  • rangeLabels Object [optional]
    an object with start and end keys and corresponding String labels to show labels near the ends of the RangeSlider component.
  • showFilter Boolean [optional]
    show the selected item as a filter in the selected filters view. Defaults to true.
  • snap Boolean [optional] 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 Number [optional]
    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.
  • showHistogram Boolean [optional]
    whether to display the range histogram or not. Defaults to true.
  • interval Number [optional]
    set the histogram bar interval, applicable when showHistogram is true. Defaults to Math.ceil((props.range.end - props.range.start) / 100) || 1.
  • 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.

Demo


Styles

RangeSlider component supports innerClass prop with the following keys:

  • title
  • slider
  • label

Read more about it here.

Extending

RangeSlider component can be extended to

  1. customize the look and feel with className, style,
  2. update the underlying DB query with customQuery,
  3. connect with external interfaces using beforeValueChange, onValueChange and onQueryChange,
  4. filter data using a combined query context via the react prop.
<RangeSlider
  ...
  className="custom-class"
  style={{"paddingBottom": "10px"}}
  customQuery={
    function(value, props) {
      return {
        match: {
          data_field: "this is a test"
        }
      }
    }
  }
  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);
    }
  }
  react={{
    "and": ["ListSensor"]
  }}
/>
  • className String
    CSS class to be injected on the component container.
  • style Object
    CSS styles to be applied to the RangeSlider component.
  • customQuery Function
    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 RangeSlider component as long as the component is a part of react dependency of at least one other component.
  • 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.
  • 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 some range is selected in a “Discounted Price” RangeSlider.
  • 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 RangeSlider’s data view.

    • key String
      one of and, 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 its componentId.
      • Array is used for specifying multiple components by their componentId.
      • Object is used for nesting other key clauses.

Examples

See more stories for RangeSlider on playground.

RangeSlider with default props