@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
654 lines (653 loc) • 19.3 kB
JavaScript
/*!
* All material copyright ESRI, All Rights Reserved, unless otherwise specified.
* See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
* v1.5.0-next.4
*/
import { h, Host } from "@stencil/core";
import { dateFromRange, inRange, sameDate } from "../../utils/date";
const DAYS_PER_WEEK = 7;
const DAYS_MAXIMUM_INDEX = 6;
export class DatePickerMonth {
constructor() {
//--------------------------------------------------------------------------
//
// Event Listeners
//
//--------------------------------------------------------------------------
this.keyDownHandler = (event) => {
if (event.defaultPrevented) {
return;
}
const isRTL = this.el.dir === "rtl";
switch (event.key) {
case "ArrowUp":
event.preventDefault();
this.addDays(-7);
break;
case "ArrowRight":
event.preventDefault();
this.addDays(isRTL ? -1 : 1);
break;
case "ArrowDown":
event.preventDefault();
this.addDays(7);
break;
case "ArrowLeft":
event.preventDefault();
this.addDays(isRTL ? 1 : -1);
break;
case "PageUp":
event.preventDefault();
this.addMonths(-1);
break;
case "PageDown":
event.preventDefault();
this.addMonths(1);
break;
case "Home":
event.preventDefault();
this.activeDate.setDate(1);
this.addDays();
break;
case "End":
event.preventDefault();
this.activeDate.setDate(new Date(this.activeDate.getFullYear(), this.activeDate.getMonth() + 1, 0).getDate());
this.addDays();
break;
case "Enter":
case " ":
event.preventDefault();
break;
case "Tab":
this.activeFocus = false;
}
};
/**
* Once user is not interacting via keyboard,
* disable auto focusing of active date
*/
this.disableActiveFocus = () => {
this.activeFocus = false;
};
this.dayHover = (event) => {
const target = event.target;
if (target.disabled) {
this.calciteInternalDatePickerMouseOut.emit();
}
else {
this.calciteInternalDatePickerHover.emit(target.value);
}
event.stopPropagation();
};
this.daySelect = (event) => {
const target = event.target;
this.calciteInternalDatePickerSelect.emit(target.value);
};
this.dateTimeFormat = undefined;
this.selectedDate = undefined;
this.activeDate = new Date();
this.startDate = undefined;
this.endDate = undefined;
this.min = undefined;
this.max = undefined;
this.scale = undefined;
this.localeData = undefined;
this.hoverRange = undefined;
}
pointerOutHandler() {
this.calciteInternalDatePickerMouseOut.emit();
}
//--------------------------------------------------------------------------
//
// Lifecycle
//
//--------------------------------------------------------------------------
render() {
const month = this.activeDate.getMonth();
const year = this.activeDate.getFullYear();
const startOfWeek = this.localeData.weekStart % 7;
const { abbreviated, short, narrow } = this.localeData.days;
const weekDays = this.scale === "s" ? narrow || short || abbreviated : short || abbreviated || narrow;
const adjustedWeekDays = [...weekDays.slice(startOfWeek, 7), ...weekDays.slice(0, startOfWeek)];
const curMonDays = this.getCurrentMonthDays(month, year);
const prevMonDays = this.getPreviousMonthDays(month, year, startOfWeek);
const nextMonDays = this.getNextMonthDays(month, year, startOfWeek);
let dayInWeek = 0;
const getDayInWeek = () => dayInWeek++ % 7;
const days = [
...prevMonDays.map((day) => {
return {
active: false,
day,
dayInWeek: getDayInWeek(),
date: new Date(year, month - 1, day)
};
}),
...curMonDays.map((day) => {
const date = new Date(year, month, day);
const active = sameDate(date, this.activeDate);
return {
active,
currentMonth: true,
day,
dayInWeek: getDayInWeek(),
date,
ref: true
};
}),
...nextMonDays.map((day) => {
return {
active: false,
day,
dayInWeek: getDayInWeek(),
date: new Date(year, month + 1, day)
};
})
];
const weeks = [];
for (let i = 0; i < days.length; i += 7) {
weeks.push(days.slice(i, i + 7));
}
return (h(Host, { onFocusOut: this.disableActiveFocus, onKeyDown: this.keyDownHandler }, h("div", { class: "calendar", role: "grid" }, h("div", { class: "week-headers", role: "row" }, adjustedWeekDays.map((weekday) => (h("span", { class: "week-header", role: "columnheader" }, weekday)))), weeks.map((days) => (h("div", { class: "week-days", role: "row" }, days.map((day) => this.renderDateDay(day))))))));
}
//--------------------------------------------------------------------------
//
// Private Methods
//
//--------------------------------------------------------------------------
/**
* Add n months to the current month
*
* @param step
*/
addMonths(step) {
const nextDate = new Date(this.activeDate);
nextDate.setMonth(this.activeDate.getMonth() + step);
this.calciteInternalDatePickerActiveDateChange.emit(dateFromRange(nextDate, this.min, this.max));
this.activeFocus = true;
}
/**
* Add n days to the current date
*
* @param step
*/
addDays(step = 0) {
const nextDate = new Date(this.activeDate);
nextDate.setDate(this.activeDate.getDate() + step);
this.calciteInternalDatePickerActiveDateChange.emit(dateFromRange(nextDate, this.min, this.max));
this.activeFocus = true;
}
/**
* Get dates for last days of the previous month
*
* @param month
* @param year
* @param startOfWeek
*/
getPreviousMonthDays(month, year, startOfWeek) {
const lastDate = new Date(year, month, 0);
const date = lastDate.getDate();
const startDay = lastDate.getDay();
const days = [];
if (startDay === (startOfWeek + DAYS_MAXIMUM_INDEX) % DAYS_PER_WEEK) {
return days;
}
if (startDay === startOfWeek) {
return [date];
}
for (let i = (DAYS_PER_WEEK + startDay - startOfWeek) % DAYS_PER_WEEK; i >= 0; i--) {
days.push(date - i);
}
return days;
}
/**
* Get dates for the current month
*
* @param month
* @param year
*/
getCurrentMonthDays(month, year) {
const num = new Date(year, month + 1, 0).getDate();
const days = [];
for (let i = 0; i < num; i++) {
days.push(i + 1);
}
return days;
}
/**
* Get dates for first days of the next month
*
* @param month
* @param year
* @param startOfWeek
*/
getNextMonthDays(month, year, startOfWeek) {
const endDay = new Date(year, month + 1, 0).getDay();
const days = [];
if (endDay === (startOfWeek + DAYS_MAXIMUM_INDEX) % DAYS_PER_WEEK) {
return days;
}
for (let i = 0; i < (DAYS_MAXIMUM_INDEX - (endDay - startOfWeek)) % DAYS_PER_WEEK; i++) {
days.push(i + 1);
}
return days;
}
/**
* Determine if the date is in between the start and end dates
*
* @param date
*/
betweenSelectedRange(date) {
return !!(this.startDate &&
this.endDate &&
date > this.startDate &&
date < this.endDate &&
!this.isRangeHover(date));
}
/**
* Determine if the date should be in selected state
*
* @param date
*/
isSelected(date) {
return !!(sameDate(date, this.selectedDate) ||
(this.startDate && sameDate(date, this.startDate)) ||
(this.endDate && sameDate(date, this.endDate)));
}
/**
* Determine if the date is the start of the date range
*
* @param date
*/
isStartOfRange(date) {
return !!(this.startDate &&
!sameDate(this.startDate, this.endDate) &&
sameDate(this.startDate, date) &&
!this.isEndOfRange(date));
}
isEndOfRange(date) {
return !!((this.endDate && !sameDate(this.startDate, this.endDate) && sameDate(this.endDate, date)) ||
(!this.endDate &&
this.hoverRange &&
sameDate(this.startDate, this.hoverRange.end) &&
sameDate(date, this.hoverRange.end)));
}
/**
* Render calcite-date-picker-day
*
* @param active.active
* @param active
* @param day
* @param dayInWeek
* @param date
* @param currentMonth
* @param ref
* @param active.currentMonth
* @param active.date
* @param active.day
* @param active.dayInWeek
* @param active.ref
*/
renderDateDay({ active, currentMonth, date, day, dayInWeek, ref }) {
const isFocusedOnStart = this.isFocusedOnStart();
const isHoverInRange = this.isHoverInRange() ||
(!this.endDate && this.hoverRange && sameDate(this.hoverRange?.end, this.startDate));
return (h("div", { class: "day", key: date.toDateString(), role: "gridcell" }, h("calcite-date-picker-day", { active: active, class: {
"hover--inside-range": this.startDate && isHoverInRange,
"hover--outside-range": this.startDate && !isHoverInRange,
"focused--start": isFocusedOnStart,
"focused--end": !isFocusedOnStart
}, currentMonth: currentMonth, dateTimeFormat: this.dateTimeFormat, day: day, disabled: !inRange(date, this.min, this.max), endOfRange: this.isEndOfRange(date), highlighted: this.betweenSelectedRange(date), onCalciteDaySelect: this.daySelect, onCalciteInternalDayHover: this.dayHover, range: !!this.startDate && !!this.endDate && !sameDate(this.startDate, this.endDate), rangeEdge: dayInWeek === 0 ? "start" : dayInWeek === 6 ? "end" : undefined, rangeHover: this.isRangeHover(date), scale: this.scale, selected: this.isSelected(date), startOfRange: this.isStartOfRange(date), value: date,
// eslint-disable-next-line react/jsx-sort-props
ref: (el) => {
// when moving via keyboard, focus must be updated on active date
if (ref && active && this.activeFocus) {
el?.focus();
}
} })));
}
isFocusedOnStart() {
return this.hoverRange?.focused === "start";
}
isHoverInRange() {
if (!this.hoverRange) {
return false;
}
const { start, end } = this.hoverRange;
return !!((!this.isFocusedOnStart() && this.startDate && (!this.endDate || end < this.endDate)) ||
(this.isFocusedOnStart() && this.startDate && start > this.startDate));
}
isRangeHover(date) {
if (!this.hoverRange) {
return false;
}
const { start, end } = this.hoverRange;
const isStart = this.isFocusedOnStart();
const insideRange = this.isHoverInRange();
const cond1 = insideRange &&
((!isStart && date > this.startDate && (date < end || sameDate(date, end))) ||
(isStart && date < this.endDate && (date > start || sameDate(date, start))));
const cond2 = !insideRange &&
((!isStart && date >= this.endDate && (date < end || sameDate(date, end))) ||
(isStart &&
((this.startDate && date < this.startDate) ||
(this.endDate && sameDate(date, this.startDate))) &&
((start && date > start) || sameDate(date, start))));
return cond1 || cond2;
}
static get is() { return "calcite-date-picker-month"; }
static get encapsulation() { return "shadow"; }
static get originalStyleUrls() {
return {
"$": ["date-picker-month.scss"]
};
}
static get styleUrls() {
return {
"$": ["date-picker-month.css"]
};
}
static get properties() {
return {
"dateTimeFormat": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "Intl.DateTimeFormat",
"resolved": "DateTimeFormat",
"references": {
"Intl": {
"location": "global"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [{
"name": "internal",
"text": undefined
}],
"text": "The DateTimeFormat used to provide screen reader labels."
}
},
"selectedDate": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "Already selected date."
}
},
"activeDate": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "Date currently active."
},
"defaultValue": "new Date()"
},
"startDate": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "Start date currently active."
}
},
"endDate": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "End date currently active"
}
},
"min": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "Specifies the earliest allowed date (`\"yyyy-mm-dd\"`)."
}
},
"max": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "Specifies the latest allowed date (`\"yyyy-mm-dd\"`)."
}
},
"scale": {
"type": "string",
"mutable": false,
"complexType": {
"original": "Scale",
"resolved": "\"l\" | \"m\" | \"s\"",
"references": {
"Scale": {
"location": "import",
"path": "../interfaces"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "Specifies the size of the component."
},
"attribute": "scale",
"reflect": true
},
"localeData": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "DateLocaleData",
"resolved": "DateLocaleData",
"references": {
"DateLocaleData": {
"location": "import",
"path": "../date-picker/utils"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [{
"name": "internal",
"text": undefined
}],
"text": "CLDR locale data for current locale"
}
},
"hoverRange": {
"type": "unknown",
"mutable": false,
"complexType": {
"original": "HoverRange",
"resolved": "HoverRange",
"references": {
"HoverRange": {
"location": "import",
"path": "../../utils/date"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "The range of dates currently being hovered"
}
}
};
}
static get events() {
return [{
"method": "calciteInternalDatePickerSelect",
"name": "calciteInternalDatePickerSelect",
"bubbles": true,
"cancelable": false,
"composed": true,
"docs": {
"tags": [{
"name": "internal",
"text": undefined
}],
"text": "Event emitted when user selects the date."
},
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
}
}, {
"method": "calciteInternalDatePickerHover",
"name": "calciteInternalDatePickerHover",
"bubbles": true,
"cancelable": false,
"composed": true,
"docs": {
"tags": [{
"name": "internal",
"text": undefined
}],
"text": "Event emitted when user hovers the date."
},
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
}
}, {
"method": "calciteInternalDatePickerActiveDateChange",
"name": "calciteInternalDatePickerActiveDateChange",
"bubbles": true,
"cancelable": false,
"composed": true,
"docs": {
"tags": [{
"name": "internal",
"text": undefined
}],
"text": "Active date for the user keyboard access."
},
"complexType": {
"original": "Date",
"resolved": "Date",
"references": {
"Date": {
"location": "global"
}
}
}
}, {
"method": "calciteInternalDatePickerMouseOut",
"name": "calciteInternalDatePickerMouseOut",
"bubbles": true,
"cancelable": false,
"composed": true,
"docs": {
"tags": [{
"name": "internal",
"text": undefined
}],
"text": ""
},
"complexType": {
"original": "void",
"resolved": "void",
"references": {}
}
}];
}
static get elementRef() { return "el"; }
static get listeners() {
return [{
"name": "pointerout",
"method": "pointerOutHandler",
"target": undefined,
"capture": false,
"passive": true
}];
}
}