@sparkle-learning/core 0.0.27 → 0.0.30

package/dist/cjs/{overlays-08a817ea.js → overlays-0a748609.js}

@@ -1,9 +1,12 @@
 'use strict';
 
-const ionicGlobal = require('./ionic-global-4930d319.js');
-const helpers = require('./helpers-26770c32.js');
-const hardwareBackButton = require('./hardware-back-button-ca468aae.js');
+const ionicGlobal = require('./ionic-global-878073d1.js');
+const hardwareBackButton = require('./hardware-back-button-f7b5d99e.js');
+const helpers = require('./helpers-7e28976c.js');
 
+/*!
+ * (C) Ionic http://ionicframework.com - MIT License
+ */
 let lastId = 0;
 const activeAnimations = new WeakMap();
 const createController = (tagName) => {
@@ -22,7 +25,6 @@ const createController = (tagName) => {
 const alertController = /*@__PURE__*/ createController('ion-alert');
 const actionSheetController = /*@__PURE__*/ createController('ion-action-sheet');
 const modalController = /*@__PURE__*/ createController('ion-modal');
-const pickerController = /*@__PURE__*/ createController('ion-picker');
 const popoverController = /*@__PURE__*/ createController('ion-popover');
 const toastController = /*@__PURE__*/ createController('ion-toast');
 const prepareOverlay = (el) => {
@@ -38,16 +40,18 @@ const prepareOverlay = (el) => {
 };
 const createOverlay = (tagName, opts) => {
   /* tslint:disable-next-line */
-  if (typeof customElements !== 'undefined') {
-    return customElements.whenDefined(tagName).then(() => {
+  if (typeof window !== 'undefined' && typeof window.customElements !== 'undefined') {
+    return window.customElements.whenDefined(tagName).then(() => {
       const element = document.createElement(tagName);
       element.classList.add('overlay-hidden');
-      // convert the passed in overlay options into props
-      // that get passed down into the new overlay
-      Object.assign(element, opts);
+      /**
+       * Convert the passed in overlay options into props
+       * that get passed down into the new overlay.
+       */
+      Object.assign(element, Object.assign(Object.assign({}, opts), { hasController: true }));
       // append the overlay element to the document body
       getAppRoot(document).appendChild(element);
-      return element.componentOnReady();
+      return new Promise(resolve => helpers.componentOnReady(element, resolve));
     });
   }
   return Promise.resolve();
@@ -62,13 +66,14 @@ const focusFirstDescendant = (ref, overlay) => {
     firstInput = shadowRoot.querySelector(innerFocusableQueryString) || firstInput;
   }
   if (firstInput) {
-    firstInput.focus();
+    helpers.focusElement(firstInput);
   }
   else {
     // Focus overlay instead of letting focus escape
     overlay.focus();
   }
 };
+const isOverlayHidden = (overlay) => overlay.classList.contains('overlay-hidden');
 const focusLastDescendant = (ref, overlay) => {
   const inputs = Array.from(ref.querySelectorAll(focusableQueryString));
   let lastInput = inputs.length > 0 ? inputs[inputs.length - 1] : null;
@@ -93,53 +98,116 @@ const focusLastDescendant = (ref, overlay) => {
  * Should NOT include: Toast
  */
 const trapKeyboardFocus = (ev, doc) => {
-  const lastOverlay = getOverlay(doc);
+  const lastOverlay = getOverlay(doc, 'ion-alert,ion-action-sheet,ion-loading,ion-modal,ion-picker,ion-popover');
   const target = ev.target;
-  // If no active overlay, ignore this event
+  /**
+   * If no active overlay, ignore this event.
+   *
+   * If this component uses the shadow dom,
+   * this global listener is pointless
+   * since it will not catch the focus
+   * traps as they are inside the shadow root.
+   * We need to add a listener to the shadow root
+   * itself to ensure the focus trap works.
+   */
   if (!lastOverlay || !target) {
     return;
   }
   /**
-   * If we are focusing the overlay, clear
-   * the last focused element so that hitting
-   * tab activates the first focusable element
-   * in the overlay wrapper.
+   * If the ion-disable-focus-trap class
+   * is present on an overlay, then this component
+   * instance has opted out of focus trapping.
+   * An example of this is when the sheet modal
+   * has a backdrop that is disabled. The content
+   * behind the sheet should be focusable until
+   * the backdrop is enabled.
    */
-  if (lastOverlay === target) {
-    lastOverlay.lastFocus = undefined;
-    /**
-     * Otherwise, we must be focusing an element
-     * inside of the overlay. The two possible options
-     * here are an input/button/etc or the ion-focus-trap
-     * element. The focus trap element is used to prevent
-     * the keyboard focus from leaving the overlay when
-     * using Tab or screen assistants.
-     */
+  if (lastOverlay.classList.contains('ion-disable-focus-trap')) {
+    return;
   }
-  else {
+  const trapScopedFocus = () => {
     /**
-     * We do not want to focus the traps, so get the overlay
-     * wrapper element as the traps live outside of the wrapper.
+     * If we are focusing the overlay, clear
+     * the last focused element so that hitting
+     * tab activates the first focusable element
+     * in the overlay wrapper.
      */
-    const overlayRoot = helpers.getElementRoot(lastOverlay);
-    if (!overlayRoot.contains(target)) {
-      return;
+    if (lastOverlay === target) {
+      lastOverlay.lastFocus = undefined;
+      /**
+       * Otherwise, we must be focusing an element
+       * inside of the overlay. The two possible options
+       * here are an input/button/etc or the ion-focus-trap
+       * element. The focus trap element is used to prevent
+       * the keyboard focus from leaving the overlay when
+       * using Tab or screen assistants.
+       */
     }
-    const overlayWrapper = overlayRoot.querySelector('.ion-overlay-wrapper');
-    if (!overlayWrapper) {
-      return;
+    else {
+      /**
+       * We do not want to focus the traps, so get the overlay
+       * wrapper element as the traps live outside of the wrapper.
+       */
+      const overlayRoot = helpers.getElementRoot(lastOverlay);
+      if (!overlayRoot.contains(target)) {
+        return;
+      }
+      const overlayWrapper = overlayRoot.querySelector('.ion-overlay-wrapper');
+      if (!overlayWrapper) {
+        return;
+      }
+      /**
+       * If the target is inside the wrapper, let the browser
+       * focus as normal and keep a log of the last focused element.
+       */
+      if (overlayWrapper.contains(target)) {
+        lastOverlay.lastFocus = target;
+      }
+      else {
+        /**
+         * Otherwise, we must have focused one of the focus traps.
+         * We need to wrap the focus to either the first element
+         * or the last element.
+         */
+        /**
+         * Once we call `focusFirstDescendant` and focus the first
+         * descendant, another focus event will fire which will
+         * cause `lastOverlay.lastFocus` to be updated before
+         * we can run the code after that. We will cache the value
+         * here to avoid that.
+         */
+        const lastFocus = lastOverlay.lastFocus;
+        // Focus the first element in the overlay wrapper
+        focusFirstDescendant(overlayWrapper, lastOverlay);
+        /**
+         * If the cached last focused element is the
+         * same as the active element, then we need
+         * to wrap focus to the last descendant. This happens
+         * when the first descendant is focused, and the user
+         * presses Shift + Tab. The previous line will focus
+         * the same descendant again (the first one), causing
+         * last focus to equal the active element.
+         */
+        if (lastFocus === doc.activeElement) {
+          focusLastDescendant(overlayWrapper, lastOverlay);
+        }
+        lastOverlay.lastFocus = doc.activeElement;
+      }
     }
+  };
+  const trapShadowFocus = () => {
     /**
      * If the target is inside the wrapper, let the browser
      * focus as normal and keep a log of the last focused element.
      */
-    if (overlayWrapper.contains(target)) {
+    if (lastOverlay.contains(target)) {
       lastOverlay.lastFocus = target;
     }
     else {
       /**
-       * Otherwise, we must have focused one of the focus traps.
-       * We need to wrap the focus to either the first element
+       * Otherwise, we are about to have focus
+       * go out of the overlay. We need to wrap
+       * the focus to either the first element
        * or the last element.
        */
       /**
@@ -151,7 +219,7 @@ const trapKeyboardFocus = (ev, doc) => {
        */
       const lastFocus = lastOverlay.lastFocus;
       // Focus the first element in the overlay wrapper
-      focusFirstDescendant(overlayWrapper, lastOverlay);
+      focusFirstDescendant(lastOverlay, lastOverlay);
       /**
        * If the cached last focused element is the
        * same as the active element, then we need
@@ -162,16 +230,24 @@ const trapKeyboardFocus = (ev, doc) => {
        * last focus to equal the active element.
        */
       if (lastFocus === doc.activeElement) {
-        focusLastDescendant(overlayWrapper, lastOverlay);
+        focusLastDescendant(lastOverlay, lastOverlay);
       }
       lastOverlay.lastFocus = doc.activeElement;
     }
+  };
+  if (lastOverlay.shadowRoot) {
+    trapShadowFocus();
+  }
+  else {
+    trapScopedFocus();
   }
 };
 const connectListeners = (doc) => {
   if (lastId === 0) {
     lastId = 1;
-    doc.addEventListener('focus', ev => trapKeyboardFocus(ev, doc), true);
+    doc.addEventListener('focus', (ev) => {
+      trapKeyboardFocus(ev, doc);
+    }, true);
     // handle back-button click
     doc.addEventListener('ionBackButton', ev => {
       const lastOverlay = getOverlay(doc);
@@ -206,18 +282,63 @@ const getOverlays = (doc, selector) => {
   return Array.from(doc.querySelectorAll(selector))
     .filter(c => c.overlayIndex > 0);
 };
+/**
+ * Returns an overlay element
+ * @param doc The document to find the element within.
+ * @param overlayTag The selector for the overlay, defaults to Ionic overlay components.
+ * @param id The unique identifier for the overlay instance.
+ * @returns The overlay element or `undefined` if no overlay element is found.
+ */
 const getOverlay = (doc, overlayTag, id) => {
-  const overlays = getOverlays(doc, overlayTag);
+  const overlays = getOverlays(doc, overlayTag).filter(o => !isOverlayHidden(o));
   return (id === undefined)
     ? overlays[overlays.length - 1]
     : overlays.find(o => o.id === id);
 };
+/**
+ * When an overlay is presented, the main
+ * focus is the overlay not the page content.
+ * We need to remove the page content from the
+ * accessibility tree otherwise when
+ * users use "read screen from top" gestures with
+ * TalkBack and VoiceOver, the screen reader will begin
+ * to read the content underneath the overlay.
+ *
+ * We need a container where all page components
+ * exist that is separate from where the overlays
+ * are added in the DOM. For most apps, this element
+ * is the top most ion-router-outlet. In the event
+ * that devs are not using a router,
+ * they will need to add the "ion-view-container-root"
+ * id to the element that contains all of their views.
+ *
+ * TODO: If Framework supports having multiple top
+ * level router outlets we would need to update this.
+ * Example: One outlet for side menu and one outlet
+ * for main content.
+ */
+const setRootAriaHidden = (hidden = false) => {
+  const root = getAppRoot(document);
+  const viewContainer = root.querySelector('ion-router-outlet, ion-nav, #ion-view-container-root');
+  if (!viewContainer) {
+    return;
+  }
+  if (hidden) {
+    viewContainer.setAttribute('aria-hidden', 'true');
+  }
+  else {
+    viewContainer.removeAttribute('aria-hidden');
+  }
+};
 const present = async (overlay, name, iosEnterAnimation, mdEnterAnimation, opts) => {
+  var _a, _b;
   if (overlay.presented) {
     return;
   }
+  setRootAriaHidden(true);
   overlay.presented = true;
   overlay.willPresent.emit();
+  (_a = overlay.willPresentShorthand) === null || _a === void 0 ? void 0 : _a.emit();
   const mode = ionicGlobal.getIonMode(overlay);
   // get the user's animation fn if one was provided
   const animationBuilder = (overlay.enterAnimation)
@@ -226,6 +347,7 @@ const present = async (overlay, name, iosEnterAnimation, mdEnterAnimation, opts)
   const completed = await overlayAnimation(overlay, animationBuilder, overlay.el, opts);
   if (completed) {
     overlay.didPresent.emit();
+    (_b = overlay.didPresentShorthand) === null || _b === void 0 ? void 0 : _b.emit();
   }
   /**
    * When an overlay that steals focus
@@ -266,14 +388,17 @@ const focusPreviousElementOnDismiss = async (overlayEl) => {
   previousElement.focus();
 };
 const dismiss = async (overlay, data, role, name, iosLeaveAnimation, mdLeaveAnimation, opts) => {
+  var _a, _b;
   if (!overlay.presented) {
     return false;
   }
+  setRootAriaHidden(false);
   overlay.presented = false;
   try {
     // Overlay contents should not be clickable during dismiss
     overlay.el.style.setProperty('pointer-events', 'none');
     overlay.willDismiss.emit({ data, role });
+    (_a = overlay.willDismissShorthand) === null || _a === void 0 ? void 0 : _a.emit({ data, role });
     const mode = ionicGlobal.getIonMode(overlay);
     const animationBuilder = (overlay.leaveAnimation)
       ? overlay.leaveAnimation
@@ -283,7 +408,15 @@ const dismiss = async (overlay, data, role, name, iosLeaveAnimation, mdLeaveAnim
       await overlayAnimation(overlay, animationBuilder, overlay.el, opts);
     }
     overlay.didDismiss.emit({ data, role });
+    (_b = overlay.didDismissShorthand) === null || _b === void 0 ? void 0 : _b.emit({ data, role });
     activeAnimations.delete(overlay);
+    /**
+     * Make overlay hidden again in case it is being reused.
+     * We can safely remove pointer-events: none as
+     * overlay-hidden will set display: none.
+     */
+    overlay.el.classList.add('overlay-hidden');
+    overlay.el.style.removeProperty('pointer-events');
   }
   catch (err) {
     console.error(err);
@@ -297,7 +430,7 @@ const getAppRoot = (doc) => {
 const overlayAnimation = async (overlay, animationBuilder, baseEl, opts) => {
   // Make overlay visible in case it's hidden
   baseEl.classList.remove('overlay-hidden');
-  const aniRoot = baseEl.shadowRoot || overlay.el;
+  const aniRoot = overlay.el;
   const animation = animationBuilder(aniRoot, opts);
   if (!overlay.animated || !ionicGlobal.config.getBoolean('animated', true)) {
     animation.duration(0);
@@ -305,7 +438,7 @@ const overlayAnimation = async (overlay, animationBuilder, baseEl, opts) => {
   if (overlay.keyboardClose) {
     animation.beforeAddWrite(() => {
       const activeElement = baseEl.ownerDocument.activeElement;
-      if (activeElement && activeElement.matches('input, ion-input, ion-textarea')) {
+      if (activeElement && activeElement.matches('input,ion-input, ion-textarea')) {
         activeElement.blur();
       }
     });
@@ -334,6 +467,13 @@ const isCancel = (role) => {
   return role === 'cancel' || role === BACKDROP;
 };
 const defaultGate = (h) => h();
+/**
+ * Calls a developer provided method while avoiding
+ * Angular Zones. Since the handler is provided by
+ * the developer, we should throw any errors
+ * received so that developer-provided bug
+ * tracking software can log it.
+ */
 const safeCall = (handler, arg) => {
   if (typeof handler === 'function') {
     const jmp = ionicGlobal.config.get('_zoneGate', defaultGate);
@@ -342,7 +482,7 @@ const safeCall = (handler, arg) => {
         return handler(arg);
       }
       catch (e) {
-        console.error(e);
+        throw e;
       }
     });
   }
@@ -356,9 +496,10 @@ exports.activeAnimations = activeAnimations;
 exports.alertController = alertController;
 exports.dismiss = dismiss;
 exports.eventMethod = eventMethod;
+exports.focusFirstDescendant = focusFirstDescendant;
+exports.getOverlay = getOverlay;
 exports.isCancel = isCancel;
 exports.modalController = modalController;
-exports.pickerController = pickerController;
 exports.popoverController = popoverController;
 exports.prepareOverlay = prepareOverlay;
 exports.present = present;