react-calendar
Advanced tools
Comparing version 4.1.0 to 4.1.1
@@ -6,3 +6,13 @@ import React, { Component } from 'react'; | ||
import type { formatDay as defaultFormatDay, formatLongDate as defaultFormatLongDate, formatMonth as defaultFormatMonth, formatMonthYear as defaultFormatMonthYear, formatShortWeekday as defaultFormatShortWeekday, formatWeekday as defaultFormatWeekday, formatYear as defaultFormatYear } from './shared/dateFormatter'; | ||
type CalendarProps = typeof Calendar.defaultProps & { | ||
declare const defaultProps: { | ||
goToRangeStartOnSelect: boolean; | ||
maxDate: Date; | ||
maxDetail: string; | ||
minDate: Date; | ||
minDetail: string; | ||
returnValue: string; | ||
showNavigation: boolean; | ||
showNeighboringMonth: boolean; | ||
}; | ||
type CalendarProps = typeof defaultProps & { | ||
activeStartDate?: Date; | ||
@@ -9,0 +19,0 @@ allowPartialRange?: boolean; |
@@ -77,2 +77,5 @@ "use strict"; | ||
var utils_1 = require("./shared/utils"); | ||
var baseClassName = 'react-calendar'; | ||
var allViews = ['century', 'decade', 'year', 'month']; | ||
var allValueTypes = ['decade', 'year', 'month', 'day']; | ||
var defaultMinDate = new Date(); | ||
@@ -82,5 +85,12 @@ defaultMinDate.setFullYear(1, 0, 1); | ||
var defaultMaxDate = new Date(8.64e15); | ||
var baseClassName = 'react-calendar'; | ||
var allViews = ['century', 'decade', 'year', 'month']; | ||
var allValueTypes = ['decade', 'year', 'month', 'day']; | ||
var defaultProps = { | ||
goToRangeStartOnSelect: true, | ||
maxDate: defaultMaxDate, | ||
maxDetail: 'month', | ||
minDate: defaultMinDate, | ||
minDetail: 'century', | ||
returnValue: 'start', | ||
showNavigation: true, | ||
showNeighboringMonth: true, | ||
}; | ||
function toDate(value) { | ||
@@ -558,12 +568,3 @@ if (value instanceof Date) { | ||
}; | ||
Calendar.defaultProps = { | ||
goToRangeStartOnSelect: true, | ||
maxDate: defaultMaxDate, | ||
maxDetail: 'month', | ||
minDate: defaultMinDate, | ||
minDetail: 'century', | ||
returnValue: 'start', | ||
showNavigation: true, | ||
showNeighboringMonth: true, | ||
}; | ||
Calendar.defaultProps = defaultProps; | ||
Calendar.propTypes = { | ||
@@ -570,0 +571,0 @@ activeStartDate: isActiveStartDate, |
@@ -30,2 +30,3 @@ "use strict"; | ||
* @param {Date} date Date. | ||
* @returns {Date} Date with hour set to 12. | ||
*/ | ||
@@ -32,0 +33,0 @@ function toSafeHour(date) { |
import type { CalendarType, RangeType } from './types'; | ||
/** | ||
* Gets day of the week of a given date. | ||
* @param {Date} date Date. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Day of the week. | ||
*/ | ||
export declare function getDayOfWeek(date: Date, calendarType?: CalendarType): number; | ||
@@ -6,2 +12,7 @@ /** | ||
*/ | ||
/** | ||
* Gets the year of the beginning of a century of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a century. | ||
*/ | ||
export declare function getBeginOfCenturyYear(date: Date): number; | ||
@@ -11,2 +22,7 @@ /** | ||
*/ | ||
/** | ||
* Gets the year of the beginning of a decade of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a decade. | ||
*/ | ||
export declare function getBeginOfDecadeYear(date: Date): number; | ||
@@ -20,3 +36,4 @@ /** | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {Date} Beginning of a given week. | ||
*/ | ||
@@ -30,3 +47,4 @@ export declare function getBeginOfWeek(date: Date, calendarType?: CalendarType): Date; | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Week number. | ||
*/ | ||
@@ -40,7 +58,22 @@ export declare function getWeekNumber(date: Date, calendarType?: CalendarType): number; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a given range. | ||
*/ | ||
export declare function getBegin(rangeType: RangeType, date: Date): Date; | ||
/** | ||
* Returns the beginning of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a previous given range. | ||
*/ | ||
export declare function getBeginPrevious(rangeType: RangeType, date: Date): Date; | ||
/** | ||
* Returns the beginning of a next given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a next given range. | ||
*/ | ||
export declare function getBeginNext(rangeType: RangeType, date: Date): Date; | ||
@@ -52,6 +85,14 @@ export declare function getBeginPrevious2(rangeType: RangeType, date: Date): Date; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a given range. | ||
*/ | ||
export declare function getEnd(rangeType: RangeType, date: Date): Date; | ||
/** | ||
* Returns the end of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a previous given range. | ||
*/ | ||
export declare function getEndPrevious(rangeType: RangeType, date: Date): Date; | ||
@@ -62,4 +103,5 @@ export declare function getEndPrevious2(rangeType: RangeType, date: Date): Date; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
@@ -70,7 +112,8 @@ export declare function getRange(rangeType: RangeType, date: Date): [Date, Date]; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date1 First date. | ||
* @param {Date} date2 Second date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
export declare function getValueRange(rangeType: RangeType, date1: Date, date2: Date): Date[]; | ||
export declare function getValueRange(rangeType: RangeType, date1: Date, date2: Date): [Date, Date]; | ||
/** | ||
@@ -89,6 +132,7 @@ * @callback FormatYear | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a century of a given date. | ||
*/ | ||
export declare function getCenturyLabel(locale: string | undefined, formatYear: (locale: string | undefined, date: Date) => string, date: Date): string; | ||
/** | ||
* Returns a string labelling a century of a given date. | ||
* Returns a string labelling a decade of a given date. | ||
* For example, for 2017 it will return 2011-2020. | ||
@@ -99,2 +143,3 @@ * | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a decade of a given date. | ||
*/ | ||
@@ -106,2 +151,3 @@ export declare function getDecadeLabel(locale: string | undefined, formatYear: (locale: string | undefined, date: Date) => string, date: Date): string; | ||
* @param {Date} date Date. | ||
* @returns {boolean} Whether a given date is the current day of the week. | ||
*/ | ||
@@ -113,4 +159,5 @@ export declare function isCurrentDayOfWeek(date: Date): boolean; | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {boolean} Whether a given date is a weekend day. | ||
*/ | ||
export declare function isWeekend(date: Date, calendarType?: CalendarType): boolean; |
@@ -11,2 +11,8 @@ "use strict"; | ||
/* Simple getters - getting a property of a given point in time */ | ||
/** | ||
* Gets day of the week of a given date. | ||
* @param {Date} date Date. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Day of the week. | ||
*/ | ||
function getDayOfWeek(date, calendarType) { | ||
@@ -32,2 +38,7 @@ if (calendarType === void 0) { calendarType = const_1.CALENDAR_TYPES.ISO_8601; } | ||
*/ | ||
/** | ||
* Gets the year of the beginning of a century of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a century. | ||
*/ | ||
function getBeginOfCenturyYear(date) { | ||
@@ -41,2 +52,7 @@ var beginOfCentury = (0, date_utils_1.getCenturyStart)(date); | ||
*/ | ||
/** | ||
* Gets the year of the beginning of a decade of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a decade. | ||
*/ | ||
function getBeginOfDecadeYear(date) { | ||
@@ -54,3 +70,4 @@ var beginOfDecade = (0, date_utils_1.getDecadeStart)(date); | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {Date} Beginning of a given week. | ||
*/ | ||
@@ -71,3 +88,4 @@ function getBeginOfWeek(date, calendarType) { | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Week number. | ||
*/ | ||
@@ -96,4 +114,5 @@ function getWeekNumber(date, calendarType) { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a given range. | ||
*/ | ||
@@ -117,2 +136,9 @@ function getBegin(rangeType, date) { | ||
exports.getBegin = getBegin; | ||
/** | ||
* Returns the beginning of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a previous given range. | ||
*/ | ||
function getBeginPrevious(rangeType, date) { | ||
@@ -133,2 +159,9 @@ switch (rangeType) { | ||
exports.getBeginPrevious = getBeginPrevious; | ||
/** | ||
* Returns the beginning of a next given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a next given range. | ||
*/ | ||
function getBeginNext(rangeType, date) { | ||
@@ -178,4 +211,5 @@ switch (rangeType) { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a given range. | ||
*/ | ||
@@ -199,2 +233,9 @@ function getEnd(rangeType, date) { | ||
exports.getEnd = getEnd; | ||
/** | ||
* Returns the end of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a previous given range. | ||
*/ | ||
function getEndPrevious(rangeType, date) { | ||
@@ -231,4 +272,5 @@ switch (rangeType) { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
@@ -255,5 +297,6 @@ function getRange(rangeType, date) { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date1 First date. | ||
* @param {Date} date2 Second date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
@@ -282,2 +325,3 @@ function getValueRange(rangeType, date1, date2) { | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a century of a given date. | ||
*/ | ||
@@ -289,3 +333,3 @@ function getCenturyLabel(locale, formatYear, date) { | ||
/** | ||
* Returns a string labelling a century of a given date. | ||
* Returns a string labelling a decade of a given date. | ||
* For example, for 2017 it will return 2011-2020. | ||
@@ -296,2 +340,3 @@ * | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a decade of a given date. | ||
*/ | ||
@@ -306,2 +351,3 @@ function getDecadeLabel(locale, formatYear, date) { | ||
* @param {Date} date Date. | ||
* @returns {boolean} Whether a given date is the current day of the week. | ||
*/ | ||
@@ -316,3 +362,4 @@ function isCurrentDayOfWeek(date) { | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {boolean} Whether a given date is a weekend day. | ||
*/ | ||
@@ -319,0 +366,0 @@ function isWeekend(date, calendarType) { |
/// <reference types="react" /> | ||
import type { CALENDAR_TYPES } from './const'; | ||
export type Action = 'prev' | 'prev2' | 'next' | 'next2' | 'onChange' | 'drillUp' | 'drillDown'; | ||
export type CalendarType = typeof CALENDAR_TYPES[keyof typeof CALENDAR_TYPES]; | ||
export type ClassName = string | string[]; | ||
export type CalendarType = (typeof CALENDAR_TYPES)[keyof typeof CALENDAR_TYPES]; | ||
export type ClassName = string | null | undefined | (string | null | undefined)[]; | ||
export type Detail = 'century' | 'decade' | 'year' | 'month'; | ||
@@ -7,0 +7,0 @@ export type LooseValue = string | Date | null | (Date | null)[]; |
@@ -8,2 +8,3 @@ import type { Range, RangeType } from './types'; | ||
* @param {Date} max Maximum return value. | ||
* @returns {Date} Value between min and max. | ||
*/ | ||
@@ -10,0 +11,0 @@ export declare function between<T extends Date>(value: T, min?: T | null, max?: T | null): T; |
@@ -11,2 +11,3 @@ "use strict"; | ||
* @param {Date} max Maximum return value. | ||
* @returns {Date} Value between min and max. | ||
*/ | ||
@@ -13,0 +14,0 @@ function between(value, min, max) { |
@@ -6,3 +6,13 @@ import React, { Component } from 'react'; | ||
import type { formatDay as defaultFormatDay, formatLongDate as defaultFormatLongDate, formatMonth as defaultFormatMonth, formatMonthYear as defaultFormatMonthYear, formatShortWeekday as defaultFormatShortWeekday, formatWeekday as defaultFormatWeekday, formatYear as defaultFormatYear } from './shared/dateFormatter'; | ||
type CalendarProps = typeof Calendar.defaultProps & { | ||
declare const defaultProps: { | ||
goToRangeStartOnSelect: boolean; | ||
maxDate: Date; | ||
maxDetail: string; | ||
minDate: Date; | ||
minDetail: string; | ||
returnValue: string; | ||
showNavigation: boolean; | ||
showNeighboringMonth: boolean; | ||
}; | ||
type CalendarProps = typeof defaultProps & { | ||
activeStartDate?: Date; | ||
@@ -9,0 +19,0 @@ allowPartialRange?: boolean; |
@@ -49,2 +49,5 @@ var __extends = (this && this.__extends) || (function () { | ||
import { between } from './shared/utils'; | ||
var baseClassName = 'react-calendar'; | ||
var allViews = ['century', 'decade', 'year', 'month']; | ||
var allValueTypes = ['decade', 'year', 'month', 'day']; | ||
var defaultMinDate = new Date(); | ||
@@ -54,5 +57,12 @@ defaultMinDate.setFullYear(1, 0, 1); | ||
var defaultMaxDate = new Date(8.64e15); | ||
var baseClassName = 'react-calendar'; | ||
var allViews = ['century', 'decade', 'year', 'month']; | ||
var allValueTypes = ['decade', 'year', 'month', 'day']; | ||
var defaultProps = { | ||
goToRangeStartOnSelect: true, | ||
maxDate: defaultMaxDate, | ||
maxDetail: 'month', | ||
minDate: defaultMinDate, | ||
minDetail: 'century', | ||
returnValue: 'start', | ||
showNavigation: true, | ||
showNeighboringMonth: true, | ||
}; | ||
function toDate(value) { | ||
@@ -530,12 +540,3 @@ if (value instanceof Date) { | ||
}; | ||
Calendar.defaultProps = { | ||
goToRangeStartOnSelect: true, | ||
maxDate: defaultMaxDate, | ||
maxDetail: 'month', | ||
minDate: defaultMinDate, | ||
minDetail: 'century', | ||
returnValue: 'start', | ||
showNavigation: true, | ||
showNeighboringMonth: true, | ||
}; | ||
Calendar.defaultProps = defaultProps; | ||
Calendar.propTypes = { | ||
@@ -542,0 +543,0 @@ activeStartDate: isActiveStartDate, |
@@ -24,2 +24,3 @@ import getUserLocale from 'get-user-locale'; | ||
* @param {Date} date Date. | ||
* @returns {Date} Date with hour set to 12. | ||
*/ | ||
@@ -26,0 +27,0 @@ function toSafeHour(date) { |
import type { CalendarType, RangeType } from './types'; | ||
/** | ||
* Gets day of the week of a given date. | ||
* @param {Date} date Date. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Day of the week. | ||
*/ | ||
export declare function getDayOfWeek(date: Date, calendarType?: CalendarType): number; | ||
@@ -6,2 +12,7 @@ /** | ||
*/ | ||
/** | ||
* Gets the year of the beginning of a century of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a century. | ||
*/ | ||
export declare function getBeginOfCenturyYear(date: Date): number; | ||
@@ -11,2 +22,7 @@ /** | ||
*/ | ||
/** | ||
* Gets the year of the beginning of a decade of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a decade. | ||
*/ | ||
export declare function getBeginOfDecadeYear(date: Date): number; | ||
@@ -20,3 +36,4 @@ /** | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {Date} Beginning of a given week. | ||
*/ | ||
@@ -30,3 +47,4 @@ export declare function getBeginOfWeek(date: Date, calendarType?: CalendarType): Date; | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Week number. | ||
*/ | ||
@@ -40,7 +58,22 @@ export declare function getWeekNumber(date: Date, calendarType?: CalendarType): number; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a given range. | ||
*/ | ||
export declare function getBegin(rangeType: RangeType, date: Date): Date; | ||
/** | ||
* Returns the beginning of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a previous given range. | ||
*/ | ||
export declare function getBeginPrevious(rangeType: RangeType, date: Date): Date; | ||
/** | ||
* Returns the beginning of a next given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a next given range. | ||
*/ | ||
export declare function getBeginNext(rangeType: RangeType, date: Date): Date; | ||
@@ -52,6 +85,14 @@ export declare function getBeginPrevious2(rangeType: RangeType, date: Date): Date; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a given range. | ||
*/ | ||
export declare function getEnd(rangeType: RangeType, date: Date): Date; | ||
/** | ||
* Returns the end of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a previous given range. | ||
*/ | ||
export declare function getEndPrevious(rangeType: RangeType, date: Date): Date; | ||
@@ -62,4 +103,5 @@ export declare function getEndPrevious2(rangeType: RangeType, date: Date): Date; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
@@ -70,7 +112,8 @@ export declare function getRange(rangeType: RangeType, date: Date): [Date, Date]; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date1 First date. | ||
* @param {Date} date2 Second date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
export declare function getValueRange(rangeType: RangeType, date1: Date, date2: Date): Date[]; | ||
export declare function getValueRange(rangeType: RangeType, date1: Date, date2: Date): [Date, Date]; | ||
/** | ||
@@ -89,6 +132,7 @@ * @callback FormatYear | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a century of a given date. | ||
*/ | ||
export declare function getCenturyLabel(locale: string | undefined, formatYear: (locale: string | undefined, date: Date) => string, date: Date): string; | ||
/** | ||
* Returns a string labelling a century of a given date. | ||
* Returns a string labelling a decade of a given date. | ||
* For example, for 2017 it will return 2011-2020. | ||
@@ -99,2 +143,3 @@ * | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a decade of a given date. | ||
*/ | ||
@@ -106,2 +151,3 @@ export declare function getDecadeLabel(locale: string | undefined, formatYear: (locale: string | undefined, date: Date) => string, date: Date): string; | ||
* @param {Date} date Date. | ||
* @returns {boolean} Whether a given date is the current day of the week. | ||
*/ | ||
@@ -113,4 +159,5 @@ export declare function isCurrentDayOfWeek(date: Date): boolean; | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {boolean} Whether a given date is a weekend day. | ||
*/ | ||
export declare function isWeekend(date: Date, calendarType?: CalendarType): boolean; |
@@ -8,2 +8,8 @@ import { getYear, getMonth as getMonthIndex, getCenturyStart, getPreviousCenturyStart, getNextCenturyStart, getCenturyEnd, getPreviousCenturyEnd, getCenturyRange, getDecadeStart, getPreviousDecadeStart, getNextDecadeStart, getDecadeEnd, getPreviousDecadeEnd, getDecadeRange, getYearStart, getPreviousYearStart, getNextYearStart, getYearEnd, getPreviousYearEnd, getYearRange, getMonthStart, getPreviousMonthStart, getNextMonthStart, getMonthEnd, getPreviousMonthEnd, getMonthRange, getDayStart, getDayEnd, getDayRange, } from '@wojtekmaj/date-utils'; | ||
/* Simple getters - getting a property of a given point in time */ | ||
/** | ||
* Gets day of the week of a given date. | ||
* @param {Date} date Date. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Day of the week. | ||
*/ | ||
export function getDayOfWeek(date, calendarType) { | ||
@@ -28,2 +34,7 @@ if (calendarType === void 0) { calendarType = CALENDAR_TYPES.ISO_8601; } | ||
*/ | ||
/** | ||
* Gets the year of the beginning of a century of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a century. | ||
*/ | ||
export function getBeginOfCenturyYear(date) { | ||
@@ -36,2 +47,7 @@ var beginOfCentury = getCenturyStart(date); | ||
*/ | ||
/** | ||
* Gets the year of the beginning of a decade of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a decade. | ||
*/ | ||
export function getBeginOfDecadeYear(date) { | ||
@@ -48,3 +64,4 @@ var beginOfDecade = getDecadeStart(date); | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {Date} Beginning of a given week. | ||
*/ | ||
@@ -64,3 +81,4 @@ export function getBeginOfWeek(date, calendarType) { | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Week number. | ||
*/ | ||
@@ -88,4 +106,5 @@ export function getWeekNumber(date, calendarType) { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a given range. | ||
*/ | ||
@@ -108,2 +127,9 @@ export function getBegin(rangeType, date) { | ||
} | ||
/** | ||
* Returns the beginning of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a previous given range. | ||
*/ | ||
export function getBeginPrevious(rangeType, date) { | ||
@@ -123,2 +149,9 @@ switch (rangeType) { | ||
} | ||
/** | ||
* Returns the beginning of a next given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a next given range. | ||
*/ | ||
export function getBeginNext(rangeType, date) { | ||
@@ -165,4 +198,5 @@ switch (rangeType) { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a given range. | ||
*/ | ||
@@ -185,2 +219,9 @@ export function getEnd(rangeType, date) { | ||
} | ||
/** | ||
* Returns the end of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a previous given range. | ||
*/ | ||
export function getEndPrevious(rangeType, date) { | ||
@@ -215,4 +256,5 @@ switch (rangeType) { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
@@ -238,5 +280,6 @@ export function getRange(rangeType, date) { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date1 First date. | ||
* @param {Date} date2 Second date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
@@ -264,2 +307,3 @@ export function getValueRange(rangeType, date1, date2) { | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a century of a given date. | ||
*/ | ||
@@ -270,3 +314,3 @@ export function getCenturyLabel(locale, formatYear, date) { | ||
/** | ||
* Returns a string labelling a century of a given date. | ||
* Returns a string labelling a decade of a given date. | ||
* For example, for 2017 it will return 2011-2020. | ||
@@ -277,2 +321,3 @@ * | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a decade of a given date. | ||
*/ | ||
@@ -286,2 +331,3 @@ export function getDecadeLabel(locale, formatYear, date) { | ||
* @param {Date} date Date. | ||
* @returns {boolean} Whether a given date is the current day of the week. | ||
*/ | ||
@@ -295,3 +341,4 @@ export function isCurrentDayOfWeek(date) { | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {boolean} Whether a given date is a weekend day. | ||
*/ | ||
@@ -298,0 +345,0 @@ export function isWeekend(date, calendarType) { |
/// <reference types="react" /> | ||
import type { CALENDAR_TYPES } from './const'; | ||
export type Action = 'prev' | 'prev2' | 'next' | 'next2' | 'onChange' | 'drillUp' | 'drillDown'; | ||
export type CalendarType = typeof CALENDAR_TYPES[keyof typeof CALENDAR_TYPES]; | ||
export type ClassName = string | string[]; | ||
export type CalendarType = (typeof CALENDAR_TYPES)[keyof typeof CALENDAR_TYPES]; | ||
export type ClassName = string | null | undefined | (string | null | undefined)[]; | ||
export type Detail = 'century' | 'decade' | 'year' | 'month'; | ||
@@ -7,0 +7,0 @@ export type LooseValue = string | Date | null | (Date | null)[]; |
@@ -8,2 +8,3 @@ import type { Range, RangeType } from './types'; | ||
* @param {Date} max Maximum return value. | ||
* @returns {Date} Value between min and max. | ||
*/ | ||
@@ -10,0 +11,0 @@ export declare function between<T extends Date>(value: T, min?: T | null, max?: T | null): T; |
@@ -8,2 +8,3 @@ import { getRange } from './dates'; | ||
* @param {Date} max Maximum return value. | ||
* @returns {Date} Value between min and max. | ||
*/ | ||
@@ -10,0 +11,0 @@ export function between(value, min, max) { |
{ | ||
"name": "react-calendar", | ||
"version": "4.1.0", | ||
"version": "4.1.1", | ||
"description": "Ultimate calendar for your React app.", | ||
@@ -42,3 +42,3 @@ "main": "dist/cjs/index.js", | ||
"clsx": "^1.2.1", | ||
"get-user-locale": "^2.1.3", | ||
"get-user-locale": "^2.2.1", | ||
"prop-types": "^15.6.0" | ||
@@ -50,3 +50,3 @@ }, | ||
"eslint": "^8.26.0", | ||
"eslint-config-wojtekmaj": "^0.8.2", | ||
"eslint-config-wojtekmaj": "^0.8.3", | ||
"husky": "^8.0.0", | ||
@@ -53,0 +53,0 @@ "jsdom": "^21.1.0", |
@@ -36,2 +36,3 @@ import getUserLocale from 'get-user-locale'; | ||
* @param {Date} date Date. | ||
* @returns {Date} Date with hour set to 12. | ||
*/ | ||
@@ -38,0 +39,0 @@ function toSafeHour(date: Date): Date { |
@@ -44,3 +44,12 @@ import { | ||
export function getDayOfWeek(date: Date, calendarType: CalendarType = CALENDAR_TYPES.ISO_8601) { | ||
/** | ||
* Gets day of the week of a given date. | ||
* @param {Date} date Date. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Day of the week. | ||
*/ | ||
export function getDayOfWeek( | ||
date: Date, | ||
calendarType: CalendarType = CALENDAR_TYPES.ISO_8601, | ||
): number { | ||
const weekday = date.getDay(); | ||
@@ -66,3 +75,8 @@ | ||
export function getBeginOfCenturyYear(date: Date) { | ||
/** | ||
* Gets the year of the beginning of a century of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a century. | ||
*/ | ||
export function getBeginOfCenturyYear(date: Date): number { | ||
const beginOfCentury = getCenturyStart(date); | ||
@@ -75,3 +89,9 @@ return getYear(beginOfCentury); | ||
*/ | ||
export function getBeginOfDecadeYear(date: Date) { | ||
/** | ||
* Gets the year of the beginning of a decade of a given date. | ||
* @param {Date} date Date. | ||
* @returns {number} Year of the beginning of a decade. | ||
*/ | ||
export function getBeginOfDecadeYear(date: Date): number { | ||
const beginOfDecade = getDecadeStart(date); | ||
@@ -89,5 +109,9 @@ return getYear(beginOfDecade); | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {Date} Beginning of a given week. | ||
*/ | ||
export function getBeginOfWeek(date: Date, calendarType: CalendarType = CALENDAR_TYPES.ISO_8601) { | ||
export function getBeginOfWeek( | ||
date: Date, | ||
calendarType: CalendarType = CALENDAR_TYPES.ISO_8601, | ||
): Date { | ||
const year = getYear(date); | ||
@@ -105,5 +129,9 @@ const monthIndex = getMonthIndex(date); | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {number} Week number. | ||
*/ | ||
export function getWeekNumber(date: Date, calendarType: CalendarType = CALENDAR_TYPES.ISO_8601) { | ||
export function getWeekNumber( | ||
date: Date, | ||
calendarType: CalendarType = CALENDAR_TYPES.ISO_8601, | ||
): number { | ||
const calendarTypeForWeekNumber = | ||
@@ -133,6 +161,7 @@ calendarType === CALENDAR_TYPES.US ? CALENDAR_TYPES.US : CALENDAR_TYPES.ISO_8601; | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a given range. | ||
*/ | ||
export function getBegin(rangeType: RangeType, date: Date) { | ||
export function getBegin(rangeType: RangeType, date: Date): Date { | ||
switch (rangeType) { | ||
@@ -154,3 +183,10 @@ case 'century': | ||
export function getBeginPrevious(rangeType: RangeType, date: Date) { | ||
/** | ||
* Returns the beginning of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a previous given range. | ||
*/ | ||
export function getBeginPrevious(rangeType: RangeType, date: Date): Date { | ||
switch (rangeType) { | ||
@@ -170,3 +206,10 @@ case 'century': | ||
export function getBeginNext(rangeType: RangeType, date: Date) { | ||
/** | ||
* Returns the beginning of a next given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} Beginning of a next given range. | ||
*/ | ||
export function getBeginNext(rangeType: RangeType, date: Date): Date { | ||
switch (rangeType) { | ||
@@ -186,3 +229,3 @@ case 'century': | ||
export function getBeginPrevious2(rangeType: RangeType, date: Date) { | ||
export function getBeginPrevious2(rangeType: RangeType, date: Date): Date { | ||
switch (rangeType) { | ||
@@ -200,3 +243,3 @@ case 'decade': | ||
export function getBeginNext2(rangeType: RangeType, date: Date) { | ||
export function getBeginNext2(rangeType: RangeType, date: Date): Date { | ||
switch (rangeType) { | ||
@@ -217,6 +260,7 @@ case 'decade': | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a given range. | ||
*/ | ||
export function getEnd(rangeType: RangeType, date: Date) { | ||
export function getEnd(rangeType: RangeType, date: Date): Date { | ||
switch (rangeType) { | ||
@@ -238,3 +282,10 @@ case 'century': | ||
export function getEndPrevious(rangeType: RangeType, date: Date) { | ||
/** | ||
* Returns the end of a previous given range. | ||
* | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date} End of a previous given range. | ||
*/ | ||
export function getEndPrevious(rangeType: RangeType, date: Date): Date { | ||
switch (rangeType) { | ||
@@ -254,3 +305,3 @@ case 'century': | ||
export function getEndPrevious2(rangeType: RangeType, date: Date) { | ||
export function getEndPrevious2(rangeType: RangeType, date: Date): Date { | ||
switch (rangeType) { | ||
@@ -271,4 +322,5 @@ case 'decade': | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date Date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
@@ -295,7 +347,8 @@ export function getRange(rangeType: RangeType, date: Date): [Date, Date] { | ||
* | ||
* @param {string} rangeType Range type (e.g. 'day') | ||
* @param {RangeType} rangeType Range type (e.g. 'day') | ||
* @param {Date} date1 First date. | ||
* @param {Date} date2 Second date. | ||
* @returns {Date[]} Beginning and end of a given range. | ||
*/ | ||
export function getValueRange(rangeType: RangeType, date1: Date, date2: Date) { | ||
export function getValueRange(rangeType: RangeType, date1: Date, date2: Date): [Date, Date] { | ||
const rawNextValue = [date1, date2].sort((a, b) => a.getTime() - b.getTime()) as [Date, Date]; | ||
@@ -309,3 +362,3 @@ return [getBegin(rangeType, rawNextValue[0]), getEnd(rangeType, rawNextValue[1])]; | ||
dates: Date[], | ||
) { | ||
): string { | ||
return dates.map((date) => formatYear(locale, date)).join(' – '); | ||
@@ -328,2 +381,3 @@ } | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a century of a given date. | ||
*/ | ||
@@ -334,3 +388,3 @@ export function getCenturyLabel( | ||
date: Date, | ||
) { | ||
): string { | ||
return toYearLabel(locale, formatYear, getCenturyRange(date)); | ||
@@ -340,3 +394,3 @@ } | ||
/** | ||
* Returns a string labelling a century of a given date. | ||
* Returns a string labelling a decade of a given date. | ||
* For example, for 2017 it will return 2011-2020. | ||
@@ -347,2 +401,3 @@ * | ||
* @param {Date|string|number} date Date or a year as a string or as a number. | ||
* @returns {string} String labelling a decade of a given date. | ||
*/ | ||
@@ -353,3 +408,3 @@ export function getDecadeLabel( | ||
date: Date, | ||
) { | ||
): string { | ||
return toYearLabel(locale, formatYear, getDecadeRange(date)); | ||
@@ -362,4 +417,5 @@ } | ||
* @param {Date} date Date. | ||
* @returns {boolean} Whether a given date is the current day of the week. | ||
*/ | ||
export function isCurrentDayOfWeek(date: Date) { | ||
export function isCurrentDayOfWeek(date: Date): boolean { | ||
return date.getDay() === new Date().getDay(); | ||
@@ -372,6 +428,11 @@ } | ||
* @param {Date} date Date. | ||
* @param {string} [calendarType="ISO 8601"] Calendar type. | ||
* @param {CalendarType} [calendarType="ISO 8601"] Calendar type. | ||
* @returns {boolean} Whether a given date is a weekend day. | ||
*/ | ||
export function isWeekend(date: Date, calendarType: CalendarType = CALENDAR_TYPES.ISO_8601) { | ||
export function isWeekend( | ||
date: Date, | ||
calendarType: CalendarType = CALENDAR_TYPES.ISO_8601, | ||
): boolean { | ||
const weekday = date.getDay(); | ||
switch (calendarType) { | ||
@@ -378,0 +439,0 @@ case CALENDAR_TYPES.ARABIC: |
@@ -5,5 +5,5 @@ import type { CALENDAR_TYPES } from './const'; | ||
export type CalendarType = typeof CALENDAR_TYPES[keyof typeof CALENDAR_TYPES]; | ||
export type CalendarType = (typeof CALENDAR_TYPES)[keyof typeof CALENDAR_TYPES]; | ||
export type ClassName = string | string[]; | ||
export type ClassName = string | null | undefined | (string | null | undefined)[]; | ||
@@ -10,0 +10,0 @@ export type Detail = 'century' | 'decade' | 'year' | 'month'; |
@@ -11,2 +11,3 @@ import { getRange } from './dates'; | ||
* @param {Date} max Maximum return value. | ||
* @returns {Date} Value between min and max. | ||
*/ | ||
@@ -13,0 +14,0 @@ export function between<T extends Date>(value: T, min?: T | null, max?: T | null): T { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
600000
13063
0
+ Added@types/react@18.3.11(transitive)
- Removed@types/react@18.3.12(transitive)
Updatedget-user-locale@^2.2.1