@rdlabo/ionic-theme-ios27 0.1.0-0

package/src/tab-bar-searchable/utils.ts

@@ -0,0 +1,75 @@
+import { ElementReferences, ElementSizes } from './interfaces';
+
+export const ANIMATION_DURATION = 400;
+export const ANIMATION_DELAY_BASE = 140;
+export const ANIMATION_DELAY_CLOSE_BUTTONS = 240;
+export const ANIMATION_EASING = 'cubic-bezier(0, 1, 0.22, 1)';
+export const OPACITY_TRANSITION = 'opacity 140ms ease';
+
+export const throwErrorByFailedClickElement = (selector: string): Error => {
+  return new Error('Expected click element to be inside `' + selector + '`');
+};
+
+export const throwErrorByFailedExistElement = (selector: string): Error => {
+  return new Error('Expected element `' + selector + '` to exist');
+};
+
+export const getElement = (docs: HTMLElement, selector: string): HTMLElement => {
+  const el = docs.querySelector<HTMLElement>(selector);
+  if (!el) {
+    throw throwErrorByFailedClickElement(selector);
+  }
+  return el;
+};
+
+export const getElementReferences = (ionTabBar: HTMLElement, ionFooter: HTMLElement): ElementReferences => {
+  const searchContainer = getElement(ionFooter, 'ion-searchbar .searchbar-input-container');
+  const closeButtons = getElement(ionFooter, 'ion-buttons[slot=start]');
+  const selectedTabButton = ionTabBar.querySelector<HTMLElement>('ion-tab-button.tab-selected');
+  const selectedTabButtonIcon = selectedTabButton?.querySelector('ion-icon');
+  const closeButtonIcon = closeButtons.querySelector('ion-icon');
+
+  if (!selectedTabButton) {
+    throw throwErrorByFailedExistElement('ion-tab-button.tab-selected');
+  }
+
+  if (!selectedTabButtonIcon) {
+    throw throwErrorByFailedExistElement('ion-tab-button.tab-selected ion-icon');
+  }
+
+  if (!closeButtonIcon) {
+    throw throwErrorByFailedExistElement('ion-buttons[slot=start] ion-button ion-icon');
+  }
+
+  return {
+    searchContainer,
+    closeButtons,
+    selectedTabButton,
+    selectedTabButtonIcon,
+    closeButtonIcon,
+  };
+};
+
+/**
+ * 各要素のサイズ情報を取得
+ */
+export const getElementSizes = (ionTabBar: HTMLElement, ionFabButton: HTMLElement, references: ElementReferences): ElementSizes => {
+  const tabBarRect = ionTabBar.getBoundingClientRect();
+  const fabButtonRect = ionFabButton.getBoundingClientRect();
+  const closeButtonRect = references.closeButtons.getBoundingClientRect();
+  const searchContainerRect = references.searchContainer.getBoundingClientRect();
+  const selectedTabButtonIconRect = references.selectedTabButtonIcon!.getBoundingClientRect();
+
+  return {
+    tabBar: { width: tabBarRect.width, height: tabBarRect.height },
+    closeButton: { width: closeButtonRect.width, height: closeButtonRect.height },
+    fabButton: { width: fabButtonRect.width, height: fabButtonRect.height },
+    searchContainer: { width: searchContainerRect.width, height: searchContainerRect.height },
+    selectedTabButtonIcon: {
+      width: selectedTabButtonIconRect.width,
+      height: selectedTabButtonIconRect.height,
+      top: selectedTabButtonIconRect.top,
+      left: selectedTabButtonIconRect.left,
+    },
+  };
+};

package/src/transition/index.ts

