From bba940d5f7b740a2a69988169622d5fabfd874c7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vi=CC=81ctor=20CG?= <victorcg@empathy.co>
Date: Mon, 29 Jul 2024 12:57:08 +0200
Subject: [PATCH] refactor(staggered-fade-and-slide): use Vue native staggered
 transition

---
 .../src/components/animations/index.ts        |   1 +
 .../test-staggered-fade-and-slide.vue         |  68 +++++++++
 packages/_vue3-migration-test/src/router.ts   |   8 +-
 .../animations/staggered-fade-and-slide.vue   | 140 +++++++++++++-----
 .../x-components/src/components/base-grid.vue |  59 ++++----
 packages/x-components/src/views/home/Home.vue |   7 +-
 6 files changed, 213 insertions(+), 70 deletions(-)
 create mode 100644 packages/_vue3-migration-test/src/components/animations/test-staggered-fade-and-slide.vue

diff --git a/packages/_vue3-migration-test/src/components/animations/index.ts b/packages/_vue3-migration-test/src/components/animations/index.ts
index b951da74a4..ca0d8338a1 100644
--- a/packages/_vue3-migration-test/src/components/animations/index.ts
+++ b/packages/_vue3-migration-test/src/components/animations/index.ts
@@ -5,3 +5,4 @@ export { default as TestCrossFade } from './test-cross-fade.vue';
 export { default as TestFade } from './test-fade.vue';
 export { default as TestFadeAndSlide } from './test-fade-and-slide.vue';
 export { default as TestAnimationFactory } from './test-animation-factory.vue';
+export { default as TestStaggeredFadeAndSlide } from './test-staggered-fade-and-slide.vue';
diff --git a/packages/_vue3-migration-test/src/components/animations/test-staggered-fade-and-slide.vue b/packages/_vue3-migration-test/src/components/animations/test-staggered-fade-and-slide.vue
new file mode 100644
index 0000000000..dadcd355f5
--- /dev/null
+++ b/packages/_vue3-migration-test/src/components/animations/test-staggered-fade-and-slide.vue
@@ -0,0 +1,68 @@
+<template>
+  <h1>Dinamic content:</h1>
+  <button @click="insert">Insert at random index</button>
+  <button @click="reset">Reset</button>
+
+  <StaggeredFadeAndSlide :stagger="500">
+    <li v-for="item in items" :key="item.id">
+      {{ item.id }} - {{ item.name }}
+      <button @click="remove(item)">x</button>
+    </li>
+  </StaggeredFadeAndSlide>
+
+  <br />
+  <h1>Animation as prop</h1>
+  <BaseSuggestions :suggestions="suggestions" :animation="StaggeredFadeAndSlide" :stagger="50">
+    <template #default="{ suggestion }">
+      <span>{{ suggestion.query }}</span>
+    </template>
+  </BaseSuggestions>
+
+  <br />
+  <h1>Static content:</h1>
+  <StaggeredFadeAndSlide :stagger="50">
+    <li key="1">Element to animate</li>
+    <li key="2">Element to animate</li>
+    <li key="3">Element to animate</li>
+  </StaggeredFadeAndSlide>
+</template>
+
+<script setup lang="ts">
+  import { ref } from 'vue';
+  import StaggeredFadeAndSlide from '../../../../x-components/src/components/animations/staggered-fade-and-slide.vue';
+  import BaseSuggestions from '../../../../x-components/src/components/suggestions/base-suggestions.vue';
+  import {
+    getQuerySuggestionsStub,
+    createResultStub,
+    getResultsStub
+  } from '../../../../x-components/src/__stubs__';
+  const suggestions = getQuerySuggestionsStub('chip', 5);
+  const getInitialItems = () => getResultsStub(5);
+  const items = ref(getInitialItems());
+  let id = items.value.length + 1;
+  /**
+   * Insert a new item at a random index.
+   */
+  function insert() {
+    const i = Math.round(Math.random() * items.value.length);
+    items.value.splice(i, 0, createResultStub(`Product ${id++}`));
+  }
+  /**
+   * Reset the list of items.
+   */
+  function reset() {
+    items.value = getInitialItems();
+    id = items.value.length + 1;
+  }
+  /**
+   * Remove an item from the list.
+   *
+   * @param item - The item to remove.
+   */
+  function remove(item: any) {
+    const i = items.value.indexOf(item);
+    if (i > -1) {
+      items.value.splice(i, 1);
+    }
+  }
+</script>
diff --git a/packages/_vue3-migration-test/src/router.ts b/packages/_vue3-migration-test/src/router.ts
index c188737156..b6a8ec7597 100644
--- a/packages/_vue3-migration-test/src/router.ts
+++ b/packages/_vue3-migration-test/src/router.ts
@@ -49,7 +49,8 @@ import {
   TestRenderlessExtraParam,
   TestAnimationFactory,
   TestIcons,
-  TestDisplayEmitter
+  TestDisplayEmitter,
+  TestStaggeredFadeAndSlide
 } from './';
 
 const routes = [
@@ -302,6 +303,11 @@ const routes = [
     path: '/display-emitter',
     name: 'DisplayEmitter',
     component: TestDisplayEmitter
+  },
+  {
+    path: '/staggered-fade-and-slide',
+    name: 'StaggeredFadeAndSlide',
+    component: TestStaggeredFadeAndSlide
   }
 ];
 
