@vaadin/date-picker 24.2.0-dev.f254716fe → 24.3.0-alpha2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/date-picker",
-  "version": "24.2.0-dev.f254716fe",
+  "version": "24.3.0-alpha2",
   "publishConfig": {
     "access": "public"
   },
@@ -21,6 +21,10 @@
   "type": "module",
   "files": [
     "src",
+    "!src/vaadin-lit-date-picker-overlay-content.js",
+    "!src/vaadin-lit-date-picker-overlay.js",
+    "!src/vaadin-lit-month-calendar.js",
+    "!src/vaadin-lit-date-picker.js",
     "theme",
     "vaadin-*.d.ts",
     "vaadin-*.js",
@@ -36,24 +40,24 @@
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.2.0",
-    "@vaadin/a11y-base": "24.2.0-dev.f254716fe",
-    "@vaadin/button": "24.2.0-dev.f254716fe",
-    "@vaadin/component-base": "24.2.0-dev.f254716fe",
-    "@vaadin/field-base": "24.2.0-dev.f254716fe",
-    "@vaadin/input-container": "24.2.0-dev.f254716fe",
-    "@vaadin/overlay": "24.2.0-dev.f254716fe",
-    "@vaadin/vaadin-lumo-styles": "24.2.0-dev.f254716fe",
-    "@vaadin/vaadin-material-styles": "24.2.0-dev.f254716fe",
-    "@vaadin/vaadin-themable-mixin": "24.2.0-dev.f254716fe"
+    "@vaadin/a11y-base": "24.3.0-alpha2",
+    "@vaadin/button": "24.3.0-alpha2",
+    "@vaadin/component-base": "24.3.0-alpha2",
+    "@vaadin/field-base": "24.3.0-alpha2",
+    "@vaadin/input-container": "24.3.0-alpha2",
+    "@vaadin/overlay": "24.3.0-alpha2",
+    "@vaadin/vaadin-lumo-styles": "24.3.0-alpha2",
+    "@vaadin/vaadin-material-styles": "24.3.0-alpha2",
+    "@vaadin/vaadin-themable-mixin": "24.3.0-alpha2"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/testing-helpers": "^0.4.3",
+    "@vaadin/testing-helpers": "^0.5.0",
     "sinon": "^13.0.2"
   },
   "web-types": [
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "da54950b9f8c14c6451ede0d426e16a489c7fb9b"
+  "gitHead": "0fd437292fa2a2f65e29b424d2456909ad2d684b"
 }

package/src/vaadin-date-picker-light.js

@@ -3,10 +3,11 @@
  * Copyright (c) 2016 - 2023 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import './vaadin-date-picker-overlay.js';
 import './vaadin-date-picker-overlay-content.js';
+import './vaadin-date-picker-overlay.js';
 import { dashToCamelCase } from '@polymer/polymer/lib/utils/case-map.js';
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { ValidateMixin } from '@vaadin/field-base/src/validate-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
 import { DatePickerMixin } from './vaadin-date-picker-mixin.js';
@@ -45,6 +46,7 @@ import { DatePickerMixin } from './vaadin-date-picker-mixin.js';
  * @fires {CustomEvent} value-changed - Fired when the `value` property changes.
  * @fires {CustomEvent} validated - Fired whenever the field is validated.
  *
+ * @customElement
  * @extends HTMLElement
  * @mixes ThemableMixin
  * @mixes DatePickerMixin
