@vaadin/date-picker 23.1.0-rc1 → 23.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/date-picker",
-  "version": "23.1.0-rc1",
+  "version": "23.1.0",
   "publishConfig": {
     "access": "public"
   },
@@ -34,19 +34,19 @@
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.2.0",
-    "@vaadin/button": "23.1.0-rc1",
-    "@vaadin/component-base": "23.1.0-rc1",
-    "@vaadin/field-base": "23.1.0-rc1",
-    "@vaadin/input-container": "23.1.0-rc1",
-    "@vaadin/vaadin-lumo-styles": "23.1.0-rc1",
-    "@vaadin/vaadin-material-styles": "23.1.0-rc1",
-    "@vaadin/vaadin-overlay": "23.1.0-rc1",
-    "@vaadin/vaadin-themable-mixin": "23.1.0-rc1"
+    "@vaadin/button": "^23.1.0",
+    "@vaadin/component-base": "^23.1.0",
+    "@vaadin/field-base": "^23.1.0",
+    "@vaadin/input-container": "^23.1.0",
+    "@vaadin/vaadin-lumo-styles": "^23.1.0",
+    "@vaadin/vaadin-material-styles": "^23.1.0",
+    "@vaadin/vaadin-overlay": "^23.1.0",
+    "@vaadin/vaadin-themable-mixin": "^23.1.0"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
     "@vaadin/testing-helpers": "^0.3.2",
     "sinon": "^13.0.2"
   },
-  "gitHead": "5ecb85e16e938df827fefca4bd2a665a1e29913e"
+  "gitHead": "322bba42b83f908a78cd972b06acadc5da95a69d"
 }

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

@@ -125,6 +125,13 @@ class DatePickerLight extends ThemableMixin(DatePickerMixin(PolymerElement)) {
     };
   }
 
+  /** @protected */
+  ready() {
+    super.ready();
+
+    this._initOverlay();
+  }
+
   /** @protected */
   connectedCallback() {
     super.connectedCallback();

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

@@ -336,7 +336,7 @@ export const DatePickerMixin = (subclass) =>
     }
 
     /**
-     * Override a getter from `ClearButtonMixin` to make it optional
+     * Override a getter from `InputControlMixin` to make it optional
      * and to prevent warning when a clear button is missing,
      * for example when using <vaadin-date-picker-light>.
      * @protected
@@ -370,6 +370,7 @@ export const DatePickerMixin = (subclass) =>
     constructor() {
       super();
 
+      this._boundOnClick = this._onClick.bind(this);
       this._boundOnScroll = this._onScroll.bind(this);
     }
 
@@ -414,11 +415,7 @@ export const DatePickerMixin = (subclass) =>
     ready() {
       super.ready();
 
-      this.addEventListener('click', (e) => {
-        if (!this._isClearButton(e) && (!this.autoOpenDisabled || this._noInput)) {
-          this.open();
-        }
-      });
+      this.addEventListener('click', this._boundOnClick);
 
       this.addController(
         new MediaQueryController(this._fullscreenMediaQuery, (matches) => {
@@ -473,7 +470,7 @@ export const DatePickerMixin = (subclass) =>
       }
     }
 
-    /** @private */
+    /** @protected */
     _initOverlay() {
       this.$.overlay.removeAttribute('disable-upgrade');
       this._overlayInitialized = true;
@@ -509,8 +506,6 @@ export const DatePickerMixin = (subclass) =>
         this._setFocused(true);
       });
 
-      this.$.overlay.addEventListener('vaadin-overlay-close', this._onVaadinOverlayClose.bind(this));
-
       this.addEventListener('mousedown', () => this.__bringToFront());
       this.addEventListener('touchstart', () => this.__bringToFront());
     }