diff --git a/packages/x-components/src/components/animations/staggered-fade-and-slide.vue b/packages/x-components/src/components/animations/staggered-fade-and-slide.vue
index bc2a484abd..228a29e3d4 100644
--- a/packages/x-components/src/components/animations/staggered-fade-and-slide.vue
+++ b/packages/x-components/src/components/animations/staggered-fade-and-slide.vue
@@ -1,15 +1,20 @@
 <template>
-  <StaggeringTransitionGroup class="x-staggered-fade-and-slide" :name="name" :appear="appear">
-    <!-- @slot (Required) Transition-group content -->
+  <!-- eslint-disable vue/attributes-order -->
+  <TransitionGroup
+    v-bind="$attrs"
+    @enter="enter"
+    @after-enter="afterEnter"
+    :appear="appear"
+    :name="name"
+    :tag="tag"
+  >
     <slot />
-  </StaggeringTransitionGroup>
+  </TransitionGroup>
 </template>
 
 <script lang="ts">
-  import { defineComponent } from 'vue';
-  import StaggeringTransitionGroup from './staggering-transition-group.vue';
+  import { defineComponent, ref } from 'vue';
   import { useDisableAnimation } from './use-disable-animation';
-
   /**
    * Renders a transition group wrapping the elements passed in the default slot and animating
    * them with a staggered fade and slide animation.
@@ -18,7 +23,7 @@
    */
   export default defineComponent({
     name: 'StaggeredFadeAndSlide',
-    components: { StaggeringTransitionGroup },
+    inheritAttrs: false,
     props: {
       /**
        * Indicates if the transition must be applied on the initial render of the node.
@@ -26,45 +31,108 @@
       appear: {
         type: Boolean,
         default: true
+      },
+      /**
+       * The tag of the node to render to the DOM.
+       */
+      tag: {
+        type: String,
+        default: 'div'
+      },
+      /**
+       * The time in ms to stagger each item.
+       */
+      stagger: {
+        type: Number,
+        default: 25
       }
     },
-    setup: function () {
+    setup(props) {
+      /**
+       * The duration of the transition in ms.
+       */
+      const transitionDuration = 250;
+      /**
+       * The counter to keep track of the staggered delay.
+       */
+      const staggerCounter = ref(0);
+      /**
+       * The counter to keep track of the animations.
+       */
+      const animationList = ref<HTMLElement[]>([]);
       /**
        * The name of the animation.
        */
-      const animationName = 'x-staggered-fade-and-slide-';
-
-      const { name } = useDisableAnimation(animationName);
-
-      return { name };
+      const animationName = ref('x-staggered-fade-and-slide');
+      /**
+       * The name of the animation.
+       */
+      const { name } = useDisableAnimation(animationName.value);
+      /**
+       * Calculate the delay for the next element.
+       *
+       * @returns The delay in ms.
+       */
+      function getNextTransitionDelay(): number {
+        return staggerCounter.value++ * props.stagger;
+      }
+      /**
+       * The enter transition.
+       *
+       * @param el
+       * @param done
+       */
+      function enter(el: HTMLElement, done: () => void) {
+        animationList.value.push(el);
+        const delay = getNextTransitionDelay();
+        el.style.transitionDelay = `${delay}ms`;
+        setTimeout(() => {
+          el.style.transitionDelay = '0ms';
+          done();
+        }, transitionDuration + delay);
+      }
+      /**
+       * The after enter transition.
+       *
+       * @param el
+       */
+      function afterEnter(el: HTMLElement) {
+        animationList.value = animationList.value.filter(item => item !== el);
+        if (animationList.value.length === 0) {
+          staggerCounter.value = 0;
+        }
+      }
+      return {
+        name,
+        enter,
+        afterEnter
+      };
     }
   });
 </script>
 
-<style lang="scss" scoped>
+<style lang="scss">
   $transition-duration: 0.25s;
-
-  .x-staggered-fade-and-slide {
-    z-index: 0;
-
-    &::v-deep .x-staggered-fade-and-slide {
-      &--enter-active,
-      &--leave-active {
-        transition: $transition-duration ease-out;
-        transition-property: opacity, transform;
-      }
-
-      &--move {
-        transition: transform $transition-duration ease-out;
-      }
-
-      &--enter,
-      &--leave-to {
-        transform: translate3d(0, 50%, 0);
-        opacity: 0;
-        z-index: -1;
-      }
-    }
+  /* 1. Declare transitions */
+  .x-staggered-fade-and-slide-enter-active,
+  .x-staggered-fade-and-slide-leave-active {
+    transition: $transition-duration ease-out;
+    transition-property: opacity, transform;
+  }
+  .x-staggered-fade-and-slide-move {
+    transition: transform $transition-duration ease-out;
+  }
+  /* 2. declare enter from and leave to state */
+  .x-staggered-fade-and-slide-enter,
+  .x-staggered-fade-and-slide-enter-from,
+  .x-staggered-fade-and-slide-leave-to {
+    opacity: 0;
+    transform: translate3d(0, 50%, 0);
+  }
+  /* 3. ensure leaving items are taken out of layout flow so that moving
+      animations can be calculated correctly. */
+  .x-staggered-fade-and-slide-leave-active {
+    position: absolute;
   }
 </style>
 
diff --git a/packages/x-components/src/components/base-grid.vue b/packages/x-components/src/components/base-grid.vue
index 86ed995de2..ad66d8e9f4 100644
--- a/packages/x-components/src/components/base-grid.vue
+++ b/packages/x-components/src/components/base-grid.vue
@@ -1,7 +1,6 @@
 <template>
   <component
     :is="animation"
-    ref="gridEl"
     :style="style"
     class="x-base-grid"
     :class="cssClasses"
@@ -114,6 +113,20 @@
       };
 
       const xBus = useXBus();
+
+      /**
+       * Number of columns rendered inside the grid.
+       */
+      const renderedColumnsNumber = ref(0);
+      /**
+       * Reference to the root element of the grid.
+       */
+      const rootEl = ref<Element | null>(null);
+      /**
+       * ResizeObserver instance to keep track of the number of columns rendered inside the grid.
+       */
+      let resizeObserver: { stop: () => void };
+
       /**
        * It injects {@link ListItem} provided by an ancestor.
        *
@@ -124,9 +137,6 @@
         undefined
       );
 
-      const gridEl = ref<ElementRef | HTMLElement | null>(null);
-
-      let renderedColumnsNumber = ref(0);
       /**
        * Emits the {@link XEventsTypes.RenderedColumnsNumberChanged}
        * event whenever the number of columns rendered inside the grid changes.
@@ -136,9 +146,7 @@
       watch(
         renderedColumnsNumber,
         () => xBus.emit('RenderedColumnsNumberChanged', renderedColumnsNumber.value),
-        {
-          immediate: false
-        }
+        { immediate: false }
       );
 
       /**
@@ -205,49 +213,40 @@
         })
       );
 
-      /**
-       * Checks if a given value is an `ElementRef` object.
-       *
-       * @param value - The value to check.
-       * @returns `true` if the value is an `ElementRef` object, `false` otherwise.
-       *
-       * @internal
-       */
-      const isElementRef = (value: any): value is ElementRef => {
-        return value && value.$el instanceof HTMLElement;
-      };
-
       /**
        * Updates the number of columns rendered inside the grid.
-       *
-       * @internal
        */
       const updateRenderedColumnsNumber = (): void => {
-        const { gridTemplateColumns } = getComputedStyle(
-          isElementRef(gridEl.value) ? gridEl.value.$el : (gridEl.value as Element)
-        );
-        renderedColumnsNumber.value = gridTemplateColumns.split(' ').length;
+        if (rootEl.value) {
+          const { gridTemplateColumns } = getComputedStyle(rootEl.value);
+          renderedColumnsNumber.value = gridTemplateColumns.split(' ').length;
+        }
       };
 
       /**
        * Initialises the rendered columns number and sets a ResizeObserver to keep it updated.
-       *
-       * @internal
        */
-      let resizeObserver: UseResizeObserverReturn;
       onMounted(() => {
+        /**
+         * Using querySelector to get the root element of the grid instead of using the ref directly
+         * because with the introductions of Fragments, Vue returns every DOM element inside the component.
+         */
+        rootEl.value = document.querySelector('.x-base-grid');
         resizeObserver = useResizeObserver(
-          gridEl as MaybeComputedElementRef,
+          rootEl as MaybeComputedElementRef,
           updateRenderedColumnsNumber
         );
       });
+
+      /**
+       * Stops the ResizeObserver when the component is unmounted.
+       */
       onBeforeUnmount(() => resizeObserver?.stop());
 
       return {
         gridItems,
         cssClasses,
         style,
-        gridEl,
         slots
       };
     }
