react-date-range-dayjs v1.1.5

react-date-range-dayjs

A date library agnostic React component for choosing dates and date ranges. Uses dayjs for date operations.

Notice ⚠️

This project is based on the npm package react-date-range the goal is to provided the same functionnalities but with a lightweight date manager.

Why should you use react-date-range?

• Stateless date operations
• Highly configurable
• Multiple range selection
• Based on native js dates
• Drag n Drop selection
• Keyboard friendly

Getting Started

Installation

npm install --save react-date-range-dayjs

This plugin expects react and dayjs as peerDependencies, It means that you need to install them in your project folder.

npm install --save react dayjs

Usage

You need to import skeleton and theme styles first.

import 'react-date-range/dist/styles.css'; // main style file
import 'react-date-range/dist/theme/default.css'; // theme css file

DatePicker

import { Calendar } from 'react-date-range-dayjs';
import dayjs from 'dayjs';

class MyComponent extends Component {
  handleSelect(date) {
    console.log(date); //DayJs object
  }
  render() {
    return <Calendar date={dayjs()} onChange={this.handleSelect} />;
  }
}

DateRangePicker / DateRange

import { DateRangePicker } from 'react-date-range-dayjs';
import dayjs from 'dayjs';

class MyComponent extends Component {
  handleSelect(ranges) {
    console.log(ranges);
    // {
    //   selection: {
    //     startDate: [native Date Object],
    //     endDate: [native Date Object],
    //   }
    // }
  }
  render() {
    const selectionRange = {
      startDate: dayjs(),
      endDate: dayjs(),
      key: 'selection'
    };
    return <DateRangePicker ranges={[selectionRange]} onChange={this.handleSelect} />;
  }
}

Options

*shape of range:

 {
   startDate: PropTypes.object,
   endDate: PropTypes.object,
   color: PropTypes.string,
   key: PropTypes.string,
   autoFocus: PropTypes.bool,
   disabled: PropTypes.bool,
   showDateDisplay: PropTypes.bool,
 }

**shape of ariaLabels:

 {
   // The key of dateInput should be same as key in range.
   dateInput: PropTypes.objectOf(
     PropTypes.shape({
       startDate: PropTypes.string,
       endDate: PropTypes.string
     })
   ),
   monthPicker: PropTypes.string,
   yearPicker: PropTypes.string,
   prevButton: PropTypes.string,
   nextButton: PropTypes.string,
 }

Infinite Scrolled Mode

To enable infinite scroll set scroll={{enabled: true}} basically. Infinite scroll feature is affected by direction(rendering direction for months) and months(for rendered months count) props directly. If you prefer, you can overwrite calendar sizes with calendarWidth/calendarHeight or each month's height/width with monthWidth/monthHeight/longMonthHeight at scroll prop.

  // shape of scroll prop
  scroll: {
    enabled: PropTypes.bool,
    monthHeight: PropTypes.number,
    longMonthHeight: PropTypes.number, // some months has 1 more row than others
    monthWidth: PropTypes.number, // just used when direction="horizontal"
    calendarWidth: PropTypes.number, // defaults monthWidth * months
    calendarHeight: PropTypes.number, // defaults monthHeight * months
  }),