@geogirafe/lib-geoportal
Version:
GeoGirafe is a flexible application to build online geoportals.
168 lines (167 loc) • 13 kB
JavaScript
import { html as uHtml } from 'uhtml';
// SPDX-License-Identifier: Apache-2.0
import TimeWidget from '../tools/timewidget.js';
/**
* A component consisting of two `<input>` elements of type date picker for temporal layer filtering.
* It supports specifying single-dates or date ranges.
* The widget validates input dates based on the specified `timeOptions`. In `range` mode, it validates
* lower and upper range limits so that they do not cross each other.
*/
class TimePickerComponent extends TimeWidget {
templateUrl = null;
styleUrls = null;
template = () => {
return uHtml `<style>
.hidden{display:none}.gg-rotate90{transform:rotate(90deg)}.gg-rotate180{transform:rotate(180deg)}.gg-rotate270{transform:rotate(270deg)}img{filter:var(--svg-filter)}img.legend-image{filter:var(--svg-map-filter);background:var(--svg-legend-bkg)}div{scrollbar-width:thin}a,a:visited{color:var(--link-color)}@keyframes spin{0%{transform:rotate(0)}to{transform:rotate(360deg)}}@keyframes spin-wait{0%{transform:rotate(0)}7%{transform:rotate(360deg)}to{transform:rotate(360deg)}}.gg-spin{animation-name:spin;animation-duration:2s;animation-timing-function:linear;animation-iteration-count:infinite}.gg-spin-wait{animation-name:spin-wait;animation-duration:10s;animation-timing-function:linear;animation-iteration-count:infinite}::-webkit-scrollbar{width:5px}::-webkit-scrollbar-thumb{background:#999}button,input,select,textarea{font:inherit}.gg-button,.gg-select,.gg-input,.gg-textarea{background-color:var(--bkg-color);color:var(--text-color);border:var(--app-standard-border);box-sizing:border-box;cursor:pointer;border-radius:3px;outline:0;margin:0;padding:0 0 0 .5rem;display:inline-block}.gg-label{background-color:var(--bkg-color);color:var(--text-color);border:none;align-items:center;margin:0;padding:0;display:flex}.gg-button,.gg-select,.gg-input,.gg-label{min-height:calc(var(--app-standard-height) / 1.5)}.gg-textarea{max-height:initial;resize:vertical;height:6rem;padding:.5rem;line-height:1.3rem}.gg-input{cursor:text}.gg-checkbox{accent-color:var(--text-color);width:1.2rem}.gg-range{accent-color:var(--text-color)}.gg-button{padding:0 .5rem}.gg-button.active{border:solid 1px var(--text-color-grad1);background-color:var(--bkg-color-grad2)}.gg-button:disabled{background-color:var(--bkg-color-grad1);color:var(--text-color-grad2);cursor:not-allowed;border:none}.gg-button:disabled img{filter:opacity(.6)}.gg-input:disabled,.gg-select:disabled,.gg-textarea:disabled{background-color:var(--bkg-color-grad1);color:var(--text-color-grad2);cursor:not-allowed}.gg-button>img{vertical-align:middle}.gg-icon-button{color:var(--text-color);cursor:pointer;background-color:#0000;border:none;flex-direction:column;justify-content:center;align-items:center;padding:0;display:flex}.gg-icon{justify-content:center;align-items:center;display:flex}.gg-big,.gg-big-withtext{min-width:var(--app-standard-height);min-height:var(--app-standard-height);max-height:var(--app-standard-height)}.gg-big img,.gg-big-withtext img{width:calc(var(--app-standard-height) - 1.5rem);margin:0}.gg-big-withtext span{font-variant:small-caps;padding:0 1rem;font-size:.9rem}.gg-medium,.gg-medium-withtext{min-width:calc(var(--app-standard-height) / 1.2);min-height:calc(var(--app-standard-height) / 1.2);max-height:calc(var(--app-standard-height) / 1.2);flex-direction:row}.gg-medium img{width:calc(var(--app-standard-height) / 2.4);margin:0}.gg-medium-withtext img{width:calc(var(--app-standard-height) / 2.4);margin-left:.5rem}.gg-medium-withtext span{padding:0 1rem 0 .5rem;font-size:.9rem}.gg-small,.gg-small-withtext{min-width:calc(var(--app-standard-height) / 2);min-height:calc(var(--app-standard-height) / 2);max-height:calc(var(--app-standard-height) / 2);flex-direction:row}.gg-small img{width:calc(var(--app-standard-height) / 3);margin:0}.gg-small-withtext img{width:calc(var(--app-standard-height) / 3);margin-left:.5rem}.gg-small-withtext span{padding:0 .5rem 0 .3rem;font-size:.9rem}.gg-button:hover:not(:disabled),.gg-select:hover:not(:disabled),.gg-input:hover:not(:disabled),.gg-textarea:hover:not(:disabled),.gg-icon-button:hover:not(:disabled){background-color:var(--bkg-color-grad1)}.gg-opacity{opacity:.5}.gg-opacity:hover{opacity:1;background-color:#0000}.gg-tabs{cursor:pointer;grid-auto-flow:column;padding-bottom:1rem;font-size:1rem;display:grid}.gg-tab{border:none;border-bottom:var(--app-standard-border);cursor:pointer;color:var(--text-color);background:0 0;padding:.5rem}.gg-tab.active{border-bottom:solid 1px var(--text-color)}.girafe-button-big,.girafe-button-large,.girafe-button-small,.girafe-button-tiny{color:var(--text-color);background-color:#0000;border:none;flex-direction:column;display:flex}.girafe-button-big:hover,.girafe-button-large:hover,.girafe-button-small:hover,.girafe-button-tiny:hover{background-color:var(--bkg-color-grad1);cursor:pointer}.girafe-button-big.dark,.girafe-button-large.dark,.girafe-button-small.dark,.girafe-button-tiny.dark{background-color:var(--bkg-color);filter:invert()}.girafe-button-big{width:var(--app-standard-height);height:var(--app-standard-height);align-items:center;padding:1rem}.girafe-button-big img{overflow:hidden}.girafe-button-large{flex-direction:row}.girafe-button-large img{height:2rem;margin:.3rem}.girafe-button-large span{height:2rem;margin:.3rem;line-height:2rem}.girafe-button-small{min-width:calc(var(--app-standard-height) / 2);height:calc(var(--app-standard-height) / 2);align-items:center;padding:.5rem}.girafe-button-small img{overflow:hidden}.girafe-button-small span{text-align:left;text-overflow:ellipsis;width:100%;overflow:hidden}.girafe-button-tiny{align-items:center;width:1rem;height:1rem;padding:0}.girafe-button-tiny img{overflow:hidden}.girafe-onboarding-theme{background-color:var(--bkg-color);color:var(--text-color)}.girafe-onboarding-theme button{background-color:var(--bkg-color);color:var(--text-color);text-shadow:none}.girafe-onboarding-theme button.driver-popover-close-btn{z-index:10000}.tippy-box{background-color:var(--bkg-color);border:var(--app-standard-border)}.tippy-content{color:var(--text-color)}.tippy-arrow{color:var(--bkg-color)}.tippy-box[data-theme~=error]{background-color:var(--error-color);white-space:pre-line}div.tippy-box[data-theme=image-popup]{border:var(--app-standard-border);& div.tippy-content{background-color:var(--bkg-color);& img{max-width:20rem;max-height:20rem}}& div.tippy-arrow{color:var(--bkg-color)}}
</style><style>
#container{margin-right:.5rem;display:flex}
</style>
<style>${this.customStyle}</style>
<div id="container"><input id="input-lower" class="gg-select gg-medium"> <input id="input-upper" class="gg-select gg-medium"></div>
${this.htmlUnsafe(this.feedbackTemplateHtml ?? '')}`;
};
constructor() {
super('time-picker');
}
renderComponent() {
super.renderComponent();
this.configureInputElements();
this.addEventListeners();
}
/**
* Sets the value of the specified input element.
*
* @param {string} dateStr - The date string to be set as the value.
* @param {TimeRangeLimit} [limit='lower'] - The time range limit for which the value is to be set ('lower' or 'upper').
*/
setValue(dateStr, limit = 'lower') {
if (!this.rendered)
throw new Error('Cannot set value on unrendered component');
if (limit === 'upper' && this.mode === 'value')
return;
this.getInputElement(limit).value = dateStr;
// Validate and dispatch event
if (limit === 'lower') {
this.validateLowerLimit();
}
else {
this.validateUpperLimit();
}
this.dispatchTimeChangeEvent();
}
/**
* Resets the input elements to their default states. This either will be empty strings
* or the optionally defined `minDefaultValue` and `maxDefaultValue`.
* The method will trigger a `TimeChangeEvent` that bubbles up to the parent component.
*/
reset() {
this.setValue(this.minDefaultValue, 'lower');
if (this.mode === 'range')
this.setValue(this.maxDefaultValue, 'upper');
}
/**
* Sets the HTML element attributes to the initial values. Must only be called ones.
*/
configureInputElements() {
this.lowerInputElem.type = this.getHtmlInputType();
this.lowerInputElem.min = this.timeFormatter.formatDateString(this.minValue);
this.lowerInputElem.max = this.timeFormatter.formatDateString(this.maxValue);
this.lowerInputElem.value = this.minDefaultValue;
if (this.mode === 'range') {
this.upperInputElem.type = this.getHtmlInputType();
this.upperInputElem.min = this.timeFormatter.formatDateString(this.minValue);
this.upperInputElem.max = this.timeFormatter.formatDateString(this.maxValue);
this.upperInputElem.value = this.maxDefaultValue;
}
else {
this.upperInputElem.classList.add('hidden');
}
}
getHtmlInputType() {
// Safari and Firefox do not support input type 'month',
// see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/month
// But still use 'month' for those browsers to allow month selection via text input
switch (this.resolution) {
case 'day':
return 'date';
case 'week':
return 'date';
case 'month':
return 'month';
case 'year':
return 'month';
default:
return 'date';
}
}
/**
* Attaches event listeners to input elements to validate their values when user interactions occur.
* Updates the min/max settings of one datepicker whenever the value of the other is changed.
*/
addEventListeners() {
// The change event is triggered when the user selects a date from the calendar popup,
// presses 'clear' in the calendar popup or types a date manually
this.lowerInputElem.addEventListener('change', (_event) => {
// While the user is typing, dates will be incomplete and therefore invalid. They are ignored.
if (this.lowerInputElem.value === '' || this.timeFormatter.formatDateString(this.lowerInputElem.value)) {
this.validateLowerLimit();
this.dispatchTimeChangeEvent();
}
});
// The focusout event is triggered when the user clicks outside the datepicker or presses the escape key
this.lowerInputElem.addEventListener('focusout', (_event) => {
this.validateLowerLimit();
this.dispatchTimeChangeEvent();
});
// The keypress event is triggered when the user presses the enter key
this.lowerInputElem.addEventListener('keypress', (event) => {
if (event.key === 'Enter') {
this.validateLowerLimit();
this.dispatchTimeChangeEvent();
}
});
if (this.mode === 'range') {
this.upperInputElem.addEventListener('change', (_event) => {
if (this.upperInputElem.value === '' || this.timeFormatter.formatDateString(this.upperInputElem.value)) {
this.validateUpperLimit();
this.dispatchTimeChangeEvent();
}
});
this.upperInputElem.addEventListener('focusout', (_event) => {
this.validateUpperLimit();
this.dispatchTimeChangeEvent();
});
this.upperInputElem.addEventListener('keypress', (event) => {
if (event.key === 'Enter') {
this.validateUpperLimit();
this.dispatchTimeChangeEvent();
}
});
}
}
validateLowerLimit() {
const newValue = this.getValue('lower');
// Check if the user entered a valid date inside the accepted time range by formatting it
if (this.timeFormatter.formatDateString(newValue)) {
if (this.mode === 'range')
this.upperInputElem.min = newValue;
}
else {
// Invalid date entered, reset to default value
this.lowerInputElem.value = this.minDefaultValue;
}
}
validateUpperLimit() {
const newValue = this.getValue('upper');
// Check if the user entered a valid date inside the accepted time range by formatting it
if (this.timeFormatter.formatDateString(newValue)) {
if (this.mode === 'range')
this.lowerInputElem.max = newValue;
}
else {
// Invalid date entered, reset to default value
this.upperInputElem.value = this.maxDefaultValue;
}
}
}
export default TimePickerComponent;