diff --git a/packages/x-components/src/views/home/Home.vue b/packages/x-components/src/views/home/Home.vue
index 306700b313..1ff3881863 100644
--- a/packages/x-components/src/views/home/Home.vue
+++ b/packages/x-components/src/views/home/Home.vue
@@ -459,7 +459,7 @@
   /* eslint-disable max-len */
   import { computed, ComputedRef, defineComponent, provide } from 'vue';
   // import { animateClipPath } from '../../components/animations/animate-clip-path/animate-clip-path.factory';
-  // import StaggeredFadeAndSlide from '../../components/animations/staggered-fade-and-slide.vue';
+  import StaggeredFadeAndSlide from '../../components/animations/staggered-fade-and-slide.vue';
   import AutoProgressBar from '../../components/auto-progress-bar.vue';
   import BaseDropdown from '../../components/base-dropdown.vue';
   import BaseGrid from '../../components/base-grid.vue';
@@ -586,6 +586,7 @@
       SortPickerList,
       Spellcheck,
       SpellcheckButton,
+      StaggeredFadeAndSlide,
       Tagging,
       UrlHandler
     },
@@ -600,7 +601,7 @@
         'Find sunglasses'
       ];
       const columnPickerValues = [0, 2, 4];
-      // const resultsAnimation = StaggeredFadeAndSlide;
+      const resultsAnimation = StaggeredFadeAndSlide;
       // const modalAnimation = animateClipPath();
       const selectedColumns = 4;
       const sortValues = ['', 'price asc', 'price desc'];
@@ -662,7 +663,7 @@
         adapterConfig.e2e = !adapterConfig.e2e;
       };
       return {
-        resultsAnimation: undefined,
+        resultsAnimation,
         modalAnimation: undefined,
         queriesPreviewInfo,
         stores,