GeoDistanceSlider

Image to be displayed

GeoDistanceSlider creates a location search based range slider UI component that is connected to a database field. It is used for distance based filtering.

Example uses:

  • finding restaurants in walking distance from your location.
  • discovering things to do near a landmark.

Usage

Basic Usage

<GeoDistanceSlider
  componentId="locationUI"
  dataField="location"
  range={
    {
      "start": 0,
      "end": 20
    }
  }
/>

Usage With All Props

<GeoDistanceSlider
  componentId="GeoDistanceSensor"
  dataField="location"
  title="Geo Distance Slider"
  range={
    {
      "start": 0,
      "end": 20
    }
  }
  rangeLabels={
    {
      "start": "0 mi",
      "end": "20 mi"
    }
  }
  stepValue={1}
  defaultSelected={{
    "location": "SOMA, San Francisco, United States",
    "distance": 12
  }}
  placeholder="Select a distance range.."
  unit="mi"
  autoLocation={true}
  showFilter={true}
  filterLabel="Location"
  URLParams={false}
/>

Props

  • componentId String
    unique identifier of the component, can be referenced in other components’ react prop.
  • dataField String
    data field to be connected to the component’s UI view.
  • title String or HTML [optional]
    title of the component to be shown in the UI.
  • range Object
    an object with start and end keys and corresponding numeric values denoting the minimum and maximum possible slider values.
  • rangeLabels Object [optional]
    an object with start and end keys and corresponding String labels to show labels near the ends of the GeoDistanceSlider component.
  • stepValue Number [optional]
    step value specifies the slider stepper. Value should be an integer between 1 and floor(#total-range/2). Defaults to 1.
  • defaultSelected Object [optional]
    pre-select the search query with location option and distance with distance option.
  • placeholder String [optional]
    set the placeholder to show in the location search box, useful when no option is defaultSelected.
  • unit String [optional]
    unit for distance measurement, uses mi (for miles) by default. Distance units can be specified from the following:
    screenshot
  • autoLocation Boolean [optional]
    when enabled, preset the user’s current location in the location search box. Defaults to true.
  • showFilter Boolean [optional]
    show as filter when a value is selected in a global selected filters view. Defaults to true.
  • filterLabel String [optional]
    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.
  • URLParams Boolean [optional]
    enable creating a URL query string parameter based on the selected location from the slider. This is useful for sharing URLs with the component state. Defaults to false.

Syntax


Styles

All reactivebase and reactivemaps components are rbc namespaced.

Annotated image

Extending

GeoDistanceSlider 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.
<GeoDistanceSlider
  ...
  className="custom-class"
  style={{"paddingBottom": "10px"}}
  customQuery={
    function(value) {
      return {
        // query in the format of Elasticsearch Query DSL
        geo_distance: {
          distance: (value.end - value.start)
                    + value.unit,
          location_dataField: {
            lat: value.location.split(",")[0]
            lon: value.location.split(",")[1]
          }
        }
      }
    }
  }
  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);
    }
  }
/>
  • className String
    CSS class to be injected on the component container.
  • style Object
    CSS styles to be applied to the GeoDistanceSlider component.
  • customQuery Function
    takes value as a parameter and returns the data query to be applied to the component, as defined in Elasticsearch v2.4 Query DSL. Note: customQuery is called on value changes in the GeoDistanceSlider 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 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.
  • onValueChange Function
    is a callback function which accepts component’s current value as a parameter. It is called every time 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 a user searches within a specific location area.
  • 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.

Examples


  1. GeoDistance slider with all the default props

  2. GeoDistance slider with a title

  3. GeoDistance slider with range labels

  4. Playground (with all knob actions)