File size: 5,958 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
import moment, { Moment } from 'moment';
import React, { useEffect } from 'react';
import DatePicker from 'calypso/components/date-picker';
import { withLocalizedMoment } from 'calypso/components/localized-moment';
import { addDayToRange } from './utils';
type MomentOrNull = Moment | null;
interface DateRangePickerProps {
firstSelectableDate: MomentOrNull;
lastSelectableDate: MomentOrNull;
selectedStartDate: MomentOrNull;
selectedEndDate: MomentOrNull;
moment: typeof moment;
onDateRangeChange?: ( startDate: MomentOrNull, endDate: MomentOrNull ) => void;
focusedMonth?: Date;
numberOfMonths?: number;
useArrowNavigation?: boolean;
}
/**
* Module variables
*/
const NO_DATE_SELECTED_VALUE = null;
const noop = () => {};
const DateRangePicker = ( {
firstSelectableDate,
lastSelectableDate,
selectedStartDate,
selectedEndDate,
moment,
focusedMonth,
onDateRangeChange = noop,
numberOfMonths = 2,
useArrowNavigation = false,
}: DateRangePickerProps ) => {
/**
* Converts a moment date to a native JS Date object
* @param {import('moment').Moment} momentDate a momentjs date object to convert
* @returns {Date} the converted JS Date object
*/
function momentDateToJsDate( momentDate: MomentOrNull ) {
return moment.isMoment( momentDate ) ? momentDate.toDate() : momentDate;
}
/**
* Gets the locale appropriate date format (eg: "MM/DD/YYYY")
* @returns {string} date format as a string
*/
const getLocaleDateFormat = () => {
return moment.localeData().longDateFormat( 'L' );
};
const isValidDate = ( date: Moment ) => {
const epoch = moment( '01/01/1970', getLocaleDateFormat() );
// By default check
// 1. Looks like a valid date
// 2. after 01/01/1970 (avoids bugs when really stale dates are treated as valid)
if ( ! date.isValid() || ! date.isSameOrAfter( epoch ) ) {
return false;
}
// Check not before the first selectable date
// https://momentjs.com/docs/#/query/is-same-or-before/
if ( firstSelectableDate && date.isBefore( firstSelectableDate ) ) {
return false;
}
// Check not before the last selectable date
// https://momentjs.com/docs/#/query/is-same-or-before/
if ( lastSelectableDate && date.isAfter( lastSelectableDate ) ) {
return false;
}
return true;
};
/**
* Handles selection (only) of new dates persisting
* the values to state. Note that if the user does not
* commit the dates (eg: clicking "Apply") then the `revertDates`
* method is triggered which restores the previous ("stale") dates.
*
* Dates are only persisted via the commitDates method.
* @param {import('moment').Moment} date the newly selected date object
*/
const selectDate = ( date: Moment ) => {
date = date.startOf( 'day' );
if ( ! isValidDate( date ) ) {
return;
}
// Calculate the new Date range
const newRange = addDayToRange( date, { from: selectedStartDate, to: selectedEndDate } );
// Update to date or `null` which means "not date"
const newStartDate = ! newRange.from ? NO_DATE_SELECTED_VALUE : newRange.from;
const newEndDate = ! newRange.to ? NO_DATE_SELECTED_VALUE : newRange.to;
onDateRangeChange( newStartDate, newEndDate );
};
/**
* Builds an appropriate disabledDays prop for DatePicker
* based on firstSelectableDate and lastSelectableDate
* config props
*
* See:
* http://react-day-picker.js.org/api/DayPicker/#disabledDays
* http://react-day-picker.js.org/docs/matching-days
* @returns {Array} configuration to be passed to DatePicker as disabledDays prop
*/
const getDisabledDaysConfig = () => {
const config: { before?: Date; after?: Date } = {};
if ( firstSelectableDate ) {
config.before = momentDateToJsDate( firstSelectableDate ) ?? undefined; // disable all days before today
}
if ( lastSelectableDate ) {
config.after = momentDateToJsDate( lastSelectableDate ) ?? undefined; // disable all days before today
}
// Requires a wrapping Array
return [ config ];
};
const normlizeDate = ( date: MomentOrNull ) => {
return date ? moment( date ).startOf( 'day' ) : date;
};
useEffect( () => {
if ( selectedStartDate && selectedEndDate && selectedStartDate.isAfter( selectedEndDate ) ) {
onDateRangeChange?.( selectedEndDate, selectedStartDate );
}
}, [ selectedStartDate?.format(), selectedEndDate?.format() ] );
// Normalize dates to start of day
selectedStartDate = normlizeDate( selectedStartDate );
selectedEndDate = normlizeDate( selectedEndDate );
firstSelectableDate = normlizeDate( firstSelectableDate );
lastSelectableDate = normlizeDate( lastSelectableDate );
const fromDate = momentDateToJsDate( selectedStartDate );
const toDate = momentDateToJsDate( selectedEndDate );
// Add "Range" modifier classes to Day component
// within Date Picker to aid "range" styling
// http://react-day-picker.js.org/api/DayPicker/#modifiers
const modifiers = {
start: fromDate,
end: toDate,
'range-start': fromDate,
'range-end': toDate,
range: {
from: fromDate,
to: toDate,
},
};
// Dates to be "selected" in Picker
const selected = [
fromDate,
{
from: fromDate,
to: toDate,
},
];
const rootClassNames = {
'date-range__picker': true,
};
const calendarInitialDate =
firstSelectableDate ||
( lastSelectableDate && moment( lastSelectableDate ).subtract( 1, 'month' ) ) ||
selectedStartDate;
return (
<DatePicker
calendarViewDate={ focusedMonth }
calendarInitialDate={ momentDateToJsDate( calendarInitialDate ) }
rootClassNames={ rootClassNames }
modifiers={ modifiers }
showOutsideDays={ false }
fromMonth={ momentDateToJsDate( firstSelectableDate ) }
toMonth={ momentDateToJsDate( lastSelectableDate ) }
onSelectDay={ selectDate }
selectedDays={ selected }
numberOfMonths={ numberOfMonths }
disabledDays={ getDisabledDaysConfig() }
useArrowNavigation={ useArrowNavigation }
/>
);
};
export default withLocalizedMoment( DateRangePicker );
|