@fluentui/react-northstar
Version:
A themable React component library.
393 lines (365 loc) • 16.8 kB
JavaScript
function _createForOfIteratorHelperLoose(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (it) return (it = it.call(o)).next.bind(it); if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; return function () { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
import { DayOfWeek, MonthOfYear, FirstWeekOfYear, DateRangeType } from '../dateValues/dateValues';
import { TimeConstants } from '../dateValues/timeConstants';
/**
* Returns a date offset from the given date by the specified number of days.
* @param date - The origin date
* @param days - The number of days to offset. 'days' can be negative.
* @returns A new Date object offset from the origin date by the given number of days
*/
export function addDays(date, days) {
var result = new Date(date.getTime());
result.setDate(result.getDate() + days);
return result;
}
/**
* Returns a date offset from the given date by the specified number of weeks.
* @param date - The origin date
* @param weeks - The number of weeks to offset. 'weeks' can be negative.
* @returns A new Date object offset from the origin date by the given number of weeks
*/
export function addWeeks(date, weeks) {
return addDays(date, weeks * TimeConstants.DaysInOneWeek);
}
/**
* Returns a date offset from the given date by the specified number of months.
* The method tries to preserve the day-of-month; however, if the new month does not have enough days
* to contain the original day-of-month, we'll use the last day of the new month.
* @param date - The origin date
* @param months - The number of months to offset. 'months' can be negative.
* @returns A new Date object offset from the origin date by the given number of months
*/
export function addMonths(date, months) {
var result = new Date(date.getTime());
var newMonth = result.getMonth() + months;
result.setMonth(newMonth);
// We want to maintain the same day-of-month, but that may not be possible if the new month doesn't have enough days.
// Loop until we back up to a day the new month has.
// (Weird modulo math is due to Javascript's treatment of negative numbers in modulo)
if (result.getMonth() !== (newMonth % TimeConstants.MonthInOneYear + TimeConstants.MonthInOneYear) % TimeConstants.MonthInOneYear) {
result = addDays(result, -result.getDate());
}
return result;
}
/**
* Returns a date offset from the given date by the specified number of years.
* The method tries to preserve the day-of-month; however, if the new month does not have enough days
* to contain the original day-of-month, we'll use the last day of the new month.
* @param date - The origin date
* @param years - The number of years to offset. 'years' can be negative.
* @returns A new Date object offset from the origin date by the given number of years
*/
export function addYears(date, years) {
var result = new Date(date.getTime());
result.setFullYear(date.getFullYear() + years);
// We want to maintain the same day-of-month, but that may not be possible if the new month doesn't have enough days.
// Loop until we back up to a day the new month has.
// (Weird modulo math is due to Javascript's treatment of negative numbers in modulo)
if (result.getMonth() !== (date.getMonth() % TimeConstants.MonthInOneYear + TimeConstants.MonthInOneYear) % TimeConstants.MonthInOneYear) {
result = addDays(result, -result.getDate());
}
return result;
}
/**
* Returns a date that is the first day of the month of the provided date.
* @param date - The origin date
* @returns A new Date object with the day set to the first day of the month.
*/
export function getMonthStart(date) {
return new Date(date.getFullYear(), date.getMonth(), 1, 0, 0, 0, 0);
}
/**
* Returns a date that is the last day of the month of the provided date.
* @param date - The origin date
* @returns A new Date object with the day set to the last day of the month.
*/
export function getMonthEnd(date) {
return new Date(date.getFullYear(), date.getMonth() + 1, 0, 0, 0, 0, 0);
}
/**
* Returns a date that is the first day of the year of the provided date.
* @param date - The origin date
* @returns A new Date object with the day set to the first day of the year.
*/
export function getYearStart(date) {
return new Date(date.getFullYear(), 0, 1, 0, 0, 0, 0);
}
/**
* Returns a date that is the last day of the year of the provided date.
* @param date - The origin date
* @returns A new Date object with the day set to the last day of the year.
*/
export function getYearEnd(date) {
return new Date(date.getFullYear() + 1, 0, 0, 0, 0, 0, 0);
}
/**
* Returns a date that is a copy of the given date, aside from the month changing to the given month.
* The method tries to preserve the day-of-month; however, if the new month does not have enough days
* to contain the original day-of-month, we'll use the last day of the new month.
* @param date - The origin date
* @param month - The 0-based index of the month to set on the date.
* @returns A new Date object with the given month set.
*/
export function setMonth(date, month) {
return addMonths(date, month - date.getMonth());
}
/**
* Compares two dates, and returns true if the two dates (not accounting for time-of-day) are equal.
* @returns True if the two dates represent the same date (regardless of time-of-day), false otherwise.
*/
export function compareDates(date1, date2) {
if (!date1 && !date2) {
return true;
}
if (!date1 || !date2) {
return false;
}
return date1.getFullYear() === date2.getFullYear() && date1.getMonth() === date2.getMonth() && date1.getDate() === date2.getDate();
}
/**
* Compare the date parts of two dates
* @param date1 - The first date to compare
* @param date2 - The second date to compare
* @returns A negative value if date1 is earlier than date2, 0 if the dates are equal, or a positive value
* if date1 is later than date2.
*/
export function compareDatePart(date1, date2) {
return getDatePartHashValue(date1) - getDatePartHashValue(date2);
}
/**
* Gets the date range array including the specified date. The date range array is calculated as the list
* of dates accounting for the specified first day of the week and date range type.
* @param date - The input date
* @param dateRangeType - The desired date range type, i.e., day, week, month, etc.
* @param firstDayOfWeek - The first day of the week.
* @param workWeekDays - The allowed days in work week. If not provided, assumes all days are allowed.
* @param daysToSelectInDayView - The number of days to include when using dateRangeType === DateRangeType.Day
* for multiday view. Defaults to 1
* @returns An array of dates representing the date range containing the specified date.
*/
export function getDateRangeArray(date, dateRangeType, firstDayOfWeek, workWeekDays, daysToSelectInDayView) {
if (daysToSelectInDayView === void 0) {
daysToSelectInDayView = 1;
}
var datesArray = [];
var startDate;
var endDate = null;
if (!workWeekDays) {
workWeekDays = [DayOfWeek.Monday, DayOfWeek.Tuesday, DayOfWeek.Wednesday, DayOfWeek.Thursday, DayOfWeek.Friday];
}
daysToSelectInDayView = Math.max(daysToSelectInDayView, 1);
switch (dateRangeType) {
case DateRangeType.Day:
startDate = getDatePart(date);
endDate = addDays(startDate, daysToSelectInDayView);
break;
case DateRangeType.Week:
case DateRangeType.WorkWeek:
startDate = getStartDateOfWeek(getDatePart(date), firstDayOfWeek);
endDate = addDays(startDate, TimeConstants.DaysInOneWeek);
break;
case DateRangeType.Month:
startDate = new Date(date.getFullYear(), date.getMonth(), 1);
endDate = addMonths(startDate, 1);
break;
default:
throw new Error("Unexpected object: " + dateRangeType);
}
// Populate the dates array with the dates in range
var nextDate = startDate;
do {
if (dateRangeType !== DateRangeType.WorkWeek) {
// push all days not in work week view
datesArray.push(nextDate);
} else if (workWeekDays.indexOf(nextDate.getDay()) !== -1) {
datesArray.push(nextDate);
}
nextDate = addDays(nextDate, 1);
} while (!compareDates(nextDate, endDate));
return datesArray;
}
/**
* Checks whether the specified date is in the given date range.
* @param date - The origin date
* @param dateRange - An array of dates to do the lookup on
* @returns True if the date matches one of the dates in the specified array, false otherwise.
*/
export function isInDateRangeArray(date, dateRange) {
for (var _iterator = _createForOfIteratorHelperLoose(dateRange), _step; !(_step = _iterator()).done;) {
var dateInRange = _step.value;
if (compareDates(date, dateInRange)) {
return true;
}
}
return false;
}
/**
* Returns the week number for a date.
* Week numbers are 1 - 52 (53) in a year
* @param navigatedDate - A date to find the week number for.
* @param firstDayOfWeek - The first day of the week (0-6, Sunday = 0)
* @param firstWeekOfYear - The first week of the year (1-2)
* @returns The weeks number array for the current month.
*/
export function getWeekNumbersInMonth(weeksInMonth, firstDayOfWeek, firstWeekOfYear, navigatedDate) {
var selectedYear = navigatedDate.getFullYear();
var selectedMonth = navigatedDate.getMonth();
var dayOfMonth = 1;
var fistDayOfMonth = new Date(selectedYear, selectedMonth, dayOfMonth);
var endOfFirstWeek = dayOfMonth + (firstDayOfWeek + TimeConstants.DaysInOneWeek - 1) - adjustWeekDay(firstDayOfWeek, fistDayOfMonth.getDay());
var endOfWeekRange = new Date(selectedYear, selectedMonth, endOfFirstWeek);
dayOfMonth = endOfWeekRange.getDate();
var weeksArray = [];
for (var i = 0; i < weeksInMonth; i++) {
// Get week number for end of week
weeksArray.push(getWeekNumber(endOfWeekRange, firstDayOfWeek, firstWeekOfYear));
dayOfMonth += TimeConstants.DaysInOneWeek;
endOfWeekRange = new Date(selectedYear, selectedMonth, dayOfMonth);
}
return weeksArray;
}
/**
* Returns the week number for a date.
* Week numbers are 1 - 52 (53) in a year
* @param date - A date to find the week number for.
* @param firstDayOfWeek - The first day of the week (0-6, Sunday = 0)
* @param firstWeekOfYear - The first week of the year (1-2)
* @returns The week's number in the year.
*/
export function getWeekNumber(date, firstDayOfWeek, firstWeekOfYear) {
// First four-day week of the year - minumum days count
var fourDayWeek = 4;
switch (firstWeekOfYear) {
case FirstWeekOfYear.FirstFullWeek:
return getWeekOfYearFullDays(date, firstDayOfWeek, TimeConstants.DaysInOneWeek);
case FirstWeekOfYear.FirstFourDayWeek:
return getWeekOfYearFullDays(date, firstDayOfWeek, fourDayWeek);
default:
return getFirstDayWeekOfYear(date, firstDayOfWeek);
}
}
/**
* Gets the date for the first day of the week based on the given date assuming
* the specified first day of the week.
* @param date - The date to find the beginning of the week date for.
* @returns A new date object representing the first day of the week containing the input date.
*/
export function getStartDateOfWeek(date, firstDayOfWeek) {
var daysOffset = firstDayOfWeek - date.getDay();
if (daysOffset > 0) {
// If first day of week is > date, go 1 week back, to ensure resulting date is in the past.
daysOffset -= TimeConstants.DaysInOneWeek;
}
return addDays(date, daysOffset);
}
/**
* Gets the date for the last day of the week based on the given date assuming
* the specified first day of the week.
* @param date - The date to find the beginning of the week date for.
* @returns A new date object representing the first day of the week containing the input date.
*/
export function getEndDateOfWeek(date, firstDayOfWeek) {
var lastDayOfWeek = firstDayOfWeek - 1 >= 0 ? firstDayOfWeek - 1 : TimeConstants.DaysInOneWeek - 1;
var daysOffset = lastDayOfWeek - date.getDay();
if (daysOffset < 0) {
// If last day of week is < date, go 1 week forward, to ensure resulting date is in the future.
daysOffset += TimeConstants.DaysInOneWeek;
}
return addDays(date, daysOffset);
}
/**
* Gets a new date with the time portion zeroed out, i.e., set to midnight
* @param date - The origin date
* @returns A new date with the time set to midnight
*/
function getDatePart(date) {
return new Date(date.getFullYear(), date.getMonth(), date.getDate());
}
/**
* Helper function to assist in date comparisons
*/
export function getDatePartHashValue(date) {
// Generate date hash value created as sum of Date (up to 31 = 5 bits), Month (up to 11 = 4 bits) and Year.
return date.getDate() + (date.getMonth() << 5) + (date.getFullYear() << 9);
}
/**
* Helper function for getWeekNumber.
* Returns week number for a date
* @param date - current selected date.
* @param firstDayOfWeek - The first day of week (0-6, Sunday = 0)
* @param numberOfFullDays - week settings.
* @returns The week's number in the year.
*/
function getWeekOfYearFullDays(date, firstDayOfWeek, numberOfFullDays) {
var dayOfYear = getDayOfYear(date) - 1;
var num = date.getDay() - dayOfYear % TimeConstants.DaysInOneWeek;
var lastDayOfPrevYear = new Date(date.getFullYear() - 1, MonthOfYear.December, 31);
var daysInYear = getDayOfYear(lastDayOfPrevYear) - 1;
var num2 = (firstDayOfWeek - num + 2 * TimeConstants.DaysInOneWeek) % TimeConstants.DaysInOneWeek;
if (num2 !== 0 && num2 >= numberOfFullDays) {
num2 -= TimeConstants.DaysInOneWeek;
}
var num3 = dayOfYear - num2;
if (num3 < 0) {
num -= daysInYear % TimeConstants.DaysInOneWeek;
num2 = (firstDayOfWeek - num + 2 * TimeConstants.DaysInOneWeek) % TimeConstants.DaysInOneWeek;
if (num2 !== 0 && num2 + 1 >= numberOfFullDays) {
num2 -= TimeConstants.DaysInOneWeek;
}
num3 = daysInYear - num2;
}
return Math.floor(num3 / TimeConstants.DaysInOneWeek + 1);
}
/**
* Helper function for getWeekNumber.
* Returns week number for a date
* @param date - current selected date.
* @param firstDayOfWeek - The first day of week (0-6, Sunday = 0)
* @returns The week's number in the year.
*/
function getFirstDayWeekOfYear(date, firstDayOfWeek) {
var num = getDayOfYear(date) - 1;
var num2 = date.getDay() - num % TimeConstants.DaysInOneWeek;
var num3 = (num2 - firstDayOfWeek + 2 * TimeConstants.DaysInOneWeek) % TimeConstants.DaysInOneWeek;
return Math.floor((num + num3) / TimeConstants.DaysInOneWeek + 1);
}
/**
* Helper function for getWeekNumber.
* Returns adjusted week day number when firstDayOfWeek is other than Sunday
* For Week Day Number comparison checks
* @param firstDayOfWeek - The first day of week (0-6, Sunday = 0)
* @param dateWeekDay - shifts number forward to 1 week in case passed as true
* @returns The day of week adjusted to `firstDayOfWeek`; e.g. when `firstDayOfWeek` is Monday (1),
* Sunday becomes 7.
*/
function adjustWeekDay(firstDayOfWeek, dateWeekDay) {
return firstDayOfWeek !== DayOfWeek.Sunday && dateWeekDay < firstDayOfWeek ? dateWeekDay + TimeConstants.DaysInOneWeek : dateWeekDay;
}
/**
* Returns the day number for a date in a year
* The number of days since January 1st in the particular year.
* @param date - A date to find the day number for.
* @returns The day's number in the year.
*/
function getDayOfYear(date) {
var month = date.getMonth();
var year = date.getFullYear();
var daysUntilDate = 0;
for (var i = 0; i < month; i++) {
daysUntilDate += daysInMonth(i + 1, year);
}
daysUntilDate += date.getDate();
return daysUntilDate;
}
/**
* Returns the number of days in the month
* @param month - The month number to target (months 1-12).
* @param year - The year to target.
* @returns The number of days in the month.
*/
function daysInMonth(month, year) {
return new Date(year, month, 0).getDate();
}
//# sourceMappingURL=dateMath.js.map