Image to be displayed

DatePicker creates a calender view based UI component that is connected to a database date field. It is used for filtering results by a date like property.

Example uses:

  • finding flights departing on a particular day.
  • picking your date of birth for an online application form.


Basic Usage

<DatePicker componentId="DateSensor" dataField="mtime" />

Usage With All Props

    placeholder="Pick date"
        url:"", //mandatory
            // relevant headers
        method: 'POST'



Type Optional
String No

unique identifier of the component, can be referenced in other components' react prop.


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.


Type Optional
Object No
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:
  • url String [Required] URL where the data cluster is hosted.
  • headers Object [optional]
    set custom headers to be sent with each server request as key/value pairs.
  • method String [optional]
    set method of the API request.
  • body Object [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.


Type Optional
String No

data field to be connected to the component's UI view.


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.


Type Optional
String or JSX Yes

title of the component to be shown in the UI.


Type Optional
String Yes

selects initial date on mount.


Type Optional
Array Yes

controls the current value of the component.It selects the date (on mount and on update).Use this prop in conjunction with onChange function.


Type Optional
function Yes

is a callback function 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. This prop is used to implement the controlled component behavior.


Type Optional
Boolean Yes

whether to display the calendar view on initial load. Defaults to true.


Type Optional
Number Yes

number of months to be shown in the calendar view. Defaults to 1.


Type Optional
Date object Yes

if provided sets the initial visible month when nothing is selected and the calendar is pulled up. For example, passing new Date('2017-04-01') will open the calendar on January 1st, 2017.


Type Optional
String Yes

sets the date format to be used in the query, can accept one of the following:


Representation as elasticsearch date

epoch_millis (default) epoch_millis
epoch_second epoch_second
basic_time HHmmss.SSSZ
basic_time_no_millis HHmmssZ
date yyyy-MM-dd
basic_date yyyyMMdd
basic_date_time yyyyMMdd'T'HHmmss.SSSZ
basic_date_time_no_millis yyyyMMdd'T'HHmmssZ
date_time_no_millis yyyy-MM-dd'T'HH:mm:ssZZ


Type Optional
String Yes

placeholder to be shown in the field when no date is selected. Defaults to "Select Date".


Type Optional
Boolean Yes

displays a cross icon to clear the input value. Defaults to true.


Type Optional
Boolean Yes

clears the selected date if an active date is selected in the calendar view. Defaults to true.


Type Optional
object Yes

accepts an object which is passed to the underlying React Day Picker Input component. Find the props here.


Type Optional
Boolean Yes

show as filter when a value is selected in a global selected filters view. Defaults to true.


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.


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.



DatePicker component supports innerClass prop with the following keys:

  • title
  • daypicker-container
  • daypicker-overlay-wrapper
  • daypicker-overlay

Read more about it here. This component uses React Day Picker Input which you may refer to in order to customize the calendar fully.


DatePicker 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.
  style={{"paddingBottom": "10px"}}
    function(value, props) {
      return {
        query: {
          match: {
            data_field: "this is a test"
    function(value) {
      // called before the value is set
      // returns a promise
      return new Promise((resolve, reject) => {
        // update state or component props
        // or reject()
    function(value) {
      console.log("current value: ", value)
      // set the state
      // use the value with other js code
    function(prevQuery, nextQuery) {
      // use the query with other js code
      console.log('prevQuery', prevQuery);
      console.log('nextQuery', nextQuery);


Type Optional
String Yes

CSS class to be injected on the component container.


Type Optional
Object Yes

CSS styles to be applied to the DatePicker component.


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 DatePicker component as long as the component is a part of react dependency of at least one other component.


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.


If you're using Reactivesearch version >= 3.3.7, beforeValueChange can also be defined as a synchronous function. value is updated by default, unless you throw an Error to reject the update. For example:

beforeValueChange = value => {
    // The update is accepted by default
    const compareDate = Date.parse('2012-11-01');
    const dateValue = Date.parse(value);
    if (dateValue < compareDate) {
        // To reject the update, throw an error
        throw Error("Selected date must be greater than or equal to '2012-11-01'.");


Type Optional
Function Yes

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 a particular date is selected in a DatePicker.


Type Optional
Function Yes

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.


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.


DatePicker with default props