voyager-ionic-core 7.6.3 → 7.7.0

package/dist/collection/utils/overlays.js

@@ -2,6 +2,7 @@
  * (C) Ionic http://ionicframework.com - MIT License
  */
 import { doc } from "./browser/index";
+import { shoudUseCloseWatcher } from "./hardware-back-button";
 import { config } from "../global/config";
 import { getIonMode } from "../global/ionic-global";
 import { CoreDelegate } from "./framework-delegate";
@@ -296,19 +297,38 @@ const connectListeners = (doc) => {
             const lastOverlay = getPresentedOverlay(doc);
             if (lastOverlay === null || lastOverlay === void 0 ? void 0 : lastOverlay.backdropDismiss) {
                 ev.detail.register(OVERLAY_BACK_BUTTON_PRIORITY, () => {
-                    return lastOverlay.dismiss(undefined, BACKDROP);
+                    /**
+                     * Do not return this promise otherwise
+                     * the hardware back button utility will
+                     * be blocked until the overlay dismisses.
+                     * This is important for a modal with canDismiss.
+                     * If the application presents a confirmation alert
+                     * in the "canDismiss" callback, then it will be impossible
+                     * to use the hardware back button to dismiss the alert
+                     * dialog because the hardware back button utility
+                     * is blocked on waiting for the modal to dismiss.
+                     */
+                    lastOverlay.dismiss(undefined, BACKDROP);
                 });
             }
         });
-        // handle ESC to close overlay
-        doc.addEventListener('keydown', (ev) => {
-            if (ev.key === 'Escape') {
-                const lastOverlay = getPresentedOverlay(doc);
-                if (lastOverlay === null || lastOverlay === void 0 ? void 0 : lastOverlay.backdropDismiss) {
-                    lastOverlay.dismiss(undefined, BACKDROP);
+        /**
+         * Handle ESC to close overlay.
+         * CloseWatcher also handles pressing the Esc
+         * key, so if a browser supports CloseWatcher then
+         * this behavior will be handled via the ionBackButton
+         * event.
+         */
+        if (!shoudUseCloseWatcher()) {
+            doc.addEventListener('keydown', (ev) => {
+                if (ev.key === 'Escape') {
+                    const lastOverlay = getPresentedOverlay(doc);
+                    if (lastOverlay === null || lastOverlay === void 0 ? void 0 : lastOverlay.backdropDismiss) {
+                        lastOverlay.dismiss(undefined, BACKDROP);
+                    }
                 }
-            }
-        });
+            });
+        }
     }
 };
 export const dismissOverlay = (doc, data, role, overlayTag, id) => {
@@ -411,7 +431,7 @@ export const present = async (overlay, name, iosEnterAnimation, mdEnterAnimation
      * from returning focus as a result.
      */
     if (overlay.el.tagName !== 'ION-TOAST') {
-        focusPreviousElementOnDismiss(overlay.el);
+        focusPreviousElementOnDismissIfNeeded(overlay.el);
     }
     /**
      * If the focused element is already
@@ -433,7 +453,7 @@ export const present = async (overlay, name, iosEnterAnimation, mdEnterAnimation
  * to where they were before they
  * opened the overlay.
  */
-const focusPreviousElementOnDismiss = async (overlayEl) => {
+const focusPreviousElementOnDismissIfNeeded = async (overlayEl) => {
     let previousElement = document.activeElement;
     if (!previousElement) {
         return;
@@ -444,7 +464,16 @@ const focusPreviousElementOnDismiss = async (overlayEl) => {
         previousElement = shadowRoot.querySelector(focusableQueryString) || previousElement;
     }
     await overlayEl.onDidDismiss();
-    previousElement.focus();
+    /**
+     * If the user has already removed focus
+     * from the overlay (For example, focusing
+     * a text box after tapping a button in an
+     * action sheet) then don't restore focus
+     * to previous element
+     */
+    if (document.activeElement === null || document.activeElement === document.body) {
+        previousElement.focus();
+    }
 };
 export const dismiss = async (overlay, data, role, name, iosLeaveAnimation, mdLeaveAnimation, opts) => {
     var _a, _b;

package/dist/collection/utils/test/hardware-back-button.spec.js

@@ -2,6 +2,8 @@
  * (C) Ionic http://ionicframework.com - MIT License
  */
 import { startHardwareBackButton } from "../hardware-back-button";
+import { config } from "../../global/config";
+import { win } from "../browser/index";
 describe('Hardware Back Button', () => {
     beforeEach(() => startHardwareBackButton());
     it('should call handler', () => {
@@ -47,6 +49,42 @@ describe('Hardware Back Button', () => {
         expect(cbSpyTwo).toHaveBeenCalled();
     });
 });
+describe('Experimental Close Watcher', () => {
+    test('should not use the Close Watcher API when available', () => {
+        const mockAPI = mockCloseWatcher();
+        config.reset({ experimentalCloseWatcher: false });
+        startHardwareBackButton();
+        expect(mockAPI.mock.calls).toHaveLength(0);
+    });
+    test('should use the Close Watcher API when available', () => {
+        const mockAPI = mockCloseWatcher();
+        config.reset({ experimentalCloseWatcher: true });
+        startHardwareBackButton();
+        expect(mockAPI.mock.calls).toHaveLength(1);
+    });
+    test('Close Watcher should dispatch ionBackButton events', () => {
+        const mockAPI = mockCloseWatcher();
+        config.reset({ experimentalCloseWatcher: true });
+        startHardwareBackButton();
+        const cbSpy = jest.fn();
+        document.addEventListener('ionBackButton', cbSpy);
+        // Call onclose on Ionic's instance of CloseWatcher
+        mockAPI.getMockImplementation()().onclose();
+        expect(cbSpy).toHaveBeenCalled();
+    });
+});
+const mockCloseWatcher = () => {
+    const mockCloseWatcher = jest.fn();
+    mockCloseWatcher.mockReturnValue({
+        requestClose: () => null,
+        close: () => null,
+        destroy: () => null,
+        oncancel: () => null,
+        onclose: () => null,
+    });
+    win.CloseWatcher = mockCloseWatcher;
+    return mockCloseWatcher;
+};
 const dispatchBackButtonEvent = () => {
     const ev = new Event('backbutton');
     document.dispatchEvent(ev);

package/dist/docs.d.ts

@@ -60,30 +60,10 @@ interface ComponentCompilerEventComplexType {
 }
 interface ComponentCompilerMethodComplexType {
   signature: string;
-  parameters: CompilerJsDoc[];
+  parameters: JsonDocMethodParameter[];
   references: ComponentCompilerTypeReferences;
   return: string;
 }
-interface CompilerJsDoc {
-  /**
-   * The text associated with the JSDoc
-   */
-  text: string;
-  /**
-   * Tags included in the JSDoc
-   */
-  tags: CompilerJsDocTagInfo[];
-}
-interface CompilerJsDocTagInfo {
-  /**
-   * The name of the tag - e.g. `@deprecated`
-   */
-  name: string;
-  /**
-   * Additional text that is associated with the tag - e.g. `@deprecated use v2 of this API`
-   */
-  text?: string;
-}
 /**
  * The Type Library holds information about the types which are used in a
  * Stencil project. During compilation, Stencil gathers information about the