@@ -126,6 +128,6 @@ class DatePickerLight extends ThemableMixin(DatePickerMixin(ValidateMixin(Polyme
   }
 }
 
-customElements.define(DatePickerLight.is, DatePickerLight);
+defineCustomElement(DatePickerLight);
 
 export { DatePickerLight };

package/src/vaadin-date-picker-mixin.js

@@ -42,14 +42,18 @@ export const DatePickerMixin = (subclass) =>
          * @protected
          */
         _selectedDate: {
-          type: Date,
+          type: Object,
+          sync: true,
         },
 
         /**
          * @type {Date | undefined}
          * @protected
          */
-        _focusedDate: Date,
+        _focusedDate: {
+          type: Object,
+          sync: true,
+        },
 
         /**
          * Selected date.
@@ -64,6 +68,7 @@ export const DatePickerMixin = (subclass) =>
           type: String,
           notify: true,
           value: '',
+          sync: true,
         },
 
         /**
@@ -82,6 +87,7 @@ export const DatePickerMixin = (subclass) =>
           reflectToAttribute: true,
           notify: true,
           observer: '_openedChanged',
+          sync: true,
         },
 
         /**
@@ -99,6 +105,7 @@ export const DatePickerMixin = (subclass) =>
         showWeekNumbers: {
           type: Boolean,
           value: false,
+          sync: true,
         },
 
         /**
@@ -108,6 +115,7 @@ export const DatePickerMixin = (subclass) =>
         _fullscreen: {
           type: Boolean,
           value: false,
+          sync: true,
         },
 
         /**
@@ -206,6 +214,7 @@ export const DatePickerMixin = (subclass) =>
          */
         i18n: {
           type: Object,
+          sync: true,
           value: () => {
             return {
               monthNames: [
@@ -276,6 +285,7 @@ export const DatePickerMixin = (subclass) =>
          */
         min: {
           type: String,
+          sync: true,
         },
 
         /**
@@ -289,6 +299,7 @@ export const DatePickerMixin = (subclass) =>
          */
         max: {
           type: String,
+          sync: true,
         },
 
         /**
@@ -299,6 +310,7 @@ export const DatePickerMixin = (subclass) =>
         _minDate: {
           type: Date,
           computed: '__computeMinOrMaxDate(min)',
+          sync: true,
         },
 
         /**
@@ -309,6 +321,7 @@ export const DatePickerMixin = (subclass) =>
         _maxDate: {
           type: Date,
           computed: '__computeMinOrMaxDate(max)',
+          sync: true,
         },
 
         /** @private */
@@ -327,7 +340,10 @@ export const DatePickerMixin = (subclass) =>
         _focusOverlayOnOpen: Boolean,
 
         /** @private */
-        _overlayContent: Object,
+        _overlayContent: {
+          type: Object,
+          sync: true,
+        },
 
         /**
          * In date-picker, unlike other components extending `InputMixin`,
@@ -347,8 +363,8 @@ export const DatePickerMixin = (subclass) =>
 
     static get observers() {
       return [
-        '_selectedDateChanged(_selectedDate, i18n.formatDate)',
-        '_focusedDateChanged(_focusedDate, i18n.formatDate)',
+        '_selectedDateChanged(_selectedDate, i18n)',
+        '_focusedDateChanged(_focusedDate, i18n)',
         '__updateOverlayContent(_overlayContent, i18n, label, _minDate, _maxDate, _focusedDate, _selectedDate, showWeekNumbers)',
         '__updateOverlayContentTheme(_overlayContent, _theme)',
         '__updateOverlayContentFullScreen(_overlayContent, _fullscreen)',
@@ -431,19 +447,13 @@ export const DatePickerMixin = (subclass) =>
       super._onBlur(event);
 
       if (!this.opened) {
-        if (this.autoOpenDisabled) {
-          this._selectParsedOrFocusedDate();
-        }
+        this.__commitParsedOrFocusedDate();
 
         // Do not validate when focusout is caused by document
         // losing focus, which happens on browser tab switch.
         if (document.hasFocus()) {
           this.validate();
         }
-
-        if (this._inputElementValue === '' && this.value !== '') {
-          this.value = '';
-        }
       }
     }
 
@@ -477,25 +487,6 @@ export const DatePickerMixin = (subclass) =>
       this.opened = false;
     }
 
-    /**
-     * Override Polymer lifecycle callback to dispatch `change` event if needed.
-     * This is necessary to ensure `change` is fired after `value-changed`.
-     *
-     * @param {!Object} currentProps Current accessor values
-     * @param {?Object} changedProps Properties changed since the last call
-     * @param {?Object} oldProps Previous values for each changed property
-     * @protected
-     * @override
-     */
-    _propertiesChanged(currentProps, changedProps, oldProps) {
-      super._propertiesChanged(currentProps, changedProps, oldProps);
-
-      if ('value' in changedProps && this.__dispatchChange) {
-        this.dispatchEvent(new CustomEvent('change', { bubbles: true }));
-        this.__dispatchChange = false;
-      }
-    }
-
     /**
      * Opens the dropdown.
      */
@@ -532,19 +523,14 @@ export const DatePickerMixin = (subclass) =>
 
       // User confirmed selected date by clicking the calendar.
       content.addEventListener('date-tap', (e) => {
-        this.__userConfirmedDate = true;
-
-        this._selectDate(e.detail.date);
+        this.__commitDate(e.detail.date);
 
         this._close();
       });
 
       // User confirmed selected date by pressing Enter, Space, or Today.
       content.addEventListener('date-selected', (e) => {
-        // Reset if a date is deselected.
-        this.__userConfirmedDate = !!e.detail.date;
-
-        this._selectDate(e.detail.date);
+        this.__commitDate(e.detail.date);
       });
 
       // Set focus-ring attribute when moving focus to the overlay
@@ -561,6 +547,34 @@ export const DatePickerMixin = (subclass) =>
       });
     }
 
+    /**
+     * @param {string} dateString
+     * @private
+     */
+    __parseDate(dateString) {
+      if (!this.i18n.parseDate) {
+        return;
+      }
+
+      let dateObject = this.i18n.parseDate(dateString);
+      if (dateObject) {
+        dateObject = parseDate(`${dateObject.year}-${dateObject.month + 1}-${dateObject.day}`);
+      }
+      if (dateObject && !isNaN(dateObject.getTime())) {
+        return dateObject;
+      }
+    }
+
+    /**
+     * @param {Date} dateObject
+     * @private
+     */
+    __formatDate(dateObject) {
+      if (this.i18n.formatDate) {
+        return this.i18n.formatDate(extractDateParts(dateObject));
+      }
+    }
+
     /**
      * Returns true if the current input value satisfies all constraints (if any)
      *
@@ -570,9 +584,7 @@ export const DatePickerMixin = (subclass) =>
      */
     checkValidity() {
       const inputValue = this._inputElementValue;
-      const inputValid =
-        !inputValue ||
-        (!!this._selectedDate && inputValue === this._getFormattedDate(this.i18n.formatDate, this._selectedDate));
+      const inputValid = !inputValue || (!!this._selectedDate && inputValue === this.__formatDate(this._selectedDate));
       const minMaxValid = !this._selectedDate || dateAllowed(this._selectedDate, this._minDate, this._maxDate);
 
       let inputValidity = true;
@@ -633,22 +645,27 @@ export const DatePickerMixin = (subclass) =>
       this._shouldKeepFocusRing = focused && this._keyboardActive;
     }
 
+    /** @private */
+    __dispatchChange() {
+      this.validate();
+      this.dispatchEvent(new CustomEvent('change', { bubbles: true }));
+    }
+
     /**
-     * Select date on user interaction and set the flag
-     * to fire change event if necessary.
+     * Sets the given date as the value and fires a change event
+     * if the value has changed.
      *
-     * @param {Date} dateToSelect
-     * @protected
+     * @param {Date} date
+     * @private
      */
-    _selectDate(dateToSelect) {
-      const value = this._formatISO(dateToSelect);
+    __commitDate(date) {
+      const prevValue = this.value;
 
-      // Only set flag if the value will change.
-      if (this.value !== value) {
-        this.__dispatchChange = true;
-      }
+      this._selectedDate = date;
 
-      this._selectedDate = dateToSelect;
+      if (prevValue !== this.value) {
+        this.__dispatchChange();
+      }
     }
 
     /** @private */
@@ -724,28 +741,24 @@ export const DatePickerMixin = (subclass) =>
     }
 
     /** @private */
-    _selectedDateChanged(selectedDate, formatDate) {
-      if (selectedDate === undefined || formatDate === undefined) {
+    _selectedDateChanged(selectedDate, i18n) {
+      if (selectedDate === undefined || i18n === undefined) {
         return;
       }
-      const value = this._formatISO(selectedDate);
 
       if (!this.__keepInputValue) {
         this._applyInputValue(selectedDate);
       }
 
-      if (value !== this.value) {
-        this.validate();
-        this.value = value;
-      }
+      this.value = this._formatISO(selectedDate);
       this._ignoreFocusedDateChange = true;
       this._focusedDate = selectedDate;
       this._ignoreFocusedDateChange = false;
     }
 
     /** @private */
-    _focusedDateChanged(focusedDate, formatDate) {
-      if (focusedDate === undefined || formatDate === undefined) {
+    _focusedDateChanged(focusedDate, i18n) {
+      if (focusedDate === undefined || i18n === undefined) {
         return;
       }
       if (!this._ignoreFocusedDateChange && !this._noInput) {
@@ -795,15 +808,13 @@ export const DatePickerMixin = (subclass) =>
     // eslint-disable-next-line max-params
     __updateOverlayContent(overlayContent, i18n, label, minDate, maxDate, focusedDate, selectedDate, showWeekNumbers) {
       if (overlayContent) {
-        overlayContent.setProperties({
-          i18n,
-          label,
-          minDate,
-          maxDate,
-          focusedDate,
-          selectedDate,
-          showWeekNumbers,
-        });
+        overlayContent.i18n = i18n;
+        overlayContent.label = label;
+        overlayContent.minDate = minDate;
+        overlayContent.maxDate = maxDate;
+        overlayContent.focusedDate = focusedDate;
+        overlayContent.selectedDate = selectedDate;
+        overlayContent.showWeekNumbers = showWeekNumbers;
       }
     }
 
@@ -834,6 +845,7 @@ export const DatePickerMixin = (subclass) =>
     /** @protected */
     _onOverlayOpened() {
       const content = this._overlayContent;
+      content.reset();
 
       // Detect which date to show
       const initialPosition = this._getInitialPosition();
@@ -879,24 +891,31 @@ export const DatePickerMixin = (subclass) =>
         : getClosestDate(initialPosition, [this._minDate, this._maxDate]);
     }
 
-    /** @private */
-    _selectParsedOrFocusedDate() {
+    /**
+     * Tries to parse the input element's value as a date. When succeeds,
+     * sets the resulting date as the value and fires a change event
+     * (if the value has changed). If no i18n parser is provided, sets
+     * the focused date as the value.
+     *
+     * @private
+     */
+    __commitParsedOrFocusedDate() {
       // Select the parsed input or focused date
       this._ignoreFocusedDateChange = true;
       if (this.i18n.parseDate) {
         const inputValue = this._inputElementValue || '';
-        const parsedDate = this._getParsedDate(inputValue);
+        const parsedDate = this.__parseDate(inputValue);
 
-        if (this._isValidDate(parsedDate)) {
-          this._selectDate(parsedDate);
+        if (parsedDate) {
+          this.__commitDate(parsedDate);
         } else {
           this.__keepInputValue = true;
-          this._selectDate(null);
+          this.__commitDate(null);
           this._selectedDate = null;
           this.__keepInputValue = false;
         }
       } else if (this._focusedDate) {
-        this._selectDate(this._focusedDate);
+        this.__commitDate(this._focusedDate);
       }
       this._ignoreFocusedDateChange = false;
     }
@@ -911,19 +930,15 @@ export const DatePickerMixin = (subclass) =>
 
       window.removeEventListener('scroll', this._boundOnScroll, true);
 
-      // No need to select date on close if it was confirmed by the user.
-      if (this.__userConfirmedDate) {
-        this.__userConfirmedDate = false;
-      } else {
-        this._selectParsedOrFocusedDate();
-      }
+      this.__commitParsedOrFocusedDate();
 
       if (this._nativeInput && this._nativeInput.selectionStart) {
         this._nativeInput.selectionStart = this._nativeInput.selectionEnd;
       }
       // No need to revalidate the value after `_selectedDateChanged`
-      // Needed in case the value was not changed: open and close dropdown.
-      if (!this.value) {
+      // Needed in case the value was not changed: open and close dropdown,
+      // especially on outside click. On Esc key press, do not validate.
+      if (!this.value && !this._keyboardActive) {
         this.validate();
       }
     }
@@ -950,12 +965,7 @@ export const DatePickerMixin = (subclass) =>
 
     /** @private */
     _applyInputValue(date) {
-      this._inputElementValue = date ? this._getFormattedDate(this.i18n.formatDate, date) : '';
-    }
-
-    /** @private */
-    _getFormattedDate(formatDate, date) {
-      return formatDate(extractDateParts(date));
+      this._inputElementValue = date ? this.__formatDate(date) : '';
     }
 
     /** @private */
@@ -965,23 +975,14 @@ export const DatePickerMixin = (subclass) =>
       }
     }
 
-    /** @private */
-    _isValidDate(d) {
-      return d && !isNaN(d.getTime());
-    }
-
     /**
      * Override an event listener from `InputConstraintsMixin`
-     * to have date-picker fully control when to fire a change event.
+     * to have date-picker fully control when to fire a change event
+     * and trigger validation.
+     *
      * @protected
      */
     _onChange(event) {
-      // For change event on the native <input> blur, after the input is cleared,
-      // we schedule change event to be dispatched on date-picker blur.
-      if (this._inputElementValue === '') {
-        this.__dispatchChange = true;
-      }
-
       event.stopPropagation();
     }
 
@@ -1015,10 +1016,7 @@ export const DatePickerMixin = (subclass) =>
      */
     _onClearButtonClick(event) {
       event.preventDefault();
-      this._inputElementValue = '';
-      this.value = '';
-      this.validate();
-      this.dispatchEvent(new CustomEvent('change', { bubbles: true }));
+      this.__commitDate(null);
     }
 
     /**
@@ -1087,7 +1085,7 @@ export const DatePickerMixin = (subclass) =>
         // Closing will implicitly select parsed or focused date
         this.close();
       } else {
-        this._selectParsedOrFocusedDate();
+        this.__commitParsedOrFocusedDate();
       }
       if (oldValue === this.value) {
         this.validate();
@@ -1117,25 +1115,14 @@ export const DatePickerMixin = (subclass) =>
         return;
       }
 
-      if (this.autoOpenDisabled) {
+      if (this.inputElement.value === '') {
         // Do not restore selected date if Esc was pressed after clearing input field
-        if (this.inputElement.value === '') {
-          this._selectDate(null);
-        }
-        this._applyInputValue(this._selectedDate);
+        this.__commitDate(null);
       } else {
-        this._focusedDate = this._selectedDate;
-        this._selectParsedOrFocusedDate();
+        this._applyInputValue(this._selectedDate);
       }
     }
 
-    /** @private */
-    _getParsedDate(inputValue = this._inputElementValue) {
-      const dateObject = this.i18n.parseDate && this.i18n.parseDate(inputValue);
-      const parsedDate = dateObject && parseDate(`${dateObject.year}-${dateObject.month + 1}-${dateObject.day}`);
-      return parsedDate;
-    }
-
     /** @protected */
     _isClearButton(event) {
       return event.composedPath()[0] === this.clearElement;
@@ -1146,18 +1133,13 @@ export const DatePickerMixin = (subclass) =>
      * @protected
      */
     _onInput() {
-      if (!this.opened && this.inputElement.value && !this.autoOpenDisabled) {
+      if (!this.opened && this._inputElementValue && !this.autoOpenDisabled) {
         this.open();
       }
-      this._userInputValueChanged();
-    }
 
-    /** @private */
-    _userInputValueChanged() {
       if (this._inputElementValue) {
-        const parsedDate = this._getParsedDate();
-
-        if (this._isValidDate(parsedDate)) {
+        const parsedDate = this.__parseDate(this._inputElementValue);
+        if (parsedDate) {
           this._ignoreFocusedDateChange = true;
           if (!dateEquals(parsedDate, this._focusedDate)) {
             this._focusedDate = parsedDate;

package/src/vaadin-date-picker-month-scroller.js

@@ -3,11 +3,12 @@
  * Copyright (c) 2016 - 2023 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import { html } from '@polymer/polymer/lib/utils/html-tag.js';
+import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { dateAfterXMonths } from './vaadin-date-picker-helper.js';
 import { InfiniteScroller } from './vaadin-infinite-scroller.js';
 
-const stylesTemplate = html`
+const stylesTemplate = document.createElement('template');
+stylesTemplate.innerHTML = `
   <style>
     :host {
       --vaadin-infinite-scroller-item-height: 270px;
@@ -21,11 +22,10 @@ const stylesTemplate = html`
   </style>
 `;
 
-let memoizedTemplate;
-
 /**
  * An element used internally by `<vaadin-date-picker>`. Not intended to be used separately.
  *
+ * @customElement
  * @extends InfiniteScroller
  * @private
  */
@@ -34,22 +34,11 @@ class DatePickerMonthScroller extends InfiniteScroller {
     return 'vaadin-date-picker-month-scroller';
   }
 
-  static get template() {
-    if (!memoizedTemplate) {
-      memoizedTemplate = super.template.cloneNode(true);
-      memoizedTemplate.content.appendChild(stylesTemplate.content.cloneNode(true));
-    }
-
-    return memoizedTemplate;
-  }
+  constructor() {
+    super();
 
-  static get properties() {
-    return {
-      bufferSize: {
-        type: Number,
-        value: 3,
-      },
-    };
+    this.bufferSize = 3;
+    this.shadowRoot.appendChild(stylesTemplate.content.cloneNode(true));
   }
 
   /**
@@ -71,4 +60,4 @@ class DatePickerMonthScroller extends InfiniteScroller {
   }
 }
 
-customElements.define(DatePickerMonthScroller.is, DatePickerMonthScroller);
+defineCustomElement(DatePickerMonthScroller);