bookish-octo-parakeet
v1.4.14
Published
React Js based date/range picker.
Downloads
11
Maintainers
Readme
React Js based date/range picker
install
$ npm i react-range-picker --save
use
import RangePicker from "react-range-picker"
<RangePicker/>
APIS
| API | Type | Description |
| ------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| visible | boolean | to controlled visibility of the calendar, only works if on calendar mount visible prop is a boolean value
|
| defaultValue | object | set default values for the calendar - {startDate: Date, endDate: Date}
|
| onDateSelected | function | gets called each time date/time gets selected (params - startDate, startDate) |
| onOpen | function | gets called when calendar opens |
| onClose | function | gets called when calendar closes or ok/select button is pressed |
| closeOnSelect | boolean | if true picker will hide on select of a date or range (default false) |
| closeOnOutsideClick | boolean | if true calendar won't close on click of outside area (default true) |
| disableRange | boolean | if true user can select only one date (default false) |
| locale | string | set calendar locale for the calendar |
| selectTime | boolean | if true, time select will show up on date select (default false) |
| rangeTillEndOfDay | boolean | if true, then second selected date for range will have time of end of the day (11.59 PM) else it will have time of start of the day (12:00 AM) |
| placeholder | function => ReactComponent | change placeholder, placeholder function will receive following object as param - {startDate (date object),endDate (date object)}
|
| placeholderText | string | replaces placeholder default text |
| dateFormat | string | format of placeholder date |
| footer | function => ReactComponent | change footer, footer function will receive following object as param - {startDate (date object), endDate (date object),today (function) - to select today's date, close (function) - closes the calendar and calls, onClose callback passed by user}
|
| maxDate | number | maximal date passed in utc timestamp (default 10 years since current date) |
| minDate | number | minimal date passed in utc timestamp (default 10 years since current date) |
Followings are the variables for the date format.
dd
- dateDD
- day shortDDDD
- day fullmm
- monthMM
- month shortMMMM
- month fullyyyy or YYYY
- full yearh
- hoursmi
- minutesa
- lowercase period (am),A
- capital period (AM)