@@ -0,0 +1,369 @@
+import { config } from '../utils';
+import { Build, writeTask } from '@stencil/core';
+
+import { LIFECYCLE_DID_ENTER, LIFECYCLE_DID_LEAVE, LIFECYCLE_WILL_ENTER, LIFECYCLE_WILL_LEAVE } from '@ionic/core';
+import type { NavOptions, NavDirection } from '@ionic/core';
+import type { Animation, AnimationBuilder } from '@ionic/core';
+import { createFocusController } from '../focus-controller';
+import { raf } from '../utils';
+
+const iosTransitionAnimation = () => import('./ios.transition');
+// const mdTransitionAnimation = () => import('./md.transition');
+const focusController = createFocusController();
+
+// TODO(FW-2832): types
+
+/**
+ * Executes the main page transition.
+ * It also manages the lifecycle of header visibility (if any)
+ * to prevent visual flickering in iOS. The flickering only
+ * occurs for a condensed header that is placed above the content.
+ *
+ * @param opts Options for the transition.
+ * @returns A promise that resolves when the transition is complete.
+ */
+export const transition = (opts: TransitionOptions): Promise<TransitionResult> => {
+  return new Promise((resolve, reject) => {
+    writeTask(() => {
+      const transitioningInactiveHeader = getIosIonHeader(opts);
+      beforeTransition(opts, transitioningInactiveHeader);
+      runTransition(opts)
+        .then(
+          (result) => {
+            if (result.animation) {
+              result.animation.destroy();
+            }
+            afterTransition(opts);
+            resolve(result);
+          },
+          (error) => {
+            afterTransition(opts);
+            reject(error);
+          },
+        )
+        .finally(() => {
+          // Ensure that the header is restored to its original state.
+          setHeaderTransitionClass(transitioningInactiveHeader, false);
+        });
+    });
+  });
+};
+
+const beforeTransition = (opts: TransitionOptions, transitioningInactiveHeader: HTMLElement | null) => {
+  const enteringEl = opts.enteringEl;
+  const leavingEl = opts.leavingEl;
+
+  focusController.saveViewFocus(leavingEl);
+
+  setZIndex(enteringEl, leavingEl, opts.direction);
+  // Prevent flickering of the header by adding a class.
+  setHeaderTransitionClass(transitioningInactiveHeader, true);
+
+  if (opts.showGoBack) {
+    enteringEl.classList.add('can-go-back');
+  } else {
+    enteringEl.classList.remove('can-go-back');
+  }
+  setPageHidden(enteringEl, false);
+
+  /**
+   * When transitioning, the page should not
+   * respond to click events. This resolves small
+   * issues like users double tapping the ion-back-button.
+   * These pointer events are removed in `afterTransition`.
+   */
+  enteringEl.style.setProperty('pointer-events', 'none');
+
+  if (leavingEl) {
+    setPageHidden(leavingEl, false);
+    leavingEl.style.setProperty('pointer-events', 'none');
+  }
+};
+
+const runTransition = async (opts: TransitionOptions): Promise<TransitionResult> => {
+  const animationBuilder = await getAnimationBuilder(opts);
+
+  const ani = animationBuilder && Build.isBrowser ? animation(animationBuilder, opts) : noAnimation(opts); // fast path for no animation
+
+  return ani;
+};
+
+const afterTransition = (opts: TransitionOptions) => {
+  const enteringEl = opts.enteringEl;
+  const leavingEl = opts.leavingEl;
+  enteringEl.classList.remove('ion-page-invisible');
+  enteringEl.style.removeProperty('pointer-events');
+  if (leavingEl !== undefined) {
+    leavingEl.classList.remove('ion-page-invisible');
+    leavingEl.style.removeProperty('pointer-events');
+  }
+
+  focusController.setViewFocus(enteringEl);
+};
+
+const getAnimationBuilder = async (opts: TransitionOptions): Promise<AnimationBuilder | undefined> => {
+  if (!opts.leavingEl || !opts.animated || opts.duration === 0) {
+    return undefined;
+  }
+
+  if (opts.animationBuilder) {
+    return opts.animationBuilder;
+  }
+
+  const getAnimation =
+    // opts.mode === 'ios'
+    (await iosTransitionAnimation()).iosTransitionAnimation;
+  // : (await mdTransitionAnimation()).mdTransitionAnimation;
+
+  return getAnimation;
+};
+
+const animation = async (animationBuilder: AnimationBuilder, opts: TransitionOptions): Promise<TransitionResult> => {
+  await waitForReady(opts, true);
+
+  const trans = animationBuilder(opts.baseEl, opts);
+
+  fireWillEvents(opts.enteringEl, opts.leavingEl);
+
+  const didComplete = await playTransition(trans, opts);
+
+  if (opts.progressCallback) {
+    opts.progressCallback(undefined);
+  }
+
+  if (didComplete) {
+    fireDidEvents(opts.enteringEl, opts.leavingEl);
+  }
+
+  return {
+    hasCompleted: didComplete,
+    animation: trans,
+  };
+};
+
+const noAnimation = async (opts: TransitionOptions): Promise<TransitionResult> => {
+  const enteringEl = opts.enteringEl;
+  const leavingEl = opts.leavingEl;
+  const focusManagerEnabled = config.get('focusManagerPriority', false);
+
+  /**
+   * If the focus manager is enabled then we need to wait for Ionic components to be
+   * rendered otherwise the component to focus may not be focused because it is hidden.
+   */
+  await waitForReady(opts, focusManagerEnabled);
+
+  fireWillEvents(enteringEl, leavingEl);
+  fireDidEvents(enteringEl, leavingEl);
+
+  return {
+    hasCompleted: true,
+  };
+};
+
+const waitForReady = async (opts: TransitionOptions, defaultDeep: boolean) => {
+  const deep = opts.deepWait !== undefined ? opts.deepWait : defaultDeep;
+
+  if (deep) {
+    await Promise.all([deepReady(opts.enteringEl), deepReady(opts.leavingEl)]);
+  }
+
+  await notifyViewReady(opts.viewIsReady, opts.enteringEl);
+};
+
+const notifyViewReady = async (viewIsReady: undefined | ((enteringEl: HTMLElement) => Promise<any>), enteringEl: HTMLElement) => {
+  if (viewIsReady) {
+    await viewIsReady(enteringEl);
+  }
+};
+
+const playTransition = (trans: Animation, opts: TransitionOptions): Promise<boolean> => {
+  const progressCallback = opts.progressCallback;
+
+  const promise = new Promise<boolean>((resolve) => {
+    trans.onFinish((currentStep: any) => resolve(currentStep === 1));
+  });
+
+  // cool, let's do this, start the transition
+  if (progressCallback) {
+    // this is a swipe to go back, just get the transition progress ready
+    // kick off the swipe animation start
+    trans.progressStart(true);
+    progressCallback(trans);
+  } else {
+    // only the top level transition should actually start "play"
+    // kick it off and let it play through
+    // ******** DOM WRITE ****************
+    trans.play();
+  }
+  // create a callback for when the animation is done
+  return promise;
+};
+
+const fireWillEvents = (enteringEl: HTMLElement | undefined, leavingEl: HTMLElement | undefined) => {
+  lifecycle(leavingEl, LIFECYCLE_WILL_LEAVE);
+  lifecycle(enteringEl, LIFECYCLE_WILL_ENTER);
+};
+
+const fireDidEvents = (enteringEl: HTMLElement | undefined, leavingEl: HTMLElement | undefined) => {
+  lifecycle(enteringEl, LIFECYCLE_DID_ENTER);
+  lifecycle(leavingEl, LIFECYCLE_DID_LEAVE);
+};
+
+export const lifecycle = (el: HTMLElement | undefined, eventName: string) => {
+  if (el) {
+    const ev = new CustomEvent(eventName, {
+      bubbles: false,
+      cancelable: false,
+    });
+    el.dispatchEvent(ev);
+  }
+};
+
+/**
+ * Wait two request animation frame loops.
+ * This allows the framework implementations enough time to mount
+ * the user-defined contents. This is often needed when using inline
+ * modals and popovers that accept user components. For popover,
+ * the contents must be mounted for the popover to be sized correctly.
+ * For modals, the contents must be mounted for iOS to run the
+ * transition correctly.
+ *
+ * On Angular and React, a single raf is enough time, but for Vue
+ * we need to wait two rafs. As a result we are using two rafs for
+ * all frameworks to ensure contents are mounted.
+ */
+export const waitForMount = (): Promise<void> => {
+  return new Promise((resolve) => raf(() => raf(() => resolve())));
+};
+
+export const deepReady = async (el: any | undefined): Promise<void> => {
+  const element = el as any;
+  if (element) {
+    if (element.componentOnReady != null) {
+      // eslint-disable-next-line custom-rules/no-component-on-ready-method
+      const stencilEl = await element.componentOnReady();
+      if (stencilEl != null) {
+        return;
+      }
+
+      /**
+       * Custom elements in Stencil will have __registerHost.
+       */
+    } else if (element.__registerHost != null) {
+      /**
+       * Non-lazy loaded custom elements need to wait
+       * one frame for component to be loaded.
+       */
+      const waitForCustomElement = new Promise((resolve) => raf(resolve));
+      await waitForCustomElement;
+
+      return;
+    }
+    await Promise.all(Array.from(element.children).map(deepReady));
+  }
+};
+
+export const setPageHidden = (el: HTMLElement, hidden: boolean) => {
+  if (hidden) {
+    el.setAttribute('aria-hidden', 'true');
+    el.classList.add('ion-page-hidden');
+  } else {
+    el.hidden = false;
+    el.removeAttribute('aria-hidden');
+    el.classList.remove('ion-page-hidden');
+  }
+};
+
+const setZIndex = (enteringEl: HTMLElement | undefined, leavingEl: HTMLElement | undefined, direction: NavDirection | undefined) => {
+  if (enteringEl !== undefined) {
+    enteringEl.style.zIndex = direction === 'back' ? '99' : '101';
+  }
+  if (leavingEl !== undefined) {
+    leavingEl.style.zIndex = '100';
+  }
+};
+
+/**
+ * Add a class to ensure that the header (if any)
+ * does not flicker during the transition. By adding the
+ * transitioning class, we ensure that the header has
+ * the necessary styles to prevent the following flickers:
+ * 1. When entering a page with a condensed header, the
+ * header should never be visible. However,
+ * it briefly renders the background color while
+ * the transition is occurring.
+ * 2. When leaving a page with a condensed header, the
+ * header has an opacity of 0 and the pages
+ * have a z-index which causes the entering page to
+ * briefly show it's content underneath the leaving page.
+ * 3. When entering a page or leaving a page with a fade
+ * header, the header should not have a background color.
+ * However, it briefly shows the background color while
+ * the transition is occurring.
+ *
+ * @param header The header element to modify.
+ * @param isTransitioning Whether the transition is occurring.
+ */
+const setHeaderTransitionClass = (header: HTMLElement | null, isTransitioning: boolean) => {
+  if (!header) {
+    return;
+  }
+
+  const transitionClass = 'header-transitioning';
+  if (isTransitioning) {
+    header.classList.add(transitionClass);
+  } else {
+    header.classList.remove(transitionClass);
+  }
+};
+
+export const getIonPageElement = (element: HTMLElement) => {
+  if (element.classList.contains('ion-page')) {
+    return element;
+  }
+
+  const ionPage = element.querySelector(':scope > .ion-page, :scope > ion-nav, :scope > ion-tabs');
+  if (ionPage) {
+    return ionPage;
+  }
+  // idk, return the original element so at least something animates and we don't have a null pointer
+  return element;
+};
+
+/**
+ * Retrieves the ion-header element from a page based on the
+ * direction of the transition.
+ *
+ * @param opts Options for the transition.
+ * @returns The ion-header element or null if not found or not in 'ios' mode.
+ */
+const getIosIonHeader = (opts: TransitionOptions): HTMLElement | null => {
+  const enteringEl = opts.enteringEl;
+  const leavingEl = opts.leavingEl;
+  const direction = opts.direction;
+  const mode = opts.mode;
+
+  if (mode !== 'ios') {
+    return null;
+  }
+
+  const element = direction === 'back' ? leavingEl : enteringEl;
+
+  if (!element) {
+    return null;
+  }
+
+  return element.querySelector('ion-header');
+};
+
+export interface TransitionOptions extends NavOptions {
+  progressCallback?: (ani: Animation | undefined) => void;
+  baseEl: any;
+  enteringEl: HTMLElement;
+  leavingEl: HTMLElement | undefined;
+}
+
+export interface TransitionResult {
+  hasCompleted: boolean;
+  animation?: Animation;
+}