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.
Usage
Basic Usage
<DatePicker componentId="DateSensor" dataField="mtime" />
Usage With All Props
<DatePicker
componentId="DateSensor"
dataField="mtime"
title="DatePicker"
defaultValue="2017-04-01"
focused={true}
numberOfMonths={1}
queryFormat="date"
placeholder="Pick date"
showClear={true}
clickUnselectsDay={true}
showFilter={true}
filterLabel="Date"
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. - nestedField
String
[optional] use to set thenested
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 ofnested
type. - title
String or JSX
[optional] title of the component to be shown in the UI. - defaultValue
String
[optional] selects initial date on mount. - value
Array
[optional] controls the current value of the component.It selects the date (on mount and on update).Use this prop in conjunction withonChange
function. - onChange
function
[optional] is a callback function which accepts component's current value as a parameter. It is called when you are using thevalue
prop and the component's value changes. This prop is used to implement the controlled component behavior. - focused
Boolean
[optional] whether to display the calendar view on initial load. Defaults totrue
. - numberOfMonths
Number
[optional] number of months to be shown in the calendar view. Defaults to 1. - initialMonth
Date object
[optional] if provided sets the initial visible month when nothing is selected and the calendar is pulled up. For example, passingnew Date('2017-04-01')
will open the calendar on January 1st, 2017. - queryFormat
String
[optional] sets the date format to be used in the query, can accept one of the following:
queryFormat |
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 |
- placeholder
String
[optional] placeholder to be shown in the field when no date is selected. Defaults to "Select Date". - showClear
Boolean
[optional] displays a cross icon to clear the input value. Defaults totrue
. - clickUnselectsDay
Boolean
[optional] clears the selected date if an active date is selected in the calendar view. Defaults totrue
. - dayPickerInputProps
object
[optional] accepts an object which is passed to the underlying React Day Picker Input component. Find the props here. - showFilter
Boolean
[optional] show as filter when a value is selected in a global selected filters view. Defaults totrue
. - filterLabel
String
[optional] An optional label to display for the component in the global selected filters view. This is only applicable ifshowFilter
is enabled. Default value used here iscomponentId
. - 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 tofalse
.
Demo
Styles
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.
Extending
DatePicker
component can be extended to
- customize the look and feel with
className
,style
, - update the underlying DB query with
customQuery
, - connect with external interfaces using
beforeValueChange
,onValueChange
andonQueryChange
.
<DatePicker
...
className="custom-class"
style={{"paddingBottom": "10px"}}
customQuery={
function(value, props) {
return {
query: {
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);
}
}
/>
-
className
String
CSS class to be injected on the component container. -
style
Object
CSS styles to be applied to the DatePicker 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 DatePicker component as long as the component is a part ofreact
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.Note:
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 anError
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'."); } };
-
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 a particular date is selected in a DatePicker. -
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. -
index
String
[optional] 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 theapp
prop defined in the ReactiveBase component.Note: This only works when
enableAppbase
prop is set to true inReactiveBase
.