@@ -913,11 +908,35 @@ export const DatePickerMixin = (subclass) =>
     }
 
     /**
-     * Override an event listener from `ClearButtonMixin`
+     * @param {Event} event
+     * @private
+     */
+    _onClick(event) {
+      // Clear button click is handled in separate listener
+      // but bubbles to the host, so we need to ignore it.
+      if (!this._isClearButton(event)) {
+        this._onHostClick(event);
+      }
+    }
+
+    /**
+     * @param {Event} event
+     * @private
+     */
+    _onHostClick(event) {
+      if (!this.autoOpenDisabled || this._noInput) {
+        event.preventDefault();
+        this.open();
+      }
+    }
+
+    /**
+     * Override an event listener from `InputControlMixin`
      * to validate and dispatch change on clear.
      * @protected
      */
-    _onClearButtonClick() {
+    _onClearButtonClick(event) {
+      event.preventDefault();
       this.value = '';
       this._inputValue = '';
       this.validate();
@@ -926,11 +945,13 @@ export const DatePickerMixin = (subclass) =>
 
     /**
      * Override an event listener from `KeyboardMixin`.
-     * Do not call `super` to also override `ClearButtonMixin`.
+     * @param {KeyboardEvent} e
      * @protected
      * @override
      */
     _onKeyDown(e) {
+      super._onKeyDown(e);
+
       if (this._noInput) {
         // The input element cannot be readonly as it would conflict with
         // the required attribute. Both are not allowed on an input element.
@@ -957,31 +978,10 @@ export const DatePickerMixin = (subclass) =>
             this.open();
           }
           break;
-        case 'Enter': {
-          const parsedDate = this._getParsedDate();
-          const isValidDate = this._isValidDate(parsedDate);
-          if (this.opened) {
-            if (this._overlayInitialized && this._overlayContent.focusedDate && isValidDate) {
-              this._selectDate(this._overlayContent.focusedDate);
-            }
-            this.close();
-          } else if (!isValidDate && this.inputElement.value !== '') {
-            this.validate();
-          } else {
-            const oldValue = this.value;
-            this._selectParsedOrFocusedDate();
-            if (oldValue === this.value) {
-              this.validate();
-            }
-          }
-          break;
-        }
-        case 'Escape':
-          this._onEscape();
-          break;
         case 'Tab':
           if (this.opened) {
             e.preventDefault();
+            e.stopPropagation();
             // Clear the selection range (remains visible on IE)
             this._setSelectionRange(0, 0);
             if (e.shiftKey) {
@@ -996,16 +996,56 @@ export const DatePickerMixin = (subclass) =>
       }
     }
 
-    /** @private */
-    _onEscape() {
+    /**
+     * Override an event listener from `KeyboardMixin`.
+     *
+     * @param {!KeyboardEvent} _event
+     * @protected
+     * @override
+     */
+    _onEnter(_event) {
+      const parsedDate = this._getParsedDate();
+      const isValidDate = this._isValidDate(parsedDate);
+      if (this.opened) {
+        if (this._overlayInitialized && this._overlayContent.focusedDate && isValidDate) {
+          this._selectDate(this._overlayContent.focusedDate);
+        }
+        this.close();
+      } else if (!isValidDate && this.inputElement.value !== '') {
+        this.validate();
+      } else {
+        const oldValue = this.value;
+        this._selectParsedOrFocusedDate();
+        if (oldValue === this.value) {
+          this.validate();
+        }
+      }
+    }
+
+    /**
+     * Override an event listener from `KeyboardMixin`.
+     * Do not call `super` in order to override clear
+     * button logic defined in `InputControlMixin`.
+     *
+     * @param {!KeyboardEvent} event
+     * @protected
+     * @override
+     */
+    _onEscape(event) {
       // Closing overlay is handled in vaadin-overlay-escape-press event listener.
       if (this.opened) {
         return;
       }
 
-      if (this.clearButtonVisible) {
-        this._onClearButtonClick();
-      } else if (this.autoOpenDisabled) {
+      if (this.clearButtonVisible && !!this.value) {
+        // Stop event from propagating to the host element
+        // to avoid closing dialog when clearing on Esc
+        event.stopPropagation();
+        this._onClearButtonClick(event);
+        return;
+      }
+
+      if (this.autoOpenDisabled) {
         // Do not restore selected date if Esc was pressed after clearing input field
         if (this.inputElement.value === '') {
           this._selectDate(null);

package/src/vaadin-date-picker-overlay-content.js

@@ -755,6 +755,9 @@ class DatePickerOverlayContent extends ControllerMixin(ThemableMixin(DirMixin(Po
         this._moveFocusByMonths(event.shiftKey ? -12 : -1);
         handled = true;
         break;
+      case 'Tab':
+        this._onTabKeyDown(event, 'calendar');
+        break;
       default:
         break;
     }
@@ -765,35 +768,70 @@ class DatePickerOverlayContent extends ControllerMixin(ThemableMixin(DirMixin(Po
     }
   }
 
+  _onTabKeyDown(event, section) {
+    // Stop propagation to avoid focus-trap
+    // listener when used in a modal dialog.
+    event.stopPropagation();
+
+    switch (section) {
+      case 'calendar':
+        if (event.shiftKey) {
+          // Return focus back to the input field.
+          event.preventDefault();
+          this.__focusInput();
+        }
+        break;
+      case 'today':
+        if (event.shiftKey) {
+          // Browser returns focus back to the calendar.
+          // We need to move the scroll to focused date.
+          setTimeout(() => this.revealDate(this.focusedDate), 1);
+        }
+        break;
+      case 'cancel':
+        if (!event.shiftKey) {
+          // Return focus back to the input field.
+          event.preventDefault();
+          this.__focusInput();
+        }
+        break;
+      default:
+        break;
+    }
+  }
+
   __onTodayButtonKeyDown(event) {
     if (this.hasAttribute('fullscreen')) {
-      event.stopPropagation();
+      // Do not prevent closing on Esc
+      if (event.key !== 'Escape') {
+        event.stopPropagation();
+      }
       return;
     }
 
-    if (event.key === 'Tab' && event.shiftKey) {
-      event.stopPropagation();
-
-      // Browser returns focus back to the calendar.
-      // We need to move the scroll to focused date.
-      setTimeout(() => this.revealDate(this.focusedDate), 1);
+    if (event.key === 'Tab') {
+      this._onTabKeyDown(event, 'today');
     }
   }
 
   __onCancelButtonKeyDown(event) {
     if (this.hasAttribute('fullscreen')) {
-      event.stopPropagation();
+      // Do not prevent closing on Esc
+      if (event.key !== 'Escape') {
+        event.stopPropagation();
+      }
       return;
     }
 
-    if (event.key === 'Tab' && !event.shiftKey) {
-      // Return focus back to the input field
-      event.preventDefault();
-      event.stopPropagation();
-      this.dispatchEvent(new CustomEvent('focus-input', { bubbles: true, composed: true }));
+    if (event.key === 'Tab') {
+      this._onTabKeyDown(event, 'cancel');
     }
   }
 
+  __focusInput() {
+    this.dispatchEvent(new CustomEvent('focus-input', { bubbles: true, composed: true }));
+  }
+
   __tryFocusDate() {
     const dateToFocus = this.__pendingDateFocus;
     if (dateToFocus) {

package/src/vaadin-date-picker.js

@@ -186,7 +186,7 @@ class DatePicker extends DatePickerMixin(InputControlMixin(ThemableMixin(Element
   }
 
   /**
-   * Used by `ClearButtonMixin` as a reference to the clear button element.
+   * Used by `InputControlMixin` as a reference to the clear button element.
    * @protected
    * @return {!HTMLElement}
    */
@@ -212,6 +212,13 @@ class DatePicker extends DatePickerMixin(InputControlMixin(ThemableMixin(Element
     toggleButton.addEventListener('mousedown', (e) => e.preventDefault());
   }
 
+  /** @protected */
+  _initOverlay() {
+    super._initOverlay();
+
+    this.$.overlay.addEventListener('vaadin-overlay-close', this._onVaadinOverlayClose.bind(this));
+  }
+
   /** @private */
   _onVaadinOverlayClose(e) {
     if (this._openedWithFocusRing && this.hasAttribute('focused')) {