fix(animation): fix Expected Object, got Function on animations props (…

…#1489)
empathyco · May 30, 2024 · 4467edc · 4467edc
1 parent b72296c
commit 4467edc
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 22 deletions.
diff --git a/packages/x-components/src/components/base-dropdown.vue b/packages/x-components/src/components/base-dropdown.vue
@@ -78,15 +78,8 @@
 
 <script lang="ts">
   import { Identifiable } from '@empathyco/x-types';
-  import Vue, {
-    computed,
-    defineComponent,
-    nextTick,
-    onBeforeUnmount,
-    PropType,
-    ref,
-    watch
-  } from 'vue';
+  import { computed, defineComponent, nextTick, onBeforeUnmount, PropType, ref, watch } from 'vue';
+  import { AnimationProp } from '../types';
   import { getTargetElement } from '../utils/html';
   import { normalizeString } from '../utils/normalize';
   import { isInRange } from '../utils/number';
@@ -123,7 +116,7 @@
        * so only `<transition>` components are allowed.
        */
       animation: {
-        type: Object as PropType<string | typeof Vue>,
+        type: AnimationProp,
         default: () => NoElement
       },
       /** Time to wait without receiving any keystroke before resetting the items search query. */

diff --git a/packages/x-components/src/components/modals/base-modal.vue b/packages/x-components/src/components/modals/base-modal.vue
@@ -31,16 +31,10 @@
 </template>
 
 <script lang="ts">
-  import Vue, {
-    defineComponent,
-    nextTick,
-    onBeforeUnmount,
-    onMounted,
-    PropType,
-    ref,
-    watch
-  } from 'vue';
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  import Vue, { defineComponent, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue';
   import { useDebounce } from '../../composables/use-debounce';
+  import { AnimationProp } from '../../types';
   import { getTargetElement } from '../../utils/html';
   import Fade from '../animations/fade.vue';
   import { NoElement } from '../no-element';
@@ -77,15 +71,15 @@
       referenceSelector: String,
       /** Animation to use for opening/closing the modal.This animation only affects the content. */
       animation: {
-        type: Object as PropType<string | typeof Vue>,
+        type: AnimationProp,
         default: () => NoElement
       },
       /**
        * Animation to use for the overlay (backdrop) part of the modal. By default, it uses
        * a fade transition.
        */
       overlayAnimation: {
-        type: Object as PropType<string | typeof Vue>,
+        type: AnimationProp,
         default: () => Fade
       },
       /** Class inherited by content element. */

diff --git a/packages/x-components/src/components/scroll/base-scroll.vue b/packages/x-components/src/components/scroll/base-scroll.vue
@@ -67,7 +67,7 @@
        * @public
        */
       resetOn: {
-        type: Array as PropType<XEvent | XEvent[]>,
+        type: [String, Array] as PropType<XEvent | XEvent[]>,
         default: () => [
           'SearchBoxQueryChanged',
           'SortChanged',