react-date-range v1.0.0 Release Notes
Release Date: 2020-02-19 // about 4 years ago-
๐ Changed
๐ฅ BREAKING:
Calendar
andDateRange
are now totally controlled components with stateless date management.๐ฅ BREAKING: React-date-range is no longer use moment out of the box. Input and output values are native Date object. Until v2 version you don't depent on momentjs. You can keep continue to use moment if you want like below
OLD
// this.state.eventDate: momentjs object <Calendar date={this.state.eventDate} onChange={date => this.setState({eventDate: date})} />
๐ NEW
<Calendar date={this.state.eventDate} // js object onChange={date => this.setState({ eventDate: date })} // />
๐ NEW with moment (or any other date libraries)
<Calendar date={this.state.eventDate.toDate()} // convert moment object to js Date onChange={date => this.setState({ eventDate: moment(date) })} // />
- ๐
BREAKING: Theming and style approach complately changed.
react-date-range
don't use inline styles any more. At the new version you should import skeleton styles and theme styles
// main style file import 'react-date-range/dist/styles.css'; // theme css file import 'react-date-range/dist/theme/default.css';
- ๐ฅ BREAKING:
Calendar
andDateRange
Components, no longer support string typedlang
prop.
OLD
<Calendar lang="tr" />
NEW
import turkish from 'react-date-range/locale/tr'; // you can view full list in https://github.com/hypeserver/react-date-range/tree/next/src/locale/index.js <Calendar locale={turkish} />
- ๐ฅ BREAKING:
DateRange
handle range data withranges:Array
prop instead ofstartDate
andendDate
props.
OLD
<DateRange startDate={new Date()} endDate={new Date(2048, 6, 6)} onChange={ change => { console.log(change); /* prints: { startDate: Moment, endDate: Moment } /* } } />
๐ NEW
<DateRange ranges={[{ startDate: new Date(), endDate: new Date(2048, 06, 06), key: 'selection', }]} onChange={changes => { console.log(changes); /* prints { selection: { startDate: Date, endDate: Date } } */ }} />
0๏ธโฃ
calendars
prop renamed asmonths
. AndCalendar
component is acceptingmonths
prop just likeDateRange
. Default value changed to1
from2
.โ Removed
๐
format
prop removed. No longer accepts string input forCalendar
orDateRange
. You should parse dates like below: โ Native js:new Date(dateString)
โ Date-fns:fns.parse(dateString)
โ Momentjs:moment(dateString).toDate()
๐
disableDaysBeforeToday
prop removed. useminDate={new Date()}
instead.๐
firstDayOfWeek
prop removed. It is auto detecting from locale prop.๐
init
prop removed.๐
specialDays
prop removed.
โ Added
disabledDates
prop: It's a set of disabled dates.DefinedRanges
component: It's a set of date presets. ReceivesinputRanges
,staticRanges
for setting date ranges.DateRangePicker
component. It's combined version ofDateRange
withDefinedRanges
component.- Date range selection by drag.
- Infinite scroll feature. Sample usage:
js const horizontalScroll={enabled: true, monthHeight: 300, monthWidth: 300 }; const verticalScroll={enabled: true, monthHeight: 220, longMonthHeight: 240 }; <DateRangePicker scroll={horizontalScroll} /> <DateRangePicker scroll={verticalScroll} months={2} />
- 0๏ธโฃ
showPreview
prop added to control visibility of preview. Default value istrue
. - 0๏ธโฃ
preview
prop added: It displays a preview range and overwrite DateRange's default preview. You can set a controlled preview with below shape of object.js { startDate: [Date Object] || null, endDate: [Date Object] || null, color: '#fed14c', }
onPreviewChange(date)
prop added: Callback function for preview changes. You can set controlled custom previews withpreview
prop.focusedRange
prop added: It defines which range and step are focused. Common initial value is[0, 0]
; first value is index of ranges, second value is which step on date range(startDate or endDate).- ๐
initialFocusedRange
prop added: Initial value for focused range. SeefocusedRange
for usage. onRangeFocusChange
prop added: Callback function for focus changes by user.dragSelectionEnabled
prop addedshowMonthAndYearPickers
prop added