carbon-components
Version:
The Carbon Design System is IBM’s open-source design system for products and experiences.
528 lines (501 loc) • 17.8 kB
JavaScript
/**
* Copyright IBM Corp. 2016, 2018
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import Flatpickr from 'flatpickr';
import settings from '../../globals/js/settings';
import mixin from '../../globals/js/misc/mixin';
import createComponent from '../../globals/js/mixins/create-component';
import initComponentBySearch from '../../globals/js/mixins/init-component-by-search';
import handles from '../../globals/js/mixins/handles';
import on from '../../globals/js/misc/on';
/* eslint no-underscore-dangle: [2, { "allow": ["_input", "_updateClassNames", "_updateInputFields"], "allowAfterThis": true }] */
// `this.options` create-component mix-in creates prototype chain
// so that `options` given in constructor argument wins over the one defined in static `options` property
// 'Flatpickr' wants flat structure of object instead
function flattenOptions(options) {
const o = {};
// eslint-disable-next-line guard-for-in, no-restricted-syntax
for (const key in options) {
o[key] = options[key];
}
return o;
}
// Weekdays shorthand for english locale
Flatpickr.l10ns.en.weekdays.shorthand.forEach((day, index) => {
const currentDay = Flatpickr.l10ns.en.weekdays.shorthand;
if (currentDay[index] === 'Thu' || currentDay[index] === 'Th') {
currentDay[index] = 'Th';
} else {
currentDay[index] = currentDay[index].charAt(0);
}
});
const toArray = (arrayLike) => Array.prototype.slice.call(arrayLike);
/**
* @param {number} monthNumber The month number.
* @param {boolean} shorthand `true` to use shorthand month.
* @param {Locale} locale The Flatpickr locale data.
* @returns {string} The month string.
*/
const monthToStr = (monthNumber, shorthand, locale) =>
locale.months[shorthand ? 'shorthand' : 'longhand'][monthNumber];
/**
* @param {object} config Plugin configuration.
* @param {boolean} [config.shorthand] `true` to use shorthand month.
* @param {string} config.selectorFlatpickrMonthYearContainer The CSS selector for the container of month/year selection UI.
* @param {string} config.selectorFlatpickrYearContainer The CSS selector for the container of year selection UI.
* @param {string} config.selectorFlatpickrCurrentMonth The CSS selector for the text-based month selection UI.
* @param {string} config.classFlatpickrCurrentMonth The CSS class for the text-based month selection UI.
* @returns {Plugin} A Flatpickr plugin to use text instead of `<select>` for month picker.
*/
const carbonFlatpickrMonthSelectPlugin = (config) => (fp) => {
const setupElements = () => {
if (!fp.monthElements) {
return;
}
fp.monthElements.forEach((elem) => {
if (!elem.parentNode) return;
elem.parentNode.removeChild(elem);
});
fp.monthElements.splice(
0,
fp.monthElements.length,
...fp.monthElements.map(() => {
// eslint-disable-next-line no-underscore-dangle
const monthElement = fp._createElement(
'span',
config.classFlatpickrCurrentMonth
);
monthElement.textContent = monthToStr(
fp.currentMonth,
config.shorthand === true,
fp.l10n
);
fp.yearElements[0]
.closest(config.selectorFlatpickrMonthYearContainer)
.insertBefore(
monthElement,
fp.yearElements[0].closest(config.selectorFlatpickrYearContainer)
);
return monthElement;
})
);
};
const updateCurrentMonth = () => {
const monthStr = monthToStr(
fp.currentMonth,
config.shorthand === true,
fp.l10n
);
fp.yearElements.forEach((elem) => {
const currentMonthContainer = elem.closest(
config.selectorFlatpickrMonthYearContainer
);
Array.prototype.forEach.call(
currentMonthContainer.querySelectorAll('.cur-month'),
(monthElement) => {
monthElement.textContent = monthStr;
}
);
});
};
const register = () => {
fp.loadedPlugins.push('carbonFlatpickrMonthSelectPlugin');
};
return {
onMonthChange: updateCurrentMonth,
onValueUpdate: updateCurrentMonth,
onOpen: updateCurrentMonth,
onReady: [setupElements, updateCurrentMonth, register],
};
};
class DatePicker extends mixin(
createComponent,
initComponentBySearch,
handles
) {
/**
* DatePicker.
* @extends CreateComponent
* @extends InitComponentBySearch
* @extends Handles
* @param {HTMLElement} element The element working as an date picker.
*/
constructor(element, options) {
super(element, options);
const type = this.element.getAttribute(this.options.attribType);
this.calendar = this._initDatePicker(type);
if (this.calendar.calendarContainer) {
this.manage(
on(this.element, 'keydown', (e) => {
if (e.which === 40) {
e.preventDefault();
(
this.calendar.selectedDateElem ||
this.calendar.todayDateElem ||
this.calendar.calendarContainer
).focus();
}
})
);
this.manage(
on(this.calendar.calendarContainer, 'keydown', (e) => {
if (e.which === 9 && type === 'range') {
this._updateClassNames(this.calendar);
this.element
.querySelector(this.options.selectorDatePickerInputFrom)
.focus();
}
})
);
}
}
/**
* Opens the date picker dropdown when this component gets focus.
* Used only for range mode for now.
* @private
*/
_handleFocus = () => {
if (this.calendar) {
this.calendar.open();
}
};
/**
* Closes the date picker dropdown when this component loses focus.
* Used only for range mode for now.
* @private
*/
_handleBlur = (event) => {
if (this.calendar) {
const focusTo = event.relatedTarget;
if (
!focusTo ||
(!this.element.contains(focusTo) &&
(!this.calendar.calendarContainer ||
!this.calendar.calendarContainer.contains(focusTo)))
) {
this.calendar.close();
}
}
};
_initDatePicker = (type) => {
if (type === 'range') {
// Given FlatPickr assumes one `<input>` even in range mode,
// use a hidden `<input>` for such purpose, separate from our from/to `<input>`s
const doc = this.element.ownerDocument;
const rangeInput = doc.createElement('input');
rangeInput.className = this.options.classVisuallyHidden;
rangeInput.setAttribute('aria-hidden', 'true');
this.element.appendChild(rangeInput);
this._rangeInput = rangeInput;
// An attempt to open the date picker dropdown when this component gets focus,
// and close the date picker dropdown when this component loses focus
const w = doc.defaultView;
const hasFocusin = 'onfocusin' in w;
const hasFocusout = 'onfocusout' in w;
const focusinEventName = hasFocusin ? 'focusin' : 'focus';
const focusoutEventName = hasFocusout ? 'focusout' : 'blur';
this.manage(
on(this.element, focusinEventName, this._handleFocus, !hasFocusin)
);
this.manage(
on(this.element, focusoutEventName, this._handleBlur, !hasFocusout)
);
this.manage(
on(
this.element.querySelector(this.options.selectorDatePickerIcon),
focusoutEventName,
this._handleBlur,
!hasFocusout
)
);
}
const self = this;
const date =
type === 'range'
? this._rangeInput
: this.element.querySelector(this.options.selectorDatePickerInput);
const {
onClose,
onChange,
onMonthChange,
onYearChange,
onOpen,
onValueUpdate,
} = this.options;
const calendar = new Flatpickr(
date,
Object.assign(flattenOptions(this.options), {
allowInput: true,
mode: type,
disableMobile: true,
positionElement:
type === 'range' &&
this.element.querySelector(this.options.selectorDatePickerInputFrom),
onClose(selectedDates, ...remainder) {
// An attempt to disable Flatpickr's focus tracking system,
// which has adverse effect with our old set up with two `<input>`s or our latest setup with a hidden `<input>`
if (self.shouldForceOpen) {
if (self.calendar.calendarContainer) {
self.calendar.calendarContainer.classList.add('open');
}
self.calendar.isOpen = true;
}
if (
!onClose ||
onClose.call(this, selectedDates, ...remainder) !== false
) {
self._updateClassNames(calendar);
self._updateInputFields(selectedDates, type);
}
},
onChange(...args) {
if (!onChange || onChange.call(this, ...args) !== false) {
self._updateClassNames(calendar);
if (type === 'range') {
if (calendar.selectedDates.length === 1 && calendar.isOpen) {
self.element
.querySelector(self.options.selectorDatePickerInputTo)
.classList.add(self.options.classFocused);
} else {
self.element
.querySelector(self.options.selectorDatePickerInputTo)
.classList.remove(self.options.classFocused);
}
}
}
},
onMonthChange(...args) {
if (!onMonthChange || onMonthChange.call(this, ...args) !== false) {
self._updateClassNames(calendar);
}
},
onYearChange(...args) {
if (!onYearChange || onYearChange.call(this, ...args) !== false) {
self._updateClassNames(calendar);
}
},
onOpen(...args) {
// An attempt to disable Flatpickr's focus tracking system,
// which has adverse effect with our old set up with two `<input>`s or our latest setup with a hidden `<input>`
self.shouldForceOpen = true;
setTimeout(() => {
self.shouldForceOpen = false;
}, 0);
if (!onOpen || onOpen.call(this, ...args) !== false) {
self._updateClassNames(calendar);
}
},
onValueUpdate(...args) {
if (
(!onValueUpdate || onValueUpdate.call(this, ...args) !== false) &&
type === 'range'
) {
self._updateInputFields(self.calendar.selectedDates, type);
}
},
nextArrow: this._rightArrowHTML(),
prevArrow: this._leftArrowHTML(),
plugins: [
...(this.options.plugins || []),
carbonFlatpickrMonthSelectPlugin(this.options),
],
})
);
if (type === 'range') {
this._addInputLogic(
this.element.querySelector(this.options.selectorDatePickerInputFrom),
0
);
this._addInputLogic(
this.element.querySelector(this.options.selectorDatePickerInputTo),
1
);
}
this.manage(
on(
this.element.querySelector(this.options.selectorDatePickerIcon),
'click',
() => {
calendar.open();
}
)
);
this._updateClassNames(calendar);
if (type !== 'range') {
this._addInputLogic(date);
}
return calendar;
};
_rightArrowHTML() {
return `
<svg
focusable="false"
preserveAspectRatio="xMidYMid meet"
style="will-change: transform;"
xmlns="http://www.w3.org/2000/svg"
width="16"
height="16"
viewBox="0 0 16 16"
aria-hidden="true">
<path d="M11 8l-5 5-.7-.7L9.6 8 5.3 3.7 6 3z"></path>
</svg>`;
}
_leftArrowHTML() {
return `
<svg
focusable="false"
preserveAspectRatio="xMidYMid meet"
style="will-change: transform;"
xmlns="http://www.w3.org/2000/svg"
width="16"
height="16"
viewBox="0 0 16 16"
aria-hidden="true"
>
<path d="M5 8l5-5 .7.7L6.4 8l4.3 4.3-.7.7z"></path>
</svg>`;
}
_addInputLogic = (input, index) => {
if (!isNaN(index) && (index < 0 || index > 1)) {
throw new RangeError(`The index of <input> (${index}) is out of range.`);
}
const inputField = input;
this.manage(
on(inputField, 'change', (evt) => {
if (evt.isTrusted || (evt.detail && evt.detail.isNotFromFlatpickr)) {
const inputDate = this.calendar.parseDate(inputField.value);
if (inputDate && !isNaN(inputDate.valueOf())) {
if (isNaN(index)) {
this.calendar.setDate(inputDate);
} else {
const { selectedDates } = this.calendar;
selectedDates[index] = inputDate;
this.calendar.setDate(selectedDates);
}
}
}
this._updateClassNames(this.calendar);
})
);
// An attempt to temporarily set the `<input>` being edited as the one FlatPicker manages,
// as FlatPicker attempts to take over `keydown` event handler on `document` to run on the date picker dropdown.
this.manage(
on(inputField, 'keydown', (evt) => {
const origInput = this.calendar._input;
this.calendar._input = evt.target;
setTimeout(() => {
this.calendar._input = origInput;
});
})
);
};
_updateClassNames = ({ calendarContainer, selectedDates }) => {
if (calendarContainer) {
calendarContainer.classList.add(this.options.classCalendarContainer);
calendarContainer
.querySelector('.flatpickr-month')
.classList.add(this.options.classMonth);
calendarContainer
.querySelector('.flatpickr-weekdays')
.classList.add(this.options.classWeekdays);
calendarContainer
.querySelector('.flatpickr-days')
.classList.add(this.options.classDays);
toArray(calendarContainer.querySelectorAll('.flatpickr-weekday')).forEach(
(item) => {
const currentItem = item;
currentItem.innerHTML = currentItem.innerHTML.replace(/\s+/g, '');
currentItem.classList.add(this.options.classWeekday);
}
);
toArray(calendarContainer.querySelectorAll('.flatpickr-day')).forEach(
(item) => {
item.classList.add(this.options.classDay);
if (item.classList.contains('today') && selectedDates.length > 0) {
item.classList.add('no-border');
} else if (
item.classList.contains('today') &&
selectedDates.length === 0
) {
item.classList.remove('no-border');
}
}
);
}
};
_updateInputFields = (selectedDates, type) => {
if (type === 'range') {
if (selectedDates.length === 2) {
this.element.querySelector(
this.options.selectorDatePickerInputFrom
).value = this._formatDate(selectedDates[0]);
this.element.querySelector(
this.options.selectorDatePickerInputTo
).value = this._formatDate(selectedDates[1]);
} else if (selectedDates.length === 1) {
this.element.querySelector(
this.options.selectorDatePickerInputFrom
).value = this._formatDate(selectedDates[0]);
}
} else if (selectedDates.length === 1) {
this.element.querySelector(
this.options.selectorDatePickerInput
).value = this._formatDate(selectedDates[0]);
}
this._updateClassNames(this.calendar);
};
_formatDate = (date) =>
this.calendar.formatDate(date, this.calendar.config.dateFormat);
release() {
if (this._rangeInput && this._rangeInput.parentNode) {
this._rangeInput.parentNode.removeChild(this._rangeInput);
}
if (this.calendar) {
try {
this.calendar.destroy();
} catch (err) {} // eslint-disable-line no-empty
this.calendar = null;
}
return super.release();
}
/**
* The component options.
* If `options` is specified in the constructor,
* {@linkcode DatePicker.create .create()}, or {@linkcode DatePicker.init .init()},
* properties in this object are overridden for the instance being create and how {@linkcode DatePicker.init .init()} works.
* @property {string} selectorInit The CSS selector to find date picker UIs.
*/
static get options() {
const { prefix } = settings;
return {
selectorInit: '[data-date-picker]',
selectorDatePickerInput: '[data-date-picker-input]',
selectorDatePickerInputFrom: '[data-date-picker-input-from]',
selectorDatePickerInputTo: '[data-date-picker-input-to]',
selectorDatePickerIcon: '[data-date-picker-icon]',
selectorFlatpickrMonthYearContainer: '.flatpickr-current-month',
selectorFlatpickrYearContainer: '.numInputWrapper',
selectorFlatpickrCurrentMonth: '.cur-month',
classCalendarContainer: `${prefix}--date-picker__calendar`,
classMonth: `${prefix}--date-picker__month`,
classWeekdays: `${prefix}--date-picker__weekdays`,
classDays: `${prefix}--date-picker__days`,
classWeekday: `${prefix}--date-picker__weekday`,
classDay: `${prefix}--date-picker__day`,
classFocused: `${prefix}--focused`,
classVisuallyHidden: `${prefix}--visually-hidden`,
classFlatpickrCurrentMonth: 'cur-month',
attribType: 'data-date-picker-type',
dateFormat: 'm/d/Y',
};
}
/**
* The map associating DOM element and date picker UI instance.
* @type {WeakMap}
*/
static components /* #__PURE_CLASS_PROPERTY__ */ = new WeakMap();
}
export default DatePicker;