CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

Changed

• BREAKING: Calendar and DateRange 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 and DateRange Components, no longer support string typed lang prop.

OLD

 <Calendar lang="tr" />

NEW

 import turkish from 'react-date-range/locale/tr';
 // you can view full list in https://github.com/Adphorus/react-date-range/tree/next/src/locale/index.js
 <Calendar locale={turkish} />

• BREAKING: DateRange handle range data with ranges:Array prop instead of startDate and endDate 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
        }
      }
      */
    }}
  />

• calendars prop renamed as months. And Calendar component is accepting months prop just like DateRange. Default value changed to 1 from 2.

Removed

• format prop removed. No longer accepts string input for Calendar or DateRange. You should parse dates like below: Native js: new Date(dateString) Date-fns: fns.parse(dateString) Momentjs: moment(dateString).toDate()

• disableDaysBeforeToday prop removed. use minDate={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. Receives inputRanges, staticRanges for setting date ranges.
• DateRangePicker component. It's combined version of DateRange with DefinedRanges component.
• Date range selection by drag.
• Infinite scroll feature. Sample usage:

  const horizontalScroll={enabled: true, monthHeight: 300, monthWidth: 300 };
  const verticalScroll={enabled: true, monthHeight: 220, longMonthHeight: 240 };
  <DateRangePicker scroll={horizontalScroll} />
  <DateRangePicker scroll={verticalScroll} months={2} />

• showPreview prop added to control visibility of preview. Default value is true.
• 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.

{
  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 with preview 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. See focusedRange for usage.
• onRangeFocusChange prop added: Callback function for focus changes by user.
• dragSelectionEnabled prop added
• showMonthAndYearPickers prop added