@empathyco/x-components 6.0.0-alpha.16 → 6.0.0-alpha.18

package/docs/API-reference/components/search/x-components.results-list.md

@@ -17,7 +17,7 @@ result bound.
 
 | Name                   | Description                                                   | Type                       | Default           |
 | ---------------------- | ------------------------------------------------------------- | -------------------------- | ----------------- |
-| <code>animation</code> | Animation component that will be used to animate the results. | <code>animationProp</code> | <code>'ul'</code> |
+| <code>animation</code> | Animation component that will be used to animate the results. | <code>AnimationProp</code> | <code>'ul'</code> |
 
 ## Events
 

package/js/components/items-list.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"items-list.vue.js","sources":["../../../src/components/items-list.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    v-if=\"items.length\"\n    tag=\"ul\"\n    class=\"x-items-list\"\n    data-test=\"items-list\"\n  >\n    <li\n      v-for=\"item in computedItems\"\n      :key=\"item.id\"\n      class=\"x-items-list__item\"\n      :class=\"item.class\"\n      :data-test=\"item.dataTest\"\n    >\n      <!--\n        @slot Custom item to render.\n          @binding {ListItem} item - Item data.\n      -->\n      <slot :item=\"item\" :name=\"item.slotName\">{{ item.id }}</slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { computed, defineComponent, PropType } from 'vue';\n  import { ListItem } from '../utils/types';\n  import { toKebabCase } from '../utils/string';\n  import { animationProp } from '../utils/options-api';\n\n  /**\n   * It renders a list of {@link ListItem} providing a slot for each `slotName` which depends on\n   * the `modelName`of the item.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'ItemsList',\n    props: {\n      /** Animation component that will be used to animate the list. */\n      animation: {\n        type: animationProp,\n        default: 'ul'\n      },\n      /** List of items. */\n      items: {\n        type: Array as PropType<ListItem[]>,\n        required: true\n      },\n      /** Item's classes. */\n      itemClass: String\n    },\n    setup(props) {\n      /**\n       * The list of the items with additional properties.\n       *\n       * @returns A list of items with `dataTest`, `class` and the `slotName` for each item.\n       */\n      const computedItems = computed(() =>\n        props.items.map(item => {\n          const modelName = toKebabCase(item.modelName);\n          return {\n            ...item,\n            dataTest: `${modelName}s-list-item`,\n            class: [`x-${modelName}s-list-item`, props.itemClass],\n            slotName: modelName\n          };\n        })\n      );\n\n      return { computedItems };\n    }\n  });\n</script>\n"],"names":["animation","_openBlock","_createBlock","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","_normalizeClass","_createCommentVNode","_renderSlot","_toDisplayString"],"mappings":";;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EADF,MAESA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;SAFT,IAIY,CAAA,KAAA,CAAA,MAAA,IAAAC,SAAA,EAAA,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IACR,GAAK,EAAA,CAAA;AAAA,IACL,GAAA,EAAA,IAAA;AAAA,IAAA,KAAA,EAAA,cAAA;AANJ,IAAA,WAAA,EAAA,YAAA;AAAA,GAAA,EAAA;;iBAUY,IAAO,CAAA,EAAAC,kBAAA;AAAA,QAAAC,QAAA;AAAA,QAAA,IAAA;AAAA,QAAAC,UAAA,CAAA,IAAA,CAAA,aAAA,EAAA,CAAA,IAAA,KAAA;AACR,UAAA,OAAAL,SAAA,uBAAC,IACE,EAAA;AAAA,YACP,GAAA,EAAA,IAAA,CAAA,EAAA;AAAA,YAAA,KAAA,EAAAM,cAAA,CAAA,CAAA,oBAAA,EAAA,IAAA,CAAA,KAAA,CAAA,CAAA;AAED,YAAA,WAAA,EAAA,IAAA,CAAA,QAAA;AAAA,WAIA,EAAA;AAAA,YAAAC,kBAAA,CAnBN,iGAmByD,CAAA;AAAA,YAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,IAAA,CAAA,QAAA,EAAA,EAAA,IAAA,EAAA,EAAA,MAAA;;AAnBzD,gBAAAC,eAAA,CAAA,IAAA,CAAA,EAAA,CAAA;AAAA,gBAAA,CAAA;AAAA;AAAA,eAAA;AAAA,aAAA,CAAA;;AAAA,SAAA,CAAA;AAAA,QAAA,GAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;AAAA,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,CAAA,IAAAF,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}
+{"version":3,"file":"items-list.vue.js","sources":["../../../src/components/items-list.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    v-if=\"items.length\"\n    tag=\"ul\"\n    class=\"x-items-list\"\n    data-test=\"items-list\"\n  >\n    <li\n      v-for=\"item in computedItems\"\n      :key=\"item.id\"\n      class=\"x-items-list__item\"\n      :class=\"item.class\"\n      :data-test=\"item.dataTest\"\n    >\n      <!--\n        @slot Custom item to render.\n          @binding {ListItem} item - Item data.\n      -->\n      <slot :item=\"item\" :name=\"item.slotName\">{{ item.id }}</slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { computed, defineComponent, PropType } from 'vue';\n  import { ListItem } from '../utils/types';\n  import { toKebabCase } from '../utils/string';\n  import { AnimationProp } from '../types';\n\n  /**\n   * It renders a list of {@link ListItem} providing a slot for each `slotName` which depends on\n   * the `modelName`of the item.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'ItemsList',\n    props: {\n      /** Animation component that will be used to animate the list. */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      },\n      /** List of items. */\n      items: {\n        type: Array as PropType<ListItem[]>,\n        required: true\n      },\n      /** Item's classes. */\n      itemClass: String\n    },\n    setup(props) {\n      /**\n       * The list of the items with additional properties.\n       *\n       * @returns A list of items with `dataTest`, `class` and the `slotName` for each item.\n       */\n      const computedItems = computed(() =>\n        props.items.map(item => {\n          const modelName = toKebabCase(item.modelName);\n          return {\n            ...item,\n            dataTest: `${modelName}s-list-item`,\n            class: [`x-${modelName}s-list-item`, props.itemClass],\n            slotName: modelName\n          };\n        })\n      );\n\n      return { computedItems };\n    }\n  });\n</script>\n"],"names":["animation","_openBlock","_createBlock","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","_normalizeClass","_createCommentVNode","_renderSlot","_toDisplayString"],"mappings":";;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EADF,MAESA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;SAFT,IAIY,CAAA,KAAA,CAAA,MAAA,IAAAC,SAAA,EAAA,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IACR,GAAK,EAAA,CAAA;AAAA,IACL,GAAA,EAAA,IAAA;AAAA,IAAA,KAAA,EAAA,cAAA;AANJ,IAAA,WAAA,EAAA,YAAA;AAAA,GAAA,EAAA;;iBAUY,IAAO,CAAA,EAAAC,kBAAA;AAAA,QAAAC,QAAA;AAAA,QAAA,IAAA;AAAA,QAAAC,UAAA,CAAA,IAAA,CAAA,aAAA,EAAA,CAAA,IAAA,KAAA;AACR,UAAA,OAAAL,SAAA,uBAAC,IACE,EAAA;AAAA,YACP,GAAA,EAAA,IAAA,CAAA,EAAA;AAAA,YAAA,KAAA,EAAAM,cAAA,CAAA,CAAA,oBAAA,EAAA,IAAA,CAAA,KAAA,CAAA,CAAA;AAED,YAAA,WAAA,EAAA,IAAA,CAAA,QAAA;AAAA,WAIA,EAAA;AAAA,YAAAC,kBAAA,CAnBN,iGAmByD,CAAA;AAAA,YAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,IAAA,CAAA,QAAA,EAAA,EAAA,IAAA,EAAA,EAAA,MAAA;;AAnBzD,gBAAAC,eAAA,CAAA,IAAA,CAAA,EAAA,CAAA;AAAA,gBAAA,CAAA;AAAA;AAAA,eAAA;AAAA,aAAA,CAAA;;AAAA,SAAA,CAAA;AAAA,QAAA,GAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;AAAA,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,CAAA,IAAAF,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}

package/js/components/items-list.vue2.js

@@ -1,6 +1,6 @@
 import { defineComponent, computed } from 'vue';
 import { toKebabCase } from '../utils/string.js';
-import { animationProp } from '../utils/options-api.js';
+import { AnimationProp } from '../types/animation-prop.js';
 
 /**
  * It renders a list of {@link ListItem} providing a slot for each `slotName` which depends on
@@ -13,7 +13,7 @@ var _sfc_main = defineComponent({
     props: {
         /** Animation component that will be used to animate the list. */
         animation: {
-            type: animationProp,
+            type: AnimationProp,
             default: 'ul'
         },
         /** List of items. */

package/js/components/items-list.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"items-list.vue2.js","sources":["../../../src/components/items-list.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    v-if=\"items.length\"\n    tag=\"ul\"\n    class=\"x-items-list\"\n    data-test=\"items-list\"\n  >\n    <li\n      v-for=\"item in computedItems\"\n      :key=\"item.id\"\n      class=\"x-items-list__item\"\n      :class=\"item.class\"\n      :data-test=\"item.dataTest\"\n    >\n      <!--\n        @slot Custom item to render.\n          @binding {ListItem} item - Item data.\n      -->\n      <slot :item=\"item\" :name=\"item.slotName\">{{ item.id }}</slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { computed, defineComponent, PropType } from 'vue';\n  import { ListItem } from '../utils/types';\n  import { toKebabCase } from '../utils/string';\n  import { animationProp } from '../utils/options-api';\n\n  /**\n   * It renders a list of {@link ListItem} providing a slot for each `slotName` which depends on\n   * the `modelName`of the item.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'ItemsList',\n    props: {\n      /** Animation component that will be used to animate the list. */\n      animation: {\n        type: animationProp,\n        default: 'ul'\n      },\n      /** List of items. */\n      items: {\n        type: Array as PropType<ListItem[]>,\n        required: true\n      },\n      /** Item's classes. */\n      itemClass: String\n    },\n    setup(props) {\n      /**\n       * The list of the items with additional properties.\n       *\n       * @returns A list of items with `dataTest`, `class` and the `slotName` for each item.\n       */\n      const computedItems = computed(() =>\n        props.items.map(item => {\n          const modelName = toKebabCase(item.modelName);\n          return {\n            ...item,\n            dataTest: `${modelName}s-list-item`,\n            class: [`x-${modelName}s-list-item`, props.itemClass],\n            slotName: modelName\n          };\n        })\n      );\n\n      return { computedItems };\n    }\n  });\n</script>\n"],"names":[],"mappings":";;;;AA8BE;;;;;AAKE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,KAAK,EAAE;;AAEL,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,IAAG;AACb,SAAA;;AAED,QAAA,KAAK,EAAE;AACL,YAAA,IAAI,EAAE,KAA6B;AACnC,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;;AAED,QAAA,SAAS,EAAE,MAAK;AACjB,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT;;;;AAIE;AACF,QAAA,MAAM,aAAc,GAAE,QAAQ,CAAC,MAC7B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAG,IAAK;YACtB,MAAM,SAAU,GAAE,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC7C,OAAO;AACL,gBAAA,GAAG,IAAI;gBACP,QAAQ,EAAE,CAAG,EAAA,SAAS,CAAa,WAAA,CAAA;gBACnC,KAAK,EAAE,CAAC,CAAK,EAAA,EAAA,SAAS,aAAa,EAAE,KAAK,CAAC,SAAS,CAAC;AACrD,gBAAA,QAAQ,EAAE,SAAQ;aACnB,CAAA;SACF,CAAA,CACF,CAAA;QAED,OAAO,EAAE,eAAe,CAAA;KAC1B;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"items-list.vue2.js","sources":["../../../src/components/items-list.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    v-if=\"items.length\"\n    tag=\"ul\"\n    class=\"x-items-list\"\n    data-test=\"items-list\"\n  >\n    <li\n      v-for=\"item in computedItems\"\n      :key=\"item.id\"\n      class=\"x-items-list__item\"\n      :class=\"item.class\"\n      :data-test=\"item.dataTest\"\n    >\n      <!--\n        @slot Custom item to render.\n          @binding {ListItem} item - Item data.\n      -->\n      <slot :item=\"item\" :name=\"item.slotName\">{{ item.id }}</slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { computed, defineComponent, PropType } from 'vue';\n  import { ListItem } from '../utils/types';\n  import { toKebabCase } from '../utils/string';\n  import { AnimationProp } from '../types';\n\n  /**\n   * It renders a list of {@link ListItem} providing a slot for each `slotName` which depends on\n   * the `modelName`of the item.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'ItemsList',\n    props: {\n      /** Animation component that will be used to animate the list. */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      },\n      /** List of items. */\n      items: {\n        type: Array as PropType<ListItem[]>,\n        required: true\n      },\n      /** Item's classes. */\n      itemClass: String\n    },\n    setup(props) {\n      /**\n       * The list of the items with additional properties.\n       *\n       * @returns A list of items with `dataTest`, `class` and the `slotName` for each item.\n       */\n      const computedItems = computed(() =>\n        props.items.map(item => {\n          const modelName = toKebabCase(item.modelName);\n          return {\n            ...item,\n            dataTest: `${modelName}s-list-item`,\n            class: [`x-${modelName}s-list-item`, props.itemClass],\n            slotName: modelName\n          };\n        })\n      );\n\n      return { computedItems };\n    }\n  });\n</script>\n"],"names":[],"mappings":";;;;AA8BE;;;;;AAKE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,WAAW;AACjB,IAAA,KAAK,EAAE;;AAEL,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,IAAG;AACb,SAAA;;AAED,QAAA,KAAK,EAAE;AACL,YAAA,IAAI,EAAE,KAA6B;AACnC,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;;AAED,QAAA,SAAS,EAAE,MAAK;AACjB,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT;;;;AAIE;AACF,QAAA,MAAM,aAAc,GAAE,QAAQ,CAAC,MAC7B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAG,IAAK;YACtB,MAAM,SAAU,GAAE,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC7C,OAAO;AACL,gBAAA,GAAG,IAAI;gBACP,QAAQ,EAAE,CAAG,EAAA,SAAS,CAAa,WAAA,CAAA;gBACnC,KAAK,EAAE,CAAC,CAAK,EAAA,EAAA,SAAS,aAAa,EAAE,KAAK,CAAC,SAAS,CAAC;AACrD,gBAAA,QAAQ,EAAE,SAAQ;aACnB,CAAA;SACF,CAAA,CACF,CAAA;QAED,OAAO,EAAE,eAAe,CAAA;KAC1B;AACD,CAAA,CAAC;;;;"}

package/js/components/result/base-result-image.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-result-image.vue.js","sources":["../../../../src/components/result/base-result-image.vue"],"sourcesContent":["<template>\n  <!-- This is a div because using a picture causes the onload event of the image to fire twice. -->\n  <!-- eslint-disable-next-line vuejs-accessibility/mouse-events-have-key-events -->\n  <div\n    @mouseenter.once=\"userHasHoveredImage = true\"\n    @mouseenter=\"isHovering = true\"\n    @mouseleave=\"isHovering = false\"\n    class=\"x-result-picture x-picture\"\n    data-test=\"result-picture\"\n  >\n    <img\n      v-if=\"shouldLoadNextImage\"\n      @load=\"flagImageLoaded\"\n      @error=\"flagImageAsFailed\"\n      loading=\"lazy\"\n      :src=\"pendingImages[0]\"\n      :style=\"loaderStyles\"\n      class=\"x-picture-image\"\n      data-test=\"result-picture-loader\"\n      alt=\"\"\n      role=\"presentation\"\n    />\n    <component :is=\"animation\" class=\"x-picture-image\" :appear=\"false\">\n      <!-- @slot Fallback image content. It will be rendered when all the images failed -->\n      <slot v-if=\"!loadedImages.length && !pendingImages.length\" name=\"fallback\" />\n\n      <!-- @slot Loading image content. It will be rendered while the real image is not loaded -->\n      <slot v-else-if=\"!loadedImages.length\" name=\"placeholder\" />\n\n      <img\n        v-else\n        :key=\"imageSrc\"\n        :alt=\"result.name\"\n        :src=\"imageSrc\"\n        class=\"x-result-picture-image\"\n        data-test=\"result-picture-image\"\n      />\n    </component>\n  </div>\n</template>\n\n<script lang=\"ts\">\n  import { Result } from '@empathyco/x-types';\n  import { computed, DefineComponent, defineComponent, PropType, Ref, ref, watch } from 'vue';\n  import { animationProp } from '../../utils/options-api';\n  import { NoAnimation } from '../animations';\n\n  /**\n   * Component to be reused that renders an `<img>`.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseResultImage',\n    props: {\n      /** (Required) The {@link @empathyco/x-types#Result} information. */\n      result: {\n        type: Object as PropType<Result>,\n        required: true\n      },\n      /**\n       * Animation to use when switching between the placeholder, the loaded image, or the failed\n       * image fallback.\n       */\n      loadAnimation: {\n        type: animationProp,\n        default: () => NoAnimation\n      },\n      /** Animation to use when switching between the loaded image and the hover image. */\n      hoverAnimation: {\n        type: animationProp\n      },\n      /**\n       * Indicates if the next valid image should be displayed on hover.\n       *\n       * @public\n       */\n      showNextImageOnHover: {\n        type: Boolean,\n        default: false\n      }\n    },\n    setup(props) {\n      /**\n       * Copy of the images of the result.\n       *\n       * It is used as a queue of images to load, once an image loads/fails to load, it is removed\n       * from this array.\n       *\n       * @internal\n       */\n      const pendingImages: Ref<string[]> = ref([]);\n\n      /**\n       * Contains the images that have been loaded successfully.\n       *\n       * @internal\n       */\n      const loadedImages: Ref<string[]> = ref([]);\n\n      /**\n       * Indicates if the user is hovering the image.\n       *\n       * @internal\n       */\n      const isHovering = ref(false);\n\n      /**\n       * Indicates if the user has hovered the image.\n       *\n       * @internal\n       */\n      const userHasHoveredImage = ref(false);\n\n      /**.\n       * Styles to use inline in the image loader, to prevent override from CSS\n       *\n       * @internal\n       */\n      const loaderStyles: Partial<CSSStyleDeclaration> = {\n        position: 'absolute !important',\n        top: '0 !important',\n        left: '0 !important',\n        width: '100% !important',\n        height: '100% !important',\n        pointerEvents: 'none !important',\n        visibility: 'hidden !important'\n      };\n\n      /**\n       * Initializes images state and resets when the result's images change.\n       *\n       * @internal\n       */\n      watch(\n        () => props.result.images,\n        () => {\n          pendingImages.value = [...(props.result.images ?? [])];\n          loadedImages.value = pendingImages.value.filter(image =>\n            loadedImages.value.includes(image)\n          );\n        },\n        { immediate: true }\n      );\n\n      /**\n       * Animation to be used.\n       *\n       * @returns The animation to be used, taking into account if the user has hovered the image.\n       *\n       * @internal\n       */\n      const animation = computed<DefineComponent | string>(() => {\n        return userHasHoveredImage\n          ? props.hoverAnimation ?? props.loadAnimation\n          : props.loadAnimation;\n      });\n\n      /**\n       * Gets the src from the result image.\n       *\n       * @returns The result image src.\n       *\n       * @internal\n       */\n      const imageSrc = computed<string>(() => {\n        return loadedImages.value[\n          !props.showNextImageOnHover || !isHovering.value ? 0 : loadedImages.value.length - 1\n        ];\n      });\n\n      /**\n       * Indicates if the loader should try to load the next image.\n       *\n       * @returns True if it should try to load the next image.\n       *\n       * @internal\n       */\n      const shouldLoadNextImage = computed<boolean>(() => {\n        const numImagesToLoad = props.showNextImageOnHover && userHasHoveredImage ? 2 : 1;\n        return !!pendingImages.value.length && loadedImages.value.length < numImagesToLoad;\n      });\n\n      /**\n       * Sets an image as failed.\n       *\n       * @internal\n       */\n      const flagImageAsFailed = (): void => {\n        pendingImages.value.shift();\n      };\n\n      /**\n       * Sets an image as loaded.\n       *\n       * @internal\n       */\n      const flagImageLoaded = (): void => {\n        const image = pendingImages.value.shift();\n        if (image) {\n          loadedImages.value.push(image);\n        }\n      };\n\n      return {\n        pendingImages,\n        loadedImages,\n        isHovering,\n        userHasHoveredImage,\n        loaderStyles,\n        animation,\n        imageSrc,\n        shouldLoadNextImage,\n        flagImageAsFailed,\n        flagImageLoaded\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-result-picture {\n    position: relative;\n    min-width: 1px;\n    min-height: 1px;\n  }\n\n  .x-result-picture-image {\n    max-width: 100%;\n    max-height: 100%;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Examples\n\n### Basic example\n\nThis component is for the result image. It may be part of the search result page, recommendations or\nother section which needs to include results.\n\nThe result prop is required. It will render a `<img/>` with the result image:\n\n```vue\n<BaseResultImage :result=\"result\" />\n```\n\n### Showing the next image on hover\n\nIf a result has multiple images, it can show the next one on hover.\n\n```vue\n<BaseResultImage :result=\"result\" showNextImageOnHover />\n```\n\n### Customizing slots content\n\nFallback and placeholder contents can be customized.\n\nThe fallback slot allows you to replace the content of the fallback image.\n\nThe other slot is called `placeholder`, and allows you to set the image that its going to be\ndisplayed while the real one is loaded.\n\n```vue\n<BaseResultImage :result=\"result\">\n  <template #placeholder>\n    <img alt=\"Placeholder image\" src=\"./placeholder-image.svg\"/>\n  </template>\n  <template #fallback>\n    <img alt=\"Fallback image\" src=\"./fallback-image.svg\"/>\n  </template>\n</BaseResultImage>\n```\n\n### Customizing the animations\n\nTwo animations can be used this component.\n\nThe `loadAnimation` is used to transition between the placeholder, the fallback and the image.\n\nThe `hoverAnimation` is used to transition between the image and the hover image, if the\n`showNextImageOnHover` prop is `true`.\n\n`hoverAnimation` will default to `loadAnimation` if it is not provided.\n\n```vue\n<template>\n  <BaseResultImage\n    :result=\"result\"\n    :loadAnimation=\"loadAnimation\"\n    :hoverAnimation=\"hoverAnimation\"\n    showNextImageOnHover\n  />\n</template>\n\n<script>\n  import { BaseResultImage } from '@empathyco/x-components';\n  import { CrossFade, CollapseHeight } from '@empathyco/x-components/animations';\n\n  export default {\n    name: 'BaseResultImageAnimations',\n    components: {\n      BaseResultImage\n    },\n    data() {\n      return {\n        loadAnimation: CrossFade,\n        hoverAnimation: CollapseHeight,\n        result: {\n          name: 'jacket',\n          images: ['https://some-image', 'https://some-image-2']\n        }\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_Fragment","_createCommentVNode","_createElementVNode","isHovering","shouldLoadNextImage","pendingImages","animation","_createBlock","_resolveDynamicComponent","loadedImages","_renderSlot","imageSrc"],"mappings":";;;;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;AACA,EAAA,OAAAA,SAAA,EAAA,EAAAC,kBAAA;AAAA,IAAAC,QAAA;AAAA,IAAA,IAAA;AAAA,IAAA;AAAA,MACAC,kBAmCM,CAAA,6FAAA,CAAA;AAAA,MAAAA,kBAAA,CAtCR,6EAIyC,CAAA;AAAA,MAAAC,kBAAA;AAC1B,QAAA,KAAA;AAAA,QAAA;AAAA,UACV,gBAAA,EAAU,sCAAEC,IAAU,CAAA,mBAAA,GAAA,IAAA,CAAA;AAAA,UACvB,cAAM,MAA4B,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,MAAA,KAAA,IAAA,CAAA,UAAA,GAAA,IAAA,CAAA;AAAA,UAClC,cAAU,MAAgB,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,MAAA,KAAA,IAAA,CAAA,UAAA,GAAA,KAAA,CAAA;AAAA,UAAA,KAAA,EAAA,4BAAA;AAGlBC,UAAAA,WAAAA,EAAAA,gBAAAA;AAAAA,SAAAA;;eAXZ,mBAYW,IAAAN,SAAA,EAAA,EAAAC,kBAAA,CAAA,KAAA,EAAA;AAAA,YACJ,GAAA,EAAA,CAAA;AAAA,YACD,QAAO,MAAO,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,eAAA,IAAA,IAAA,CAAA,eAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,YACb,SAAKM,MAAa,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,iBAAA,IAAA,IAAA,CAAA,iBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,YAClB,OAhBP,EAAA,MAAA;AAAA,YAiBM,GAAA,EAAK,KAAC,aAAiB,CAAA,CAAA,CAAA;AAAA,YACvB,sBAAU,IAAuB,CAAA,YAAA,CAAA;AAAA,YACjC,KAAM,EAAA,iBAAA;AAAA,YACN,WAAK,EAAA,uBAAA;AAAA,YAAA,GAAA,EAAA,EAAA;AApBX,YAAA,IAAA,EAAA,cAAA;AAAA,WAsBoBC,EAAAA,IAAAA,EAAAA,EAAAA,EAAAA,UAAAA,CAAAA,IAAWL,mBAAM,MAAiB,EAAA,IAAA,CAAA;AAAA,WAAAH,SAAA,EAAe,EAAAS,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,YAAA,KAAA,EAAA,iBAAA;AAtBrE,YAAA,MAAA,EAAA,KAAA;AAAA,WAAA,EAAA;qBAwBmBC,OAAa,CAAA,MAAA;AAAA,cAAAR,kBAAA,CAAmD,gFAxBnF,CAAA;AAAA,cAAA,CAAA,IAAA,CA2BwBQ,uBAAmB,CAArC,IAAA,CAAA,aAAA,CAAA,MAAA,GAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,UAAA,EAA4D,EA3BlE,GAAA,EAAA,CAAA,EAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA,GAAA,CAAA,IAAA,CA0BM,kCAC4D,EAAAX,kBAAA;AAAA,gBAAAC,QAAA;AAAA,gBAAA,EAAA,GAAA,EAAA,CAAA,EAAA;AAAA,gBAAA;AAAA,kBAAAC,kBAAA,CAAA,uFAAA,CAAA;kCAE5D,MAOE,EAAA,aAAA,EAAA,EAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA;AAAA,iBAAA;AALC,gBAAA,IAAA;AAAA;AAAA,+BACgB,EAAAF,kBAAA,CAAA,KAAA,EAAA;AAAA,gBAChB,GAAKY,EAAAA,IAAAA,CAAAA,QAAAA;AAAAA,gBACN,KAAK,IAAC,CAAA,MAAA,CAAA,IAAA;AAAA,gBACN,GAAA,EAAA,IAAA,CAAA,QAAA;AAAA,gBAAA,KAAA,EAAA,wBAAA;;AAnCR,eAAA,EAAA,IAAA,EAAA,CAAA,EAAA,UAAA,CAAA,CAAA;AAAA,aAAA,CAAA;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"base-result-image.vue.js","sources":["../../../../src/components/result/base-result-image.vue"],"sourcesContent":["<template>\n  <!-- This is a div because using a picture causes the onload event of the image to fire twice. -->\n  <!-- eslint-disable-next-line vuejs-accessibility/mouse-events-have-key-events -->\n  <div\n    @mouseenter.once=\"userHasHoveredImage = true\"\n    @mouseenter=\"isHovering = true\"\n    @mouseleave=\"isHovering = false\"\n    class=\"x-result-picture x-picture\"\n    data-test=\"result-picture\"\n  >\n    <img\n      v-if=\"shouldLoadNextImage\"\n      @load=\"flagImageLoaded\"\n      @error=\"flagImageAsFailed\"\n      loading=\"lazy\"\n      :src=\"pendingImages[0]\"\n      :style=\"loaderStyles\"\n      class=\"x-picture-image\"\n      data-test=\"result-picture-loader\"\n      alt=\"\"\n      role=\"presentation\"\n    />\n    <component :is=\"animation\" class=\"x-picture-image\" :appear=\"false\">\n      <!-- @slot Fallback image content. It will be rendered when all the images failed -->\n      <slot v-if=\"!loadedImages.length && !pendingImages.length\" name=\"fallback\" />\n\n      <!-- @slot Loading image content. It will be rendered while the real image is not loaded -->\n      <slot v-else-if=\"!loadedImages.length\" name=\"placeholder\" />\n\n      <img\n        v-else\n        :key=\"imageSrc\"\n        :alt=\"result.name\"\n        :src=\"imageSrc\"\n        class=\"x-result-picture-image\"\n        data-test=\"result-picture-image\"\n      />\n    </component>\n  </div>\n</template>\n\n<script lang=\"ts\">\n  import { Result } from '@empathyco/x-types';\n  import { computed, defineComponent, PropType, Ref, ref, watch } from 'vue';\n  import { NoAnimation } from '../animations';\n  import { AnimationProp } from '../../types';\n\n  /**\n   * Component to be reused that renders an `<img>`.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseResultImage',\n    props: {\n      /** (Required) The {@link @empathyco/x-types#Result} information. */\n      result: {\n        type: Object as PropType<Result>,\n        required: true\n      },\n      /**\n       * Animation to use when switching between the placeholder, the loaded image, or the failed\n       * image fallback.\n       */\n      loadAnimation: {\n        type: AnimationProp,\n        default: () => NoAnimation\n      },\n      /** Animation to use when switching between the loaded image and the hover image. */\n      hoverAnimation: {\n        type: AnimationProp\n      },\n      /**\n       * Indicates if the next valid image should be displayed on hover.\n       *\n       * @public\n       */\n      showNextImageOnHover: {\n        type: Boolean,\n        default: false\n      }\n    },\n    setup(props) {\n      /**\n       * Copy of the images of the result.\n       *\n       * It is used as a queue of images to load, once an image loads/fails to load, it is removed\n       * from this array.\n       *\n       * @internal\n       */\n      const pendingImages: Ref<string[]> = ref([]);\n\n      /**\n       * Contains the images that have been loaded successfully.\n       *\n       * @internal\n       */\n      const loadedImages: Ref<string[]> = ref([]);\n\n      /**\n       * Indicates if the user is hovering the image.\n       *\n       * @internal\n       */\n      const isHovering = ref(false);\n\n      /**\n       * Indicates if the user has hovered the image.\n       *\n       * @internal\n       */\n      const userHasHoveredImage = ref(false);\n\n      /**.\n       * Styles to use inline in the image loader, to prevent override from CSS\n       *\n       * @internal\n       */\n      const loaderStyles: Partial<CSSStyleDeclaration> = {\n        position: 'absolute !important',\n        top: '0 !important',\n        left: '0 !important',\n        width: '100% !important',\n        height: '100% !important',\n        pointerEvents: 'none !important',\n        visibility: 'hidden !important'\n      };\n\n      /**\n       * Initializes images state and resets when the result's images change.\n       *\n       * @internal\n       */\n      watch(\n        () => props.result.images,\n        () => {\n          pendingImages.value = [...(props.result.images ?? [])];\n          loadedImages.value = pendingImages.value.filter(image =>\n            loadedImages.value.includes(image)\n          );\n        },\n        { immediate: true }\n      );\n\n      /**\n       * Animation to be used.\n       *\n       * @returns The animation to be used, taking into account if the user has hovered the image.\n       *\n       * @internal\n       */\n      const animation = computed(() => {\n        return userHasHoveredImage\n          ? props.hoverAnimation ?? props.loadAnimation\n          : props.loadAnimation;\n      });\n\n      /**\n       * Gets the src from the result image.\n       *\n       * @returns The result image src.\n       *\n       * @internal\n       */\n      const imageSrc = computed(() => {\n        return loadedImages.value[\n          !props.showNextImageOnHover || !isHovering.value ? 0 : loadedImages.value.length - 1\n        ];\n      });\n\n      /**\n       * Indicates if the loader should try to load the next image.\n       *\n       * @returns True if it should try to load the next image.\n       *\n       * @internal\n       */\n      const shouldLoadNextImage = computed(() => {\n        const numImagesToLoad = props.showNextImageOnHover && userHasHoveredImage ? 2 : 1;\n        return !!pendingImages.value.length && loadedImages.value.length < numImagesToLoad;\n      });\n\n      /**\n       * Sets an image as failed.\n       *\n       * @internal\n       */\n      const flagImageAsFailed = () => {\n        pendingImages.value.shift();\n      };\n\n      /**\n       * Sets an image as loaded.\n       *\n       * @internal\n       */\n      const flagImageLoaded = () => {\n        const image = pendingImages.value.shift();\n        if (image) {\n          loadedImages.value.push(image);\n        }\n      };\n\n      return {\n        pendingImages,\n        loadedImages,\n        isHovering,\n        userHasHoveredImage,\n        loaderStyles,\n        animation,\n        imageSrc,\n        shouldLoadNextImage,\n        flagImageAsFailed,\n        flagImageLoaded\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-result-picture {\n    position: relative;\n    min-width: 1px;\n    min-height: 1px;\n  }\n\n  .x-result-picture-image {\n    max-width: 100%;\n    max-height: 100%;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Examples\n\n### Basic example\n\nThis component is for the result image. It may be part of the search result page, recommendations or\nother section which needs to include results.\n\nThe result prop is required. It will render a `<img/>` with the result image:\n\n```vue\n<BaseResultImage :result=\"result\" />\n```\n\n### Showing the next image on hover\n\nIf a result has multiple images, it can show the next one on hover.\n\n```vue\n<BaseResultImage :result=\"result\" showNextImageOnHover />\n```\n\n### Customizing slots content\n\nFallback and placeholder contents can be customized.\n\nThe fallback slot allows you to replace the content of the fallback image.\n\nThe other slot is called `placeholder`, and allows you to set the image that its going to be\ndisplayed while the real one is loaded.\n\n```vue\n<BaseResultImage :result=\"result\">\n  <template #placeholder>\n    <img alt=\"Placeholder image\" src=\"./placeholder-image.svg\"/>\n  </template>\n  <template #fallback>\n    <img alt=\"Fallback image\" src=\"./fallback-image.svg\"/>\n  </template>\n</BaseResultImage>\n```\n\n### Customizing the animations\n\nTwo animations can be used this component.\n\nThe `loadAnimation` is used to transition between the placeholder, the fallback and the image.\n\nThe `hoverAnimation` is used to transition between the image and the hover image, if the\n`showNextImageOnHover` prop is `true`.\n\n`hoverAnimation` will default to `loadAnimation` if it is not provided.\n\n```vue\n<template>\n  <BaseResultImage\n    :result=\"result\"\n    :loadAnimation=\"loadAnimation\"\n    :hoverAnimation=\"hoverAnimation\"\n    showNextImageOnHover\n  />\n</template>\n\n<script>\n  import { BaseResultImage } from '@empathyco/x-components';\n  import { CrossFade, CollapseHeight } from '@empathyco/x-components/animations';\n\n  export default {\n    name: 'BaseResultImageAnimations',\n    components: {\n      BaseResultImage\n    },\n    data() {\n      return {\n        loadAnimation: CrossFade,\n        hoverAnimation: CollapseHeight,\n        result: {\n          name: 'jacket',\n          images: ['https://some-image', 'https://some-image-2']\n        }\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_Fragment","_createCommentVNode","_createElementVNode","isHovering","shouldLoadNextImage","pendingImages","animation","_createBlock","_resolveDynamicComponent","loadedImages","_renderSlot","imageSrc"],"mappings":";;;;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;AACA,EAAA,OAAAA,SAAA,EAAA,EAAAC,kBAAA;AAAA,IAAAC,QAAA;AAAA,IAAA,IAAA;AAAA,IAAA;AAAA,MACAC,kBAmCM,CAAA,6FAAA,CAAA;AAAA,MAAAA,kBAAA,CAtCR,6EAIyC,CAAA;AAAA,MAAAC,kBAAA;AAC1B,QAAA,KAAA;AAAA,QAAA;AAAA,UACV,gBAAA,EAAU,sCAAEC,IAAU,CAAA,mBAAA,GAAA,IAAA,CAAA;AAAA,UACvB,cAAM,MAA4B,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,MAAA,KAAA,IAAA,CAAA,UAAA,GAAA,IAAA,CAAA;AAAA,UAClC,cAAU,MAAgB,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,MAAA,KAAA,IAAA,CAAA,UAAA,GAAA,KAAA,CAAA;AAAA,UAAA,KAAA,EAAA,4BAAA;AAGlBC,UAAAA,WAAAA,EAAAA,gBAAAA;AAAAA,SAAAA;;eAXZ,mBAYW,IAAAN,SAAA,EAAA,EAAAC,kBAAA,CAAA,KAAA,EAAA;AAAA,YACJ,GAAA,EAAA,CAAA;AAAA,YACD,QAAO,MAAO,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,eAAA,IAAA,IAAA,CAAA,eAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,YACb,SAAKM,MAAa,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,iBAAA,IAAA,IAAA,CAAA,iBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,YAClB,OAhBP,EAAA,MAAA;AAAA,YAiBM,GAAA,EAAK,KAAC,aAAiB,CAAA,CAAA,CAAA;AAAA,YACvB,sBAAU,IAAuB,CAAA,YAAA,CAAA;AAAA,YACjC,KAAM,EAAA,iBAAA;AAAA,YACN,WAAK,EAAA,uBAAA;AAAA,YAAA,GAAA,EAAA,EAAA;AApBX,YAAA,IAAA,EAAA,cAAA;AAAA,WAsBoBC,EAAAA,IAAAA,EAAAA,EAAAA,EAAAA,UAAAA,CAAAA,IAAWL,mBAAM,MAAiB,EAAA,IAAA,CAAA;AAAA,WAAAH,SAAA,EAAe,EAAAS,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,YAAA,KAAA,EAAA,iBAAA;AAtBrE,YAAA,MAAA,EAAA,KAAA;AAAA,WAAA,EAAA;qBAwBmBC,OAAa,CAAA,MAAA;AAAA,cAAAR,kBAAA,CAAmD,gFAxBnF,CAAA;AAAA,cAAA,CAAA,IAAA,CA2BwBQ,uBAAmB,CAArC,IAAA,CAAA,aAAA,CAAA,MAAA,GAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,UAAA,EAA4D,EA3BlE,GAAA,EAAA,CAAA,EAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA,GAAA,CAAA,IAAA,CA0BM,kCAC4D,EAAAX,kBAAA;AAAA,gBAAAC,QAAA;AAAA,gBAAA,EAAA,GAAA,EAAA,CAAA,EAAA;AAAA,gBAAA;AAAA,kBAAAC,kBAAA,CAAA,uFAAA,CAAA;kCAE5D,MAOE,EAAA,aAAA,EAAA,EAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA;AAAA,iBAAA;AALC,gBAAA,IAAA;AAAA;AAAA,+BACgB,EAAAF,kBAAA,CAAA,KAAA,EAAA;AAAA,gBAChB,GAAKY,EAAAA,IAAAA,CAAAA,QAAAA;AAAAA,gBACN,KAAK,IAAC,CAAA,MAAA,CAAA,IAAA;AAAA,gBACN,GAAA,EAAA,IAAA,CAAA,QAAA;AAAA,gBAAA,KAAA,EAAA,wBAAA;;AAnCR,eAAA,EAAA,IAAA,EAAA,CAAA,EAAA,UAAA,CAAA,CAAA;AAAA,aAAA,CAAA;;;;;;;;;;;;;;;;;"}

package/js/components/result/base-result-image.vue2.js

@@ -1,5 +1,4 @@
 import { defineComponent, ref, watch, computed } from 'vue';
-import { animationProp } from '../../utils/options-api.js';
 import '../animations/animate-width.vue2.js';
 import '../animations/animate-width.vue3.js';
 import '../animations/collapse-height.vue2.js';
@@ -18,6 +17,7 @@ import '../animations/staggered-fade-and-slide.vue3.js';
 import '../animations/animate-clip-path/animate-clip-path.style.scss.js';
 import '../animations/animate-scale/animate-scale.style.scss.js';
 import '../animations/animate-translate/animate-translate.style.scss.js';
+import { AnimationProp } from '../../types/animation-prop.js';
 
 /**
  * Component to be reused that renders an `<img>`.
@@ -37,12 +37,12 @@ var _sfc_main = defineComponent({
          * image fallback.
          */
         loadAnimation: {
-            type: animationProp,
+            type: AnimationProp,
             default: () => _sfc_main$1
         },
         /** Animation to use when switching between the loaded image and the hover image. */
         hoverAnimation: {
-            type: animationProp
+            type: AnimationProp
         },
         /**
          * Indicates if the next valid image should be displayed on hover.

package/js/components/result/base-result-image.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-result-image.vue2.js","sources":["../../../../src/components/result/base-result-image.vue"],"sourcesContent":["<template>\n  <!-- This is a div because using a picture causes the onload event of the image to fire twice. -->\n  <!-- eslint-disable-next-line vuejs-accessibility/mouse-events-have-key-events -->\n  <div\n    @mouseenter.once=\"userHasHoveredImage = true\"\n    @mouseenter=\"isHovering = true\"\n    @mouseleave=\"isHovering = false\"\n    class=\"x-result-picture x-picture\"\n    data-test=\"result-picture\"\n  >\n    <img\n      v-if=\"shouldLoadNextImage\"\n      @load=\"flagImageLoaded\"\n      @error=\"flagImageAsFailed\"\n      loading=\"lazy\"\n      :src=\"pendingImages[0]\"\n      :style=\"loaderStyles\"\n      class=\"x-picture-image\"\n      data-test=\"result-picture-loader\"\n      alt=\"\"\n      role=\"presentation\"\n    />\n    <component :is=\"animation\" class=\"x-picture-image\" :appear=\"false\">\n      <!-- @slot Fallback image content. It will be rendered when all the images failed -->\n      <slot v-if=\"!loadedImages.length && !pendingImages.length\" name=\"fallback\" />\n\n      <!-- @slot Loading image content. It will be rendered while the real image is not loaded -->\n      <slot v-else-if=\"!loadedImages.length\" name=\"placeholder\" />\n\n      <img\n        v-else\n        :key=\"imageSrc\"\n        :alt=\"result.name\"\n        :src=\"imageSrc\"\n        class=\"x-result-picture-image\"\n        data-test=\"result-picture-image\"\n      />\n    </component>\n  </div>\n</template>\n\n<script lang=\"ts\">\n  import { Result } from '@empathyco/x-types';\n  import { computed, DefineComponent, defineComponent, PropType, Ref, ref, watch } from 'vue';\n  import { animationProp } from '../../utils/options-api';\n  import { NoAnimation } from '../animations';\n\n  /**\n   * Component to be reused that renders an `<img>`.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseResultImage',\n    props: {\n      /** (Required) The {@link @empathyco/x-types#Result} information. */\n      result: {\n        type: Object as PropType<Result>,\n        required: true\n      },\n      /**\n       * Animation to use when switching between the placeholder, the loaded image, or the failed\n       * image fallback.\n       */\n      loadAnimation: {\n        type: animationProp,\n        default: () => NoAnimation\n      },\n      /** Animation to use when switching between the loaded image and the hover image. */\n      hoverAnimation: {\n        type: animationProp\n      },\n      /**\n       * Indicates if the next valid image should be displayed on hover.\n       *\n       * @public\n       */\n      showNextImageOnHover: {\n        type: Boolean,\n        default: false\n      }\n    },\n    setup(props) {\n      /**\n       * Copy of the images of the result.\n       *\n       * It is used as a queue of images to load, once an image loads/fails to load, it is removed\n       * from this array.\n       *\n       * @internal\n       */\n      const pendingImages: Ref<string[]> = ref([]);\n\n      /**\n       * Contains the images that have been loaded successfully.\n       *\n       * @internal\n       */\n      const loadedImages: Ref<string[]> = ref([]);\n\n      /**\n       * Indicates if the user is hovering the image.\n       *\n       * @internal\n       */\n      const isHovering = ref(false);\n\n      /**\n       * Indicates if the user has hovered the image.\n       *\n       * @internal\n       */\n      const userHasHoveredImage = ref(false);\n\n      /**.\n       * Styles to use inline in the image loader, to prevent override from CSS\n       *\n       * @internal\n       */\n      const loaderStyles: Partial<CSSStyleDeclaration> = {\n        position: 'absolute !important',\n        top: '0 !important',\n        left: '0 !important',\n        width: '100% !important',\n        height: '100% !important',\n        pointerEvents: 'none !important',\n        visibility: 'hidden !important'\n      };\n\n      /**\n       * Initializes images state and resets when the result's images change.\n       *\n       * @internal\n       */\n      watch(\n        () => props.result.images,\n        () => {\n          pendingImages.value = [...(props.result.images ?? [])];\n          loadedImages.value = pendingImages.value.filter(image =>\n            loadedImages.value.includes(image)\n          );\n        },\n        { immediate: true }\n      );\n\n      /**\n       * Animation to be used.\n       *\n       * @returns The animation to be used, taking into account if the user has hovered the image.\n       *\n       * @internal\n       */\n      const animation = computed<DefineComponent | string>(() => {\n        return userHasHoveredImage\n          ? props.hoverAnimation ?? props.loadAnimation\n          : props.loadAnimation;\n      });\n\n      /**\n       * Gets the src from the result image.\n       *\n       * @returns The result image src.\n       *\n       * @internal\n       */\n      const imageSrc = computed<string>(() => {\n        return loadedImages.value[\n          !props.showNextImageOnHover || !isHovering.value ? 0 : loadedImages.value.length - 1\n        ];\n      });\n\n      /**\n       * Indicates if the loader should try to load the next image.\n       *\n       * @returns True if it should try to load the next image.\n       *\n       * @internal\n       */\n      const shouldLoadNextImage = computed<boolean>(() => {\n        const numImagesToLoad = props.showNextImageOnHover && userHasHoveredImage ? 2 : 1;\n        return !!pendingImages.value.length && loadedImages.value.length < numImagesToLoad;\n      });\n\n      /**\n       * Sets an image as failed.\n       *\n       * @internal\n       */\n      const flagImageAsFailed = (): void => {\n        pendingImages.value.shift();\n      };\n\n      /**\n       * Sets an image as loaded.\n       *\n       * @internal\n       */\n      const flagImageLoaded = (): void => {\n        const image = pendingImages.value.shift();\n        if (image) {\n          loadedImages.value.push(image);\n        }\n      };\n\n      return {\n        pendingImages,\n        loadedImages,\n        isHovering,\n        userHasHoveredImage,\n        loaderStyles,\n        animation,\n        imageSrc,\n        shouldLoadNextImage,\n        flagImageAsFailed,\n        flagImageLoaded\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-result-picture {\n    position: relative;\n    min-width: 1px;\n    min-height: 1px;\n  }\n\n  .x-result-picture-image {\n    max-width: 100%;\n    max-height: 100%;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Examples\n\n### Basic example\n\nThis component is for the result image. It may be part of the search result page, recommendations or\nother section which needs to include results.\n\nThe result prop is required. It will render a `<img/>` with the result image:\n\n```vue\n<BaseResultImage :result=\"result\" />\n```\n\n### Showing the next image on hover\n\nIf a result has multiple images, it can show the next one on hover.\n\n```vue\n<BaseResultImage :result=\"result\" showNextImageOnHover />\n```\n\n### Customizing slots content\n\nFallback and placeholder contents can be customized.\n\nThe fallback slot allows you to replace the content of the fallback image.\n\nThe other slot is called `placeholder`, and allows you to set the image that its going to be\ndisplayed while the real one is loaded.\n\n```vue\n<BaseResultImage :result=\"result\">\n  <template #placeholder>\n    <img alt=\"Placeholder image\" src=\"./placeholder-image.svg\"/>\n  </template>\n  <template #fallback>\n    <img alt=\"Fallback image\" src=\"./fallback-image.svg\"/>\n  </template>\n</BaseResultImage>\n```\n\n### Customizing the animations\n\nTwo animations can be used this component.\n\nThe `loadAnimation` is used to transition between the placeholder, the fallback and the image.\n\nThe `hoverAnimation` is used to transition between the image and the hover image, if the\n`showNextImageOnHover` prop is `true`.\n\n`hoverAnimation` will default to `loadAnimation` if it is not provided.\n\n```vue\n<template>\n  <BaseResultImage\n    :result=\"result\"\n    :loadAnimation=\"loadAnimation\"\n    :hoverAnimation=\"hoverAnimation\"\n    showNextImageOnHover\n  />\n</template>\n\n<script>\n  import { BaseResultImage } from '@empathyco/x-components';\n  import { CrossFade, CollapseHeight } from '@empathyco/x-components/animations';\n\n  export default {\n    name: 'BaseResultImageAnimations',\n    components: {\n      BaseResultImage\n    },\n    data() {\n      return {\n        loadAnimation: CrossFade,\n        hoverAnimation: CollapseHeight,\n        result: {\n          name: 'jacket',\n          images: ['https://some-image', 'https://some-image-2']\n        }\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["NoAnimation"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA+CE;;;;AAIE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,KAAK,EAAE;;AAEL,QAAA,MAAM,EAAE;AACN,YAAA,IAAI,EAAE,MAA0B;AAChC,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;AACD;;;AAGE;AACF,QAAA,aAAa,EAAE;AACb,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,MAAMA,WAAU;AAC1B,SAAA;;AAED,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,aAAY;AACnB,SAAA;AACD;;;;AAIE;AACF,QAAA,oBAAoB,EAAE;AACpB,YAAA,IAAI,EAAE,OAAO;AACb,YAAA,OAAO,EAAE,KAAI;AACf,SAAA;AACD,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT;;;;;;;AAOE;AACF,QAAA,MAAM,aAAa,GAAkB,GAAG,CAAC,EAAE,CAAC,CAAA;AAE5C;;;;AAIE;AACF,QAAA,MAAM,YAAY,GAAkB,GAAG,CAAC,EAAE,CAAC,CAAA;AAE3C;;;;AAIE;AACF,QAAA,MAAM,UAAW,GAAE,GAAG,CAAC,KAAK,CAAC,CAAA;AAE7B;;;;AAIE;AACF,QAAA,MAAM,sBAAsB,GAAG,CAAC,KAAK,CAAC,CAAA;AAEtC;;;;AAIE;AACF,QAAA,MAAM,YAAY,GAAiC;AACjD,YAAA,QAAQ,EAAE,qBAAqB;AAC/B,YAAA,GAAG,EAAE,cAAc;AACnB,YAAA,IAAI,EAAE,cAAc;AACpB,YAAA,KAAK,EAAE,iBAAiB;AACxB,YAAA,MAAM,EAAE,iBAAiB;AACzB,YAAA,aAAa,EAAE,iBAAiB;AAChC,YAAA,UAAU,EAAE,mBAAkB;SAC/B,CAAA;AAED;;;;AAIE;QACF,KAAK,CACH,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,EACzB,MAAM;AACJ,YAAA,aAAa,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAK,IAAK,EAAE,EAAE,CAAA;YACtD,YAAY,CAAC,KAAM,GAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAI,IAClD,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAA,CAClC,CAAA;AACH,SAAC,EACD,EAAE,SAAS,EAAE,IAAK,EAAA,CACnB,CAAA;AAED;;;;;;AAME;AACF,QAAA,MAAM,SAAU,GAAE,QAAQ,CAA2B,MAAM;AACzD,YAAA,OAAO,mBAAkB;AACvB,kBAAE,KAAK,CAAC,cAAe,IAAG,KAAK,CAAC,aAAY;AAC5C,kBAAE,KAAK,CAAC,aAAa,CAAA;AACzB,SAAC,CAAC,CAAA;AAEF;;;;;;AAME;AACF,QAAA,MAAM,QAAS,GAAE,QAAQ,CAAS,MAAM;AACtC,YAAA,OAAO,YAAY,CAAC,KAAK,CACvB,CAAC,KAAK,CAAC,oBAAmB,IAAK,CAAC,UAAU,CAAC,KAAI,GAAI,CAAA,GAAI,YAAY,CAAC,KAAK,CAAC,SAAS,CAAA,CACpF,CAAA;AACH,SAAC,CAAC,CAAA;AAEF;;;;;;AAME;AACF,QAAA,MAAM,sBAAsB,QAAQ,CAAU,MAAM;AAClD,YAAA,MAAM,eAAgB,GAAE,KAAK,CAAC,oBAAmB,IAAK,mBAAkB,GAAI,CAAA,GAAI,CAAC,CAAA;AACjF,YAAA,OAAO,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,MAAO,IAAG,YAAY,CAAC,KAAK,CAAC,SAAS,eAAe,CAAA;AACpF,SAAC,CAAC,CAAA;AAEF;;;;AAIE;QACF,MAAM,iBAAgB,GAAI,MAAY;AACpC,YAAA,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;AAC7B,SAAC,CAAA;AAED;;;;AAIE;QACF,MAAM,eAAgB,GAAE,MAAY;YAClC,MAAM,KAAM,GAAE,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;AACzC,YAAA,IAAI,KAAK,EAAE;AACT,gBAAA,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAChC,aAAA;AACF,SAAC,CAAA;QAED,OAAO;YACL,aAAa;YACb,YAAY;YACZ,UAAU;YACV,mBAAmB;YACnB,YAAY;YACZ,SAAS;YACT,QAAQ;YACR,mBAAmB;YACnB,iBAAiB;YACjB,eAAc;SACf,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"base-result-image.vue2.js","sources":["../../../../src/components/result/base-result-image.vue"],"sourcesContent":["<template>\n  <!-- This is a div because using a picture causes the onload event of the image to fire twice. -->\n  <!-- eslint-disable-next-line vuejs-accessibility/mouse-events-have-key-events -->\n  <div\n    @mouseenter.once=\"userHasHoveredImage = true\"\n    @mouseenter=\"isHovering = true\"\n    @mouseleave=\"isHovering = false\"\n    class=\"x-result-picture x-picture\"\n    data-test=\"result-picture\"\n  >\n    <img\n      v-if=\"shouldLoadNextImage\"\n      @load=\"flagImageLoaded\"\n      @error=\"flagImageAsFailed\"\n      loading=\"lazy\"\n      :src=\"pendingImages[0]\"\n      :style=\"loaderStyles\"\n      class=\"x-picture-image\"\n      data-test=\"result-picture-loader\"\n      alt=\"\"\n      role=\"presentation\"\n    />\n    <component :is=\"animation\" class=\"x-picture-image\" :appear=\"false\">\n      <!-- @slot Fallback image content. It will be rendered when all the images failed -->\n      <slot v-if=\"!loadedImages.length && !pendingImages.length\" name=\"fallback\" />\n\n      <!-- @slot Loading image content. It will be rendered while the real image is not loaded -->\n      <slot v-else-if=\"!loadedImages.length\" name=\"placeholder\" />\n\n      <img\n        v-else\n        :key=\"imageSrc\"\n        :alt=\"result.name\"\n        :src=\"imageSrc\"\n        class=\"x-result-picture-image\"\n        data-test=\"result-picture-image\"\n      />\n    </component>\n  </div>\n</template>\n\n<script lang=\"ts\">\n  import { Result } from '@empathyco/x-types';\n  import { computed, defineComponent, PropType, Ref, ref, watch } from 'vue';\n  import { NoAnimation } from '../animations';\n  import { AnimationProp } from '../../types';\n\n  /**\n   * Component to be reused that renders an `<img>`.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseResultImage',\n    props: {\n      /** (Required) The {@link @empathyco/x-types#Result} information. */\n      result: {\n        type: Object as PropType<Result>,\n        required: true\n      },\n      /**\n       * Animation to use when switching between the placeholder, the loaded image, or the failed\n       * image fallback.\n       */\n      loadAnimation: {\n        type: AnimationProp,\n        default: () => NoAnimation\n      },\n      /** Animation to use when switching between the loaded image and the hover image. */\n      hoverAnimation: {\n        type: AnimationProp\n      },\n      /**\n       * Indicates if the next valid image should be displayed on hover.\n       *\n       * @public\n       */\n      showNextImageOnHover: {\n        type: Boolean,\n        default: false\n      }\n    },\n    setup(props) {\n      /**\n       * Copy of the images of the result.\n       *\n       * It is used as a queue of images to load, once an image loads/fails to load, it is removed\n       * from this array.\n       *\n       * @internal\n       */\n      const pendingImages: Ref<string[]> = ref([]);\n\n      /**\n       * Contains the images that have been loaded successfully.\n       *\n       * @internal\n       */\n      const loadedImages: Ref<string[]> = ref([]);\n\n      /**\n       * Indicates if the user is hovering the image.\n       *\n       * @internal\n       */\n      const isHovering = ref(false);\n\n      /**\n       * Indicates if the user has hovered the image.\n       *\n       * @internal\n       */\n      const userHasHoveredImage = ref(false);\n\n      /**.\n       * Styles to use inline in the image loader, to prevent override from CSS\n       *\n       * @internal\n       */\n      const loaderStyles: Partial<CSSStyleDeclaration> = {\n        position: 'absolute !important',\n        top: '0 !important',\n        left: '0 !important',\n        width: '100% !important',\n        height: '100% !important',\n        pointerEvents: 'none !important',\n        visibility: 'hidden !important'\n      };\n\n      /**\n       * Initializes images state and resets when the result's images change.\n       *\n       * @internal\n       */\n      watch(\n        () => props.result.images,\n        () => {\n          pendingImages.value = [...(props.result.images ?? [])];\n          loadedImages.value = pendingImages.value.filter(image =>\n            loadedImages.value.includes(image)\n          );\n        },\n        { immediate: true }\n      );\n\n      /**\n       * Animation to be used.\n       *\n       * @returns The animation to be used, taking into account if the user has hovered the image.\n       *\n       * @internal\n       */\n      const animation = computed(() => {\n        return userHasHoveredImage\n          ? props.hoverAnimation ?? props.loadAnimation\n          : props.loadAnimation;\n      });\n\n      /**\n       * Gets the src from the result image.\n       *\n       * @returns The result image src.\n       *\n       * @internal\n       */\n      const imageSrc = computed(() => {\n        return loadedImages.value[\n          !props.showNextImageOnHover || !isHovering.value ? 0 : loadedImages.value.length - 1\n        ];\n      });\n\n      /**\n       * Indicates if the loader should try to load the next image.\n       *\n       * @returns True if it should try to load the next image.\n       *\n       * @internal\n       */\n      const shouldLoadNextImage = computed(() => {\n        const numImagesToLoad = props.showNextImageOnHover && userHasHoveredImage ? 2 : 1;\n        return !!pendingImages.value.length && loadedImages.value.length < numImagesToLoad;\n      });\n\n      /**\n       * Sets an image as failed.\n       *\n       * @internal\n       */\n      const flagImageAsFailed = () => {\n        pendingImages.value.shift();\n      };\n\n      /**\n       * Sets an image as loaded.\n       *\n       * @internal\n       */\n      const flagImageLoaded = () => {\n        const image = pendingImages.value.shift();\n        if (image) {\n          loadedImages.value.push(image);\n        }\n      };\n\n      return {\n        pendingImages,\n        loadedImages,\n        isHovering,\n        userHasHoveredImage,\n        loaderStyles,\n        animation,\n        imageSrc,\n        shouldLoadNextImage,\n        flagImageAsFailed,\n        flagImageLoaded\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-result-picture {\n    position: relative;\n    min-width: 1px;\n    min-height: 1px;\n  }\n\n  .x-result-picture-image {\n    max-width: 100%;\n    max-height: 100%;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Examples\n\n### Basic example\n\nThis component is for the result image. It may be part of the search result page, recommendations or\nother section which needs to include results.\n\nThe result prop is required. It will render a `<img/>` with the result image:\n\n```vue\n<BaseResultImage :result=\"result\" />\n```\n\n### Showing the next image on hover\n\nIf a result has multiple images, it can show the next one on hover.\n\n```vue\n<BaseResultImage :result=\"result\" showNextImageOnHover />\n```\n\n### Customizing slots content\n\nFallback and placeholder contents can be customized.\n\nThe fallback slot allows you to replace the content of the fallback image.\n\nThe other slot is called `placeholder`, and allows you to set the image that its going to be\ndisplayed while the real one is loaded.\n\n```vue\n<BaseResultImage :result=\"result\">\n  <template #placeholder>\n    <img alt=\"Placeholder image\" src=\"./placeholder-image.svg\"/>\n  </template>\n  <template #fallback>\n    <img alt=\"Fallback image\" src=\"./fallback-image.svg\"/>\n  </template>\n</BaseResultImage>\n```\n\n### Customizing the animations\n\nTwo animations can be used this component.\n\nThe `loadAnimation` is used to transition between the placeholder, the fallback and the image.\n\nThe `hoverAnimation` is used to transition between the image and the hover image, if the\n`showNextImageOnHover` prop is `true`.\n\n`hoverAnimation` will default to `loadAnimation` if it is not provided.\n\n```vue\n<template>\n  <BaseResultImage\n    :result=\"result\"\n    :loadAnimation=\"loadAnimation\"\n    :hoverAnimation=\"hoverAnimation\"\n    showNextImageOnHover\n  />\n</template>\n\n<script>\n  import { BaseResultImage } from '@empathyco/x-components';\n  import { CrossFade, CollapseHeight } from '@empathyco/x-components/animations';\n\n  export default {\n    name: 'BaseResultImageAnimations',\n    components: {\n      BaseResultImage\n    },\n    data() {\n      return {\n        loadAnimation: CrossFade,\n        hoverAnimation: CollapseHeight,\n        result: {\n          name: 'jacket',\n          images: ['https://some-image', 'https://some-image-2']\n        }\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["NoAnimation"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA+CE;;;;AAIE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,KAAK,EAAE;;AAEL,QAAA,MAAM,EAAE;AACN,YAAA,IAAI,EAAE,MAA0B;AAChC,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;AACD;;;AAGE;AACF,QAAA,aAAa,EAAE;AACb,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,MAAMA,WAAU;AAC1B,SAAA;;AAED,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,aAAY;AACnB,SAAA;AACD;;;;AAIE;AACF,QAAA,oBAAoB,EAAE;AACpB,YAAA,IAAI,EAAE,OAAO;AACb,YAAA,OAAO,EAAE,KAAI;AACf,SAAA;AACD,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT;;;;;;;AAOE;AACF,QAAA,MAAM,aAAa,GAAkB,GAAG,CAAC,EAAE,CAAC,CAAA;AAE5C;;;;AAIE;AACF,QAAA,MAAM,YAAY,GAAkB,GAAG,CAAC,EAAE,CAAC,CAAA;AAE3C;;;;AAIE;AACF,QAAA,MAAM,UAAW,GAAE,GAAG,CAAC,KAAK,CAAC,CAAA;AAE7B;;;;AAIE;AACF,QAAA,MAAM,sBAAsB,GAAG,CAAC,KAAK,CAAC,CAAA;AAEtC;;;;AAIE;AACF,QAAA,MAAM,YAAY,GAAiC;AACjD,YAAA,QAAQ,EAAE,qBAAqB;AAC/B,YAAA,GAAG,EAAE,cAAc;AACnB,YAAA,IAAI,EAAE,cAAc;AACpB,YAAA,KAAK,EAAE,iBAAiB;AACxB,YAAA,MAAM,EAAE,iBAAiB;AACzB,YAAA,aAAa,EAAE,iBAAiB;AAChC,YAAA,UAAU,EAAE,mBAAkB;SAC/B,CAAA;AAED;;;;AAIE;QACF,KAAK,CACH,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,EACzB,MAAM;AACJ,YAAA,aAAa,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAK,IAAK,EAAE,EAAE,CAAA;YACtD,YAAY,CAAC,KAAM,GAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAI,IAClD,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAA,CAClC,CAAA;AACH,SAAC,EACD,EAAE,SAAS,EAAE,IAAK,EAAA,CACnB,CAAA;AAED;;;;;;AAME;AACF,QAAA,MAAM,SAAQ,GAAI,QAAQ,CAAC,MAAM;AAC/B,YAAA,OAAO,mBAAkB;AACvB,kBAAE,KAAK,CAAC,cAAe,IAAG,KAAK,CAAC,aAAY;AAC5C,kBAAE,KAAK,CAAC,aAAa,CAAA;AACzB,SAAC,CAAC,CAAA;AAEF;;;;;;AAME;AACF,QAAA,MAAM,QAAO,GAAI,QAAQ,CAAC,MAAM;AAC9B,YAAA,OAAO,YAAY,CAAC,KAAK,CACvB,CAAC,KAAK,CAAC,oBAAmB,IAAK,CAAC,UAAU,CAAC,KAAI,GAAI,CAAA,GAAI,YAAY,CAAC,KAAK,CAAC,SAAS,CAAA,CACpF,CAAA;AACH,SAAC,CAAC,CAAA;AAEF;;;;;;AAME;AACF,QAAA,MAAM,mBAAkB,GAAI,QAAQ,CAAC,MAAM;AACzC,YAAA,MAAM,eAAgB,GAAE,KAAK,CAAC,oBAAmB,IAAK,mBAAkB,GAAI,CAAA,GAAI,CAAC,CAAA;AACjF,YAAA,OAAO,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,MAAO,IAAG,YAAY,CAAC,KAAK,CAAC,SAAS,eAAe,CAAA;AACpF,SAAC,CAAC,CAAA;AAEF;;;;AAIE;QACF,MAAM,iBAAgB,GAAI,MAAM;AAC9B,YAAA,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;AAC7B,SAAC,CAAA;AAED;;;;AAIE;QACF,MAAM,kBAAkB,MAAM;YAC5B,MAAM,KAAM,GAAE,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;AACzC,YAAA,IAAI,KAAK,EAAE;AACT,gBAAA,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAChC,aAAA;AACF,SAAC,CAAA;QAED,OAAO;YACL,aAAa;YACb,YAAY;YACZ,UAAU;YACV,mBAAmB;YACnB,YAAY;YACZ,SAAS;YACT,QAAQ;YACR,mBAAmB;YACnB,iBAAiB;YACjB,eAAc;SACf,CAAA;KACH;AACD,CAAA,CAAC;;;;"}

package/js/types/animation-prop.js

@@ -1,6 +1,11 @@
 /**
  * Type for animations props.
  *
+ * @remarks
+ * String for 'ul'
+ * Object for `DefineComponent` type
+ * Function for `() => NoElement`
+ *
  * @public
  */
 const AnimationProp = [String, Object, Function];

package/js/types/animation-prop.js.map

@@ -1 +1 @@
-{"version":3,"file":"animation-prop.js","sources":["../../../src/types/animation-prop.ts"],"sourcesContent":["import { DefineComponent, PropType } from 'vue';\n\n/**\n * Type for animations props.\n *\n * @public\n */\nexport const AnimationProp = [String, Object, Function] as PropType<\n  // eslint-disable-next-line @typescript-eslint/ban-types\n  DefineComponent<{}, {}, any> | string\n>;\n"],"names":[],"mappings":"AAEA;;;;AAIG;AACU,MAAA,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ;;;;"}
+{"version":3,"file":"animation-prop.js","sources":["../../../src/types/animation-prop.ts"],"sourcesContent":["/**\n * Type for animations props.\n *\n * @remarks\n * String for 'ul'\n * Object for `DefineComponent` type\n * Function for `() => NoElement`\n *\n * @public\n */\nexport const AnimationProp = [String, Object, Function];\n"],"names":[],"mappings":"AAAA;;;;;;;;;AASG;AACU,MAAA,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ;;;;"}

package/js/x-modules/facets/components/facets/facets.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"facets.vue.js","sources":["../../../../../../src/x-modules/facets/components/facets/facets.vue"],"sourcesContent":["<template>\n  <component :is=\"animation\" v-if=\"hasFacets\" class=\"x-facets-list\" data-test=\"facets\" tag=\"ul\">\n    <li\n      v-for=\"({ facet, slotNameById, slotNameByModelName }, facetId) in mappedFacets\"\n      :key=\"facetId\"\n      class=\"x-facets-list__item\"\n      data-test=\"facets-facet\"\n    >\n      <!--\n        @slot Customized Facet rendering. Specifying a slot with the facet's name will result in the\n        facet using that slot composition to render.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-if=\"hasSlot(slotNameById)\"\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n        :name=\"slotNameById\"\n      />\n      <!--\n        @slot Customized Facet rendering. Specifying a slot with the facet's modelName will result\n        in the facet using that slot composition to render.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-else-if=\"hasSlot(slotNameByModelName)\"\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n        :name=\"slotNameByModelName\"\n      />\n      <!--\n        @slot (required) Default Facet rendering. This slot will be used by default for rendering\n        the facets without an specific slot implementation.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-else\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n      >\n        This is the {{ facet.label }} facet. Pass something into its slot to display content.\n      </slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { Facet } from '@empathyco/x-types';\n  import { Dictionary, map, objectFilter } from '@empathyco/x-utils';\n  import { computed, ComputedRef, defineComponent, PropType } from 'vue';\n  import { useGetter } from '../../../../composables/use-getter';\n  import { animationProp } from '../../../../utils/options-api';\n  import { toKebabCase } from '../../../../utils/string';\n  import { useFacets } from '../../composables/use-facets';\n  import { facetsXModule } from '../../x-module';\n\n  /**\n   * Custom interface to provide a slot name to a Facet.\n   *\n   * @internal\n   */\n  interface RenderFacet {\n    slotNameById: string;\n    slotNameByModelName: string;\n    facet: Facet;\n  }\n\n  /**\n   * This component renders the list of facets stored in the Facets module. Facets can be rendered\n   * differently based on their purpose and this can be achieved using the exposed slots:\n   * - A default and required slot.\n   * - A custom slot for each facet with the facetId as its name. This allows each facet to be\n   * rendered differently based on its needs.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'Facets',\n    xModule: facetsXModule.name,\n    props: {\n      /** Array of facets ids used to get the selected filters for those facets. */\n      facetsIds: Array as PropType<Array<Facet['id']>>,\n      /** Flag to render the component even if there are no filters selected. */\n      alwaysVisible: Boolean,\n      /** Animation component that will be used to animate the facets. */\n      animation: {\n        type: animationProp,\n        default: 'ul'\n      },\n      /**\n       * Discriminates the facets rendered by this component. It expects a string containing facets\n       * ids, comma separated. This property will include or exclude facets based on its value.\n       * The default value is an empty string and the component will render all existing facets.\n       *\n       * @remarks\n       * To behave as a `include`, simply set the facets ids, comma separated:\n       * `existingFacets=[{ brand: ... }, category: { ... }, color: { ... }, price: { ... }]`\n       * `renderableFacets=\"brand, category\"`\n       *\n       * The component will render brand and category facets.\n       *\n       * On the other hand, to simulate an `exclude` behaviour and exclude a facet from being\n       * rendered, append a '!' before its id:\n       * `existingFacets=[{ brand: ... }, category: { ... }, color: { ... }, price: { ... }]`\n       * `renderableFacets=\"!brand,!price\"`\n       *\n       * The component will render category and color facets.\n       */\n      renderableFacets: String\n    },\n    setup: function (props, { slots }) {\n      const { selectedFiltersByFacet } = useFacets(props);\n\n      const { facets } = useGetter('facets', ['facets']) as {\n        /** Dictionary of facets in the state. */\n        facets: ComputedRef<Record<Facet['id'], Facet>>;\n      };\n\n      /**\n       * The facets to be rendered after filtering {@link Facets.facets} by\n       * {@link Facets.renderableFacets} content.\n       *\n       * @returns The list of facets to be rendered.\n       */\n      const facetsToRender = computed<Dictionary<Facet>>(() => {\n        if (!props.renderableFacets) {\n          return facets.value;\n        } else {\n          const excludedRegExp = /^!/;\n          const facetIds: string[] = props.renderableFacets\n            .split(',')\n            .map(facetId => facetId.trim());\n          const included: string[] = [];\n          const excluded: string[] = [];\n          facetIds.forEach(facetId => {\n            if (excludedRegExp.test(facetId)) {\n              excluded.push(facetId.replace(excludedRegExp, ''));\n            } else {\n              included.push(facetId);\n            }\n          });\n\n          return filterFacetsToRender(included, excluded);\n        }\n      });\n\n      /**\n       * Transforms a dictionary of Facets including the slot name.\n       *\n       * @returns A dictionary of facets with the slot name.\n       */\n      const mappedFacets = computed<Dictionary<RenderFacet>>(() => {\n        return map(facetsToRender.value, (facetId, facet) => ({\n          slotNameById: toKebabCase(facetId),\n          slotNameByModelName: toKebabCase(facet.modelName),\n          facet\n        }));\n      });\n\n      /**\n       * Indicates if there are facets available to show.\n       *\n       * @returns True if there are facets available and false otherwise.\n       */\n      const hasFacets = computed<boolean>(() => !!Object.keys(facetsToRender.value).length);\n\n      /**\n       * Filter facets dictionary retrieving those included and/or removing excluded.\n       *\n       * @param included - List of facets to render.\n       * @param excluded - List of not renderable facets.\n       *\n       * @returns The filtered list of facets to render.\n       */\n      function filterFacetsToRender(included: string[], excluded: string[]): Dictionary<Facet> {\n        const hasAnyFacetIncluded = included.length > 0;\n        return objectFilter(facets.value, facetKey => {\n          const isIncluded = included.includes(String(facetKey));\n          const isExcluded = excluded.includes(String(facetKey));\n\n          return hasAnyFacetIncluded ? isIncluded && !isExcluded : !isExcluded;\n        });\n      }\n\n      /**\n       * Whether the slot is present in the template or not.\n       *\n       * @param name - The slot name.\n       *\n       * @returns True is the slot is present in the template. False otherwise.\n       */\n      function hasSlot(name: string): boolean {\n        return !!slots[name];\n      }\n\n      return {\n        selectedFiltersByFacet,\n        hasFacets,\n        mappedFacets,\n        hasSlot\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-facets-list {\n    display: flex;\n    flex-flow: column nowrap;\n    list-style-type: none;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Example\n\nThis component renders the list of facets stored in the Facets module. Facets can be rendered\ndifferently based on their purpose and this can be achieved using the exposed slots:\n\n- A default and required slot.\n- A custom slot for each facet with the facetId as its name. This allows each facet to be rendered\n  differently based on its needs.\n\nBelow, there are some examples showing how to use the component with its different configurations.\n\n### Default usage\n\nThe default slot of this component is mandatory. If no other slot is defined, every Facet will be\nrendered as specified in the default slot.\n\n```vue\n<template>\n  <Facets>\n    <template #default=\"{ facet, selectedFilters }\">\n      <h1>{{ ${facet.label} }}</h1>\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} selected` }}</span>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Customized usage\n\nCustomized compositions for a specific Facet can be achieved by using a slot with the same id as the\nfacet to customize. For example, the Facet with the id \"color\" requires a composition that differs\nfrom the rest of the Facets. Doing it in a slot with the name \"color\" will apply this customization\njust to the \"color\" Facet. The other facets will fallback to the composition of the default slot.\n\nIt is also possible to customize the Facet content by the facet \"model name\". For example, to\nconfigure different content for \"Hierarchical Facets\" the \"hierarchical-facet\" slot will apply that\ncustomization. This can be combined with the facets by facet id. If some hierarchical facet needs\nsome different customization from the rest of the hierarchical, it can be achieve using the slot\nwith the facet id.\n\n```vue\n<template>\n  <Facets>\n    <template #color=\"{ facet, selectedFilters }\">\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} colors chosen` }}</span>\n\n      <ul v-for=\"filter in facet.filters\" :key=\"filter.id\">\n        <li v-if=\"!filter.selected\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n\n    <template #hierarchical-facet=\"{ facet, selectedFilters }\">\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} colors chosen` }}</span>\n\n      <ul v-for=\"filter in facet.filters\" :key=\"filter.id\">\n        <li v-if=\"!filter.selected\">\n          {{ filter.label }}\n          <ul v-for=\"childFilter in filter.children\" :key=\"filter.id\">\n            <li v-if=\"!childFilter.selected\">\n              {{ childFilter.label }}\n            </li>\n          </ul>\n        </li>\n      </ul>\n    </template>\n\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Render specific facets I\n\nBy default, this component will render all existing facets. However, it has the renderableFacets\nprop to filter which facets will be rendered. Its value is a string containing the different facets\nids. This value is treated as an include or exclude list (to exclude a facet from being rendered,\njust prefix its id with a `!`). The component will only render included facets and discard excluded\nones. In the following example, the component will only render color and category facets.\n\n```vue\n<template>\n  <Facets renderableFacets=\"color, category\">\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Render specific facets II\n\nExclude facets so the component does not render them. In the following example, the component will\nrender every facet except color and price.\n\n```vue\n<template>\n  <Facets renderableFacets=\"!color, !price\">\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Integrating with the filters components\n\nThere are many components that will help you build your own awesome filters list. `Facets` just\nrenders the list, but what to render for each facet is up to you. Below you can see an example. of\nthe `Facets` component using the `FiltersSearch` `MultiSelectFilters`, `SimpleFilter`, `Filters`,\n`HierarchicalFilter`, `NumberRangeFilter` and `BasePriceFilterLabel`.\n\n```vue\n<template>\n  <Facets>\n    <template #default=\"{ facet, selectedFilters }\">\n      <h1>{{ facet.label }}</h1>\n      <FiltersSearch :filters=\"facet.filters\">\n        <MultiSelectFilters v-slot=\"{ filter }\">\n          <SimpleFilter :filter=\"filter\" />\n        </MultiSelectFilters>\n      </FiltersSearch>\n    </template>\n\n    <template #category=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n      <Filters v-slot=\"{ filter }\" :filters=\"facet.filters\">\n        <HierarchicalFilter :filter=\"filter\" />\n      </Filters>\n    </template>\n\n    <template #price=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n      <Filters v-slot=\"{ filter }\" :filters=\"facet.filters\">\n        <NumberRangeFilter :filter=\"filter\">\n          <BasePriceFilterLabel :filter=\"filter\" />\n        </NumberRangeFilter>\n      </Filters>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import {\n    Facets,\n    Filters,\n    FiltersSearch,\n    HierarchicalFilter,\n    MultiSelectFilters,\n    NumberRangeFilter,\n    SimpleFilter\n  } from '@empathyco/x-components/facets';\n\n  import { BasePriceFilterLabel } from '@empathyco/x-components';\n\n  export default {\n    components: {\n      Facets,\n      MultiSelectFilters,\n      FiltersSearch,\n      SimpleFilter,\n      Filters,\n      HierarchicalFilter,\n      NumberRangeFilter,\n      BasePriceFilterLabel\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["animation","_openBlock","_createBlock","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","hasSlot","_createCommentVNode","_renderSlot","_mergeProps","selectedFiltersByFacet"],"mappings":";;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EADF,MACkBA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;AADlB,EAAA,OAAA,IAAA,CAAA,SAAA,IAAAC,SAAA,EACmE,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IAAC,GAAA,EAAA,CAAA;AAAA,IAAmB,KAAI,EAAA,eAAA;AAAA,IAAA,WAAA,EAAA,QAAA;AAD3F,IAAA,GAAA,EAAA,IAAA;AAAA,GAAA,EAAA;;iBAIY,IAAO,CAAA,EAAAC,kBAAA;AAAA,QAAAC,QAAA;AAAA,QAAA,IAAA;AAAA,QAAAC,UAAA,CAAA,IAAA,CAAA,YAAA,EAAA,CAAA,EAAA,KAAA,EAAA,YAAA,EAAA,mBAAA,EAAA,EAAA,OAAA,KAAA;AACR,UAAA,OAAAL,SAAA,EAAsB,EAAAG,kBAAA,CAAA,IAAA,EAAA;AAAA,YAC3B,GAAA,EAAA,OAAA;AAAA,YAAA,KAAA,EAAA,qBAAA;AAEA,YAAA,WAAA,EAAA,cAAA;AAAA,WAOQG,EAAAA;AAAAA,YAMNC,kBAAA,CAAA,2TAAA,CAAA;AAAA,YArBR,IAAA,CAAA,OAAA,CAAA,YAAA,CAAA,GAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,YAAA,EAAAC,UAAA,CAAA;AAAA,cAAA,GAAA,EAAA,CAAA;AAgBiC,cAAA,OAAA,EAAA,IAAA;AAAA,aAAA,EAAA;;AAadH,cAAAA,eAAAA,EAAAA,IAAAA,CAAQ,sBAAmB,CAAA,OAAA,CAAA,IAAA,EAAA;AAAA,aAAA,CAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA,GAAA,IAAA,CAPxC,2CAaE,EAAAH,kBAAA;AAAA,cADOC,QAAA;AAAA,cAAmB,EAN5B,GAAA,EAAA,CAAA,EAAA;AAAA,cAAA;AAAA,gBAE2BG,kBAAA,CAAA,gUAAA,CAAA;AAAA,gBAAAC,UAAA,CAA6BE,IAA8B,CAAA,MAAA,EAAA,mBAAA,EAAAD,UAAA,CAAA,EAAA,OAAA,EAAA,IAAA,EAAA,EAAA;AAAA,kBAAA,KAAA;;;;AAMtF,cAAA,IAAA;AAAA;AAAA,aAAA,KAAAT,SAAA,EAcO,EAAAG,kBAAA;AAAA,cAAAC,QAAA;AAAA,cARP,EA1CN,GAAA,EAAA,CAAA,EAAA;AAAA,cAAA;AAAA,gBA4CiCG,kBAAA,CAAA,+TAAA,CAAA;AAAA,gBAAAC,UAAA,CAA6BE,wBAAuBD,UAAO,CAAA,EAAA,OAAA,EAAA,IAAA,EAAA,EAAA;AAAA,kBAAA,KAAA;AA5C5F,kBAAA,eAAA,EAAA,IAAA,CAAA,sBAAA,CAgDO,OACa,CAAA,IAAA,EAAA;AAAA,iBAAA,CAAA,EAAA,MAAA;;;;;;;;;;;;AAjDpB,SAAA,CAAA;AAAA,QAAA,GAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;AAAA,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,CAAA,IAAAF,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}
+{"version":3,"file":"facets.vue.js","sources":["../../../../../../src/x-modules/facets/components/facets/facets.vue"],"sourcesContent":["<template>\n  <component :is=\"animation\" v-if=\"hasFacets\" class=\"x-facets-list\" data-test=\"facets\" tag=\"ul\">\n    <li\n      v-for=\"({ facet, slotNameById, slotNameByModelName }, facetId) in mappedFacets\"\n      :key=\"facetId\"\n      class=\"x-facets-list__item\"\n      data-test=\"facets-facet\"\n    >\n      <!--\n        @slot Customized Facet rendering. Specifying a slot with the facet's name will result in the\n        facet using that slot composition to render.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-if=\"hasSlot(slotNameById)\"\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n        :name=\"slotNameById\"\n      />\n      <!--\n        @slot Customized Facet rendering. Specifying a slot with the facet's modelName will result\n        in the facet using that slot composition to render.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-else-if=\"hasSlot(slotNameByModelName)\"\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n        :name=\"slotNameByModelName\"\n      />\n      <!--\n        @slot (required) Default Facet rendering. This slot will be used by default for rendering\n        the facets without an specific slot implementation.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-else\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n      >\n        This is the {{ facet.label }} facet. Pass something into its slot to display content.\n      </slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { Facet } from '@empathyco/x-types';\n  import { Dictionary, map, objectFilter } from '@empathyco/x-utils';\n  import { computed, ComputedRef, defineComponent, PropType } from 'vue';\n  import { useGetter } from '../../../../composables/use-getter';\n  import { toKebabCase } from '../../../../utils/string';\n  import { useFacets } from '../../composables/use-facets';\n  import { facetsXModule } from '../../x-module';\n  import { AnimationProp } from '../../../../types';\n\n  /**\n   * Custom interface to provide a slot name to a Facet.\n   *\n   * @internal\n   */\n  interface RenderFacet {\n    slotNameById: string;\n    slotNameByModelName: string;\n    facet: Facet;\n  }\n\n  /**\n   * This component renders the list of facets stored in the Facets module. Facets can be rendered\n   * differently based on their purpose and this can be achieved using the exposed slots:\n   * - A default and required slot.\n   * - A custom slot for each facet with the facetId as its name. This allows each facet to be\n   * rendered differently based on its needs.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'Facets',\n    xModule: facetsXModule.name,\n    props: {\n      /** Array of facets ids used to get the selected filters for those facets. */\n      facetsIds: Array as PropType<Array<Facet['id']>>,\n      /** Flag to render the component even if there are no filters selected. */\n      alwaysVisible: Boolean,\n      /** Animation component that will be used to animate the facets. */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      },\n      /**\n       * Discriminates the facets rendered by this component. It expects a string containing facets\n       * ids, comma separated. This property will include or exclude facets based on its value.\n       * The default value is an empty string and the component will render all existing facets.\n       *\n       * @remarks\n       * To behave as a `include`, simply set the facets ids, comma separated:\n       * `existingFacets=[{ brand: ... }, category: { ... }, color: { ... }, price: { ... }]`\n       * `renderableFacets=\"brand, category\"`\n       *\n       * The component will render brand and category facets.\n       *\n       * On the other hand, to simulate an `exclude` behaviour and exclude a facet from being\n       * rendered, append a '!' before its id:\n       * `existingFacets=[{ brand: ... }, category: { ... }, color: { ... }, price: { ... }]`\n       * `renderableFacets=\"!brand,!price\"`\n       *\n       * The component will render category and color facets.\n       */\n      renderableFacets: String\n    },\n    setup: function (props, { slots }) {\n      const { selectedFiltersByFacet } = useFacets(props);\n\n      const { facets } = useGetter('facets', ['facets']) as {\n        /** Dictionary of facets in the state. */\n        facets: ComputedRef<Record<Facet['id'], Facet>>;\n      };\n\n      /**\n       * The facets to be rendered after filtering {@link Facets.facets} by\n       * {@link Facets.renderableFacets} content.\n       *\n       * @returns The list of facets to be rendered.\n       */\n      const facetsToRender = computed<Dictionary<Facet>>(() => {\n        if (!props.renderableFacets) {\n          return facets.value;\n        } else {\n          const excludedRegExp = /^!/;\n          const facetIds: string[] = props.renderableFacets\n            .split(',')\n            .map(facetId => facetId.trim());\n          const included: string[] = [];\n          const excluded: string[] = [];\n          facetIds.forEach(facetId => {\n            if (excludedRegExp.test(facetId)) {\n              excluded.push(facetId.replace(excludedRegExp, ''));\n            } else {\n              included.push(facetId);\n            }\n          });\n\n          return filterFacetsToRender(included, excluded);\n        }\n      });\n\n      /**\n       * Transforms a dictionary of Facets including the slot name.\n       *\n       * @returns A dictionary of facets with the slot name.\n       */\n      const mappedFacets = computed<Dictionary<RenderFacet>>(() => {\n        return map(facetsToRender.value, (facetId, facet) => ({\n          slotNameById: toKebabCase(facetId),\n          slotNameByModelName: toKebabCase(facet.modelName),\n          facet\n        }));\n      });\n\n      /**\n       * Indicates if there are facets available to show.\n       *\n       * @returns True if there are facets available and false otherwise.\n       */\n      const hasFacets = computed<boolean>(() => !!Object.keys(facetsToRender.value).length);\n\n      /**\n       * Filter facets dictionary retrieving those included and/or removing excluded.\n       *\n       * @param included - List of facets to render.\n       * @param excluded - List of not renderable facets.\n       *\n       * @returns The filtered list of facets to render.\n       */\n      function filterFacetsToRender(included: string[], excluded: string[]): Dictionary<Facet> {\n        const hasAnyFacetIncluded = included.length > 0;\n        return objectFilter(facets.value, facetKey => {\n          const isIncluded = included.includes(String(facetKey));\n          const isExcluded = excluded.includes(String(facetKey));\n\n          return hasAnyFacetIncluded ? isIncluded && !isExcluded : !isExcluded;\n        });\n      }\n\n      /**\n       * Whether the slot is present in the template or not.\n       *\n       * @param name - The slot name.\n       *\n       * @returns True is the slot is present in the template. False otherwise.\n       */\n      function hasSlot(name: string): boolean {\n        return !!slots[name];\n      }\n\n      return {\n        selectedFiltersByFacet,\n        hasFacets,\n        mappedFacets,\n        hasSlot\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-facets-list {\n    display: flex;\n    flex-flow: column nowrap;\n    list-style-type: none;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Example\n\nThis component renders the list of facets stored in the Facets module. Facets can be rendered\ndifferently based on their purpose and this can be achieved using the exposed slots:\n\n- A default and required slot.\n- A custom slot for each facet with the facetId as its name. This allows each facet to be rendered\n  differently based on its needs.\n\nBelow, there are some examples showing how to use the component with its different configurations.\n\n### Default usage\n\nThe default slot of this component is mandatory. If no other slot is defined, every Facet will be\nrendered as specified in the default slot.\n\n```vue\n<template>\n  <Facets>\n    <template #default=\"{ facet, selectedFilters }\">\n      <h1>{{ ${facet.label} }}</h1>\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} selected` }}</span>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Customized usage\n\nCustomized compositions for a specific Facet can be achieved by using a slot with the same id as the\nfacet to customize. For example, the Facet with the id \"color\" requires a composition that differs\nfrom the rest of the Facets. Doing it in a slot with the name \"color\" will apply this customization\njust to the \"color\" Facet. The other facets will fallback to the composition of the default slot.\n\nIt is also possible to customize the Facet content by the facet \"model name\". For example, to\nconfigure different content for \"Hierarchical Facets\" the \"hierarchical-facet\" slot will apply that\ncustomization. This can be combined with the facets by facet id. If some hierarchical facet needs\nsome different customization from the rest of the hierarchical, it can be achieve using the slot\nwith the facet id.\n\n```vue\n<template>\n  <Facets>\n    <template #color=\"{ facet, selectedFilters }\">\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} colors chosen` }}</span>\n\n      <ul v-for=\"filter in facet.filters\" :key=\"filter.id\">\n        <li v-if=\"!filter.selected\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n\n    <template #hierarchical-facet=\"{ facet, selectedFilters }\">\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} colors chosen` }}</span>\n\n      <ul v-for=\"filter in facet.filters\" :key=\"filter.id\">\n        <li v-if=\"!filter.selected\">\n          {{ filter.label }}\n          <ul v-for=\"childFilter in filter.children\" :key=\"filter.id\">\n            <li v-if=\"!childFilter.selected\">\n              {{ childFilter.label }}\n            </li>\n          </ul>\n        </li>\n      </ul>\n    </template>\n\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Render specific facets I\n\nBy default, this component will render all existing facets. However, it has the renderableFacets\nprop to filter which facets will be rendered. Its value is a string containing the different facets\nids. This value is treated as an include or exclude list (to exclude a facet from being rendered,\njust prefix its id with a `!`). The component will only render included facets and discard excluded\nones. In the following example, the component will only render color and category facets.\n\n```vue\n<template>\n  <Facets renderableFacets=\"color, category\">\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Render specific facets II\n\nExclude facets so the component does not render them. In the following example, the component will\nrender every facet except color and price.\n\n```vue\n<template>\n  <Facets renderableFacets=\"!color, !price\">\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Integrating with the filters components\n\nThere are many components that will help you build your own awesome filters list. `Facets` just\nrenders the list, but what to render for each facet is up to you. Below you can see an example. of\nthe `Facets` component using the `FiltersSearch` `MultiSelectFilters`, `SimpleFilter`, `Filters`,\n`HierarchicalFilter`, `NumberRangeFilter` and `BasePriceFilterLabel`.\n\n```vue\n<template>\n  <Facets>\n    <template #default=\"{ facet, selectedFilters }\">\n      <h1>{{ facet.label }}</h1>\n      <FiltersSearch :filters=\"facet.filters\">\n        <MultiSelectFilters v-slot=\"{ filter }\">\n          <SimpleFilter :filter=\"filter\" />\n        </MultiSelectFilters>\n      </FiltersSearch>\n    </template>\n\n    <template #category=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n      <Filters v-slot=\"{ filter }\" :filters=\"facet.filters\">\n        <HierarchicalFilter :filter=\"filter\" />\n      </Filters>\n    </template>\n\n    <template #price=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n      <Filters v-slot=\"{ filter }\" :filters=\"facet.filters\">\n        <NumberRangeFilter :filter=\"filter\">\n          <BasePriceFilterLabel :filter=\"filter\" />\n        </NumberRangeFilter>\n      </Filters>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import {\n    Facets,\n    Filters,\n    FiltersSearch,\n    HierarchicalFilter,\n    MultiSelectFilters,\n    NumberRangeFilter,\n    SimpleFilter\n  } from '@empathyco/x-components/facets';\n\n  import { BasePriceFilterLabel } from '@empathyco/x-components';\n\n  export default {\n    components: {\n      Facets,\n      MultiSelectFilters,\n      FiltersSearch,\n      SimpleFilter,\n      Filters,\n      HierarchicalFilter,\n      NumberRangeFilter,\n      BasePriceFilterLabel\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["animation","_openBlock","_createBlock","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","hasSlot","_createCommentVNode","_renderSlot","_mergeProps","selectedFiltersByFacet"],"mappings":";;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EADF,MACkBA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;AADlB,EAAA,OAAA,IAAA,CAAA,SAAA,IAAAC,SAAA,EACmE,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IAAC,GAAA,EAAA,CAAA;AAAA,IAAmB,KAAI,EAAA,eAAA;AAAA,IAAA,WAAA,EAAA,QAAA;AAD3F,IAAA,GAAA,EAAA,IAAA;AAAA,GAAA,EAAA;;iBAIY,IAAO,CAAA,EAAAC,kBAAA;AAAA,QAAAC,QAAA;AAAA,QAAA,IAAA;AAAA,QAAAC,UAAA,CAAA,IAAA,CAAA,YAAA,EAAA,CAAA,EAAA,KAAA,EAAA,YAAA,EAAA,mBAAA,EAAA,EAAA,OAAA,KAAA;AACR,UAAA,OAAAL,SAAA,EAAsB,EAAAG,kBAAA,CAAA,IAAA,EAAA;AAAA,YAC3B,GAAA,EAAA,OAAA;AAAA,YAAA,KAAA,EAAA,qBAAA;AAEA,YAAA,WAAA,EAAA,cAAA;AAAA,WAOQG,EAAAA;AAAAA,YAMNC,kBAAA,CAAA,2TAAA,CAAA;AAAA,YArBR,IAAA,CAAA,OAAA,CAAA,YAAA,CAAA,GAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,YAAA,EAAAC,UAAA,CAAA;AAAA,cAAA,GAAA,EAAA,CAAA;AAgBiC,cAAA,OAAA,EAAA,IAAA;AAAA,aAAA,EAAA;;AAadH,cAAAA,eAAAA,EAAAA,IAAAA,CAAQ,sBAAmB,CAAA,OAAA,CAAA,IAAA,EAAA;AAAA,aAAA,CAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA,GAAA,IAAA,CAPxC,2CAaE,EAAAH,kBAAA;AAAA,cADOC,QAAA;AAAA,cAAmB,EAN5B,GAAA,EAAA,CAAA,EAAA;AAAA,cAAA;AAAA,gBAE2BG,kBAAA,CAAA,gUAAA,CAAA;AAAA,gBAAAC,UAAA,CAA6BE,IAA8B,CAAA,MAAA,EAAA,mBAAA,EAAAD,UAAA,CAAA,EAAA,OAAA,EAAA,IAAA,EAAA,EAAA;AAAA,kBAAA,KAAA;;;;AAMtF,cAAA,IAAA;AAAA;AAAA,aAAA,KAAAT,SAAA,EAcO,EAAAG,kBAAA;AAAA,cAAAC,QAAA;AAAA,cARP,EA1CN,GAAA,EAAA,CAAA,EAAA;AAAA,cAAA;AAAA,gBA4CiCG,kBAAA,CAAA,+TAAA,CAAA;AAAA,gBAAAC,UAAA,CAA6BE,wBAAuBD,UAAO,CAAA,EAAA,OAAA,EAAA,IAAA,EAAA,EAAA;AAAA,kBAAA,KAAA;AA5C5F,kBAAA,eAAA,EAAA,IAAA,CAAA,sBAAA,CAgDO,OACa,CAAA,IAAA,EAAA;AAAA,iBAAA,CAAA,EAAA,MAAA;;;;;;;;;;;;AAjDpB,SAAA,CAAA;AAAA,QAAA,GAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;AAAA,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,CAAA,IAAAF,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}

package/js/x-modules/facets/components/facets/facets.vue2.js

@@ -1,10 +1,10 @@
 import { map, objectFilter } from '@empathyco/x-utils';
 import { defineComponent, computed } from 'vue';
 import { useGetter } from '../../../../composables/use-getter.js';
-import { animationProp } from '../../../../utils/options-api.js';
 import { toKebabCase } from '../../../../utils/string.js';
 import { useFacets } from '../../composables/use-facets.js';
 import { facetsXModule } from '../../x-module.js';
+import { AnimationProp } from '../../../../types/animation-prop.js';
 
 /**
  * This component renders the list of facets stored in the Facets module. Facets can be rendered
@@ -25,7 +25,7 @@ var _sfc_main = defineComponent({
         alwaysVisible: Boolean,
         /** Animation component that will be used to animate the facets. */
         animation: {
-            type: animationProp,
+            type: AnimationProp,
             default: 'ul'
         },
         /**

package/js/x-modules/facets/components/facets/facets.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"facets.vue2.js","sources":["../../../../../../src/x-modules/facets/components/facets/facets.vue"],"sourcesContent":["<template>\n  <component :is=\"animation\" v-if=\"hasFacets\" class=\"x-facets-list\" data-test=\"facets\" tag=\"ul\">\n    <li\n      v-for=\"({ facet, slotNameById, slotNameByModelName }, facetId) in mappedFacets\"\n      :key=\"facetId\"\n      class=\"x-facets-list__item\"\n      data-test=\"facets-facet\"\n    >\n      <!--\n        @slot Customized Facet rendering. Specifying a slot with the facet's name will result in the\n        facet using that slot composition to render.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-if=\"hasSlot(slotNameById)\"\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n        :name=\"slotNameById\"\n      />\n      <!--\n        @slot Customized Facet rendering. Specifying a slot with the facet's modelName will result\n        in the facet using that slot composition to render.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-else-if=\"hasSlot(slotNameByModelName)\"\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n        :name=\"slotNameByModelName\"\n      />\n      <!--\n        @slot (required) Default Facet rendering. This slot will be used by default for rendering\n        the facets without an specific slot implementation.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-else\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n      >\n        This is the {{ facet.label }} facet. Pass something into its slot to display content.\n      </slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { Facet } from '@empathyco/x-types';\n  import { Dictionary, map, objectFilter } from '@empathyco/x-utils';\n  import { computed, ComputedRef, defineComponent, PropType } from 'vue';\n  import { useGetter } from '../../../../composables/use-getter';\n  import { animationProp } from '../../../../utils/options-api';\n  import { toKebabCase } from '../../../../utils/string';\n  import { useFacets } from '../../composables/use-facets';\n  import { facetsXModule } from '../../x-module';\n\n  /**\n   * Custom interface to provide a slot name to a Facet.\n   *\n   * @internal\n   */\n  interface RenderFacet {\n    slotNameById: string;\n    slotNameByModelName: string;\n    facet: Facet;\n  }\n\n  /**\n   * This component renders the list of facets stored in the Facets module. Facets can be rendered\n   * differently based on their purpose and this can be achieved using the exposed slots:\n   * - A default and required slot.\n   * - A custom slot for each facet with the facetId as its name. This allows each facet to be\n   * rendered differently based on its needs.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'Facets',\n    xModule: facetsXModule.name,\n    props: {\n      /** Array of facets ids used to get the selected filters for those facets. */\n      facetsIds: Array as PropType<Array<Facet['id']>>,\n      /** Flag to render the component even if there are no filters selected. */\n      alwaysVisible: Boolean,\n      /** Animation component that will be used to animate the facets. */\n      animation: {\n        type: animationProp,\n        default: 'ul'\n      },\n      /**\n       * Discriminates the facets rendered by this component. It expects a string containing facets\n       * ids, comma separated. This property will include or exclude facets based on its value.\n       * The default value is an empty string and the component will render all existing facets.\n       *\n       * @remarks\n       * To behave as a `include`, simply set the facets ids, comma separated:\n       * `existingFacets=[{ brand: ... }, category: { ... }, color: { ... }, price: { ... }]`\n       * `renderableFacets=\"brand, category\"`\n       *\n       * The component will render brand and category facets.\n       *\n       * On the other hand, to simulate an `exclude` behaviour and exclude a facet from being\n       * rendered, append a '!' before its id:\n       * `existingFacets=[{ brand: ... }, category: { ... }, color: { ... }, price: { ... }]`\n       * `renderableFacets=\"!brand,!price\"`\n       *\n       * The component will render category and color facets.\n       */\n      renderableFacets: String\n    },\n    setup: function (props, { slots }) {\n      const { selectedFiltersByFacet } = useFacets(props);\n\n      const { facets } = useGetter('facets', ['facets']) as {\n        /** Dictionary of facets in the state. */\n        facets: ComputedRef<Record<Facet['id'], Facet>>;\n      };\n\n      /**\n       * The facets to be rendered after filtering {@link Facets.facets} by\n       * {@link Facets.renderableFacets} content.\n       *\n       * @returns The list of facets to be rendered.\n       */\n      const facetsToRender = computed<Dictionary<Facet>>(() => {\n        if (!props.renderableFacets) {\n          return facets.value;\n        } else {\n          const excludedRegExp = /^!/;\n          const facetIds: string[] = props.renderableFacets\n            .split(',')\n            .map(facetId => facetId.trim());\n          const included: string[] = [];\n          const excluded: string[] = [];\n          facetIds.forEach(facetId => {\n            if (excludedRegExp.test(facetId)) {\n              excluded.push(facetId.replace(excludedRegExp, ''));\n            } else {\n              included.push(facetId);\n            }\n          });\n\n          return filterFacetsToRender(included, excluded);\n        }\n      });\n\n      /**\n       * Transforms a dictionary of Facets including the slot name.\n       *\n       * @returns A dictionary of facets with the slot name.\n       */\n      const mappedFacets = computed<Dictionary<RenderFacet>>(() => {\n        return map(facetsToRender.value, (facetId, facet) => ({\n          slotNameById: toKebabCase(facetId),\n          slotNameByModelName: toKebabCase(facet.modelName),\n          facet\n        }));\n      });\n\n      /**\n       * Indicates if there are facets available to show.\n       *\n       * @returns True if there are facets available and false otherwise.\n       */\n      const hasFacets = computed<boolean>(() => !!Object.keys(facetsToRender.value).length);\n\n      /**\n       * Filter facets dictionary retrieving those included and/or removing excluded.\n       *\n       * @param included - List of facets to render.\n       * @param excluded - List of not renderable facets.\n       *\n       * @returns The filtered list of facets to render.\n       */\n      function filterFacetsToRender(included: string[], excluded: string[]): Dictionary<Facet> {\n        const hasAnyFacetIncluded = included.length > 0;\n        return objectFilter(facets.value, facetKey => {\n          const isIncluded = included.includes(String(facetKey));\n          const isExcluded = excluded.includes(String(facetKey));\n\n          return hasAnyFacetIncluded ? isIncluded && !isExcluded : !isExcluded;\n        });\n      }\n\n      /**\n       * Whether the slot is present in the template or not.\n       *\n       * @param name - The slot name.\n       *\n       * @returns True is the slot is present in the template. False otherwise.\n       */\n      function hasSlot(name: string): boolean {\n        return !!slots[name];\n      }\n\n      return {\n        selectedFiltersByFacet,\n        hasFacets,\n        mappedFacets,\n        hasSlot\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-facets-list {\n    display: flex;\n    flex-flow: column nowrap;\n    list-style-type: none;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Example\n\nThis component renders the list of facets stored in the Facets module. Facets can be rendered\ndifferently based on their purpose and this can be achieved using the exposed slots:\n\n- A default and required slot.\n- A custom slot for each facet with the facetId as its name. This allows each facet to be rendered\n  differently based on its needs.\n\nBelow, there are some examples showing how to use the component with its different configurations.\n\n### Default usage\n\nThe default slot of this component is mandatory. If no other slot is defined, every Facet will be\nrendered as specified in the default slot.\n\n```vue\n<template>\n  <Facets>\n    <template #default=\"{ facet, selectedFilters }\">\n      <h1>{{ ${facet.label} }}</h1>\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} selected` }}</span>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Customized usage\n\nCustomized compositions for a specific Facet can be achieved by using a slot with the same id as the\nfacet to customize. For example, the Facet with the id \"color\" requires a composition that differs\nfrom the rest of the Facets. Doing it in a slot with the name \"color\" will apply this customization\njust to the \"color\" Facet. The other facets will fallback to the composition of the default slot.\n\nIt is also possible to customize the Facet content by the facet \"model name\". For example, to\nconfigure different content for \"Hierarchical Facets\" the \"hierarchical-facet\" slot will apply that\ncustomization. This can be combined with the facets by facet id. If some hierarchical facet needs\nsome different customization from the rest of the hierarchical, it can be achieve using the slot\nwith the facet id.\n\n```vue\n<template>\n  <Facets>\n    <template #color=\"{ facet, selectedFilters }\">\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} colors chosen` }}</span>\n\n      <ul v-for=\"filter in facet.filters\" :key=\"filter.id\">\n        <li v-if=\"!filter.selected\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n\n    <template #hierarchical-facet=\"{ facet, selectedFilters }\">\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} colors chosen` }}</span>\n\n      <ul v-for=\"filter in facet.filters\" :key=\"filter.id\">\n        <li v-if=\"!filter.selected\">\n          {{ filter.label }}\n          <ul v-for=\"childFilter in filter.children\" :key=\"filter.id\">\n            <li v-if=\"!childFilter.selected\">\n              {{ childFilter.label }}\n            </li>\n          </ul>\n        </li>\n      </ul>\n    </template>\n\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Render specific facets I\n\nBy default, this component will render all existing facets. However, it has the renderableFacets\nprop to filter which facets will be rendered. Its value is a string containing the different facets\nids. This value is treated as an include or exclude list (to exclude a facet from being rendered,\njust prefix its id with a `!`). The component will only render included facets and discard excluded\nones. In the following example, the component will only render color and category facets.\n\n```vue\n<template>\n  <Facets renderableFacets=\"color, category\">\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Render specific facets II\n\nExclude facets so the component does not render them. In the following example, the component will\nrender every facet except color and price.\n\n```vue\n<template>\n  <Facets renderableFacets=\"!color, !price\">\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Integrating with the filters components\n\nThere are many components that will help you build your own awesome filters list. `Facets` just\nrenders the list, but what to render for each facet is up to you. Below you can see an example. of\nthe `Facets` component using the `FiltersSearch` `MultiSelectFilters`, `SimpleFilter`, `Filters`,\n`HierarchicalFilter`, `NumberRangeFilter` and `BasePriceFilterLabel`.\n\n```vue\n<template>\n  <Facets>\n    <template #default=\"{ facet, selectedFilters }\">\n      <h1>{{ facet.label }}</h1>\n      <FiltersSearch :filters=\"facet.filters\">\n        <MultiSelectFilters v-slot=\"{ filter }\">\n          <SimpleFilter :filter=\"filter\" />\n        </MultiSelectFilters>\n      </FiltersSearch>\n    </template>\n\n    <template #category=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n      <Filters v-slot=\"{ filter }\" :filters=\"facet.filters\">\n        <HierarchicalFilter :filter=\"filter\" />\n      </Filters>\n    </template>\n\n    <template #price=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n      <Filters v-slot=\"{ filter }\" :filters=\"facet.filters\">\n        <NumberRangeFilter :filter=\"filter\">\n          <BasePriceFilterLabel :filter=\"filter\" />\n        </NumberRangeFilter>\n      </Filters>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import {\n    Facets,\n    Filters,\n    FiltersSearch,\n    HierarchicalFilter,\n    MultiSelectFilters,\n    NumberRangeFilter,\n    SimpleFilter\n  } from '@empathyco/x-components/facets';\n\n  import { BasePriceFilterLabel } from '@empathyco/x-components';\n\n  export default {\n    components: {\n      Facets,\n      MultiSelectFilters,\n      FiltersSearch,\n      SimpleFilter,\n      Filters,\n      HierarchicalFilter,\n      NumberRangeFilter,\n      BasePriceFilterLabel\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;;AA4EE;;;;;;;;AAQE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,aAAa,CAAC,IAAI;AAC3B,IAAA,KAAK,EAAE;;AAEL,QAAA,SAAS,EAAE,KAAqC;;AAEhD,QAAA,aAAa,EAAE,OAAO;;AAEtB,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,IAAG;AACb,SAAA;AACD;;;;;;;;;;;;;;;;;;AAkBE;AACF,QAAA,gBAAgB,EAAE,MAAK;AACxB,KAAA;AACD,IAAA,KAAK,EAAE,UAAU,KAAK,EAAE,EAAE,KAAM,EAAC,EAAA;QAC/B,MAAM,EAAE,sBAAuB,EAAA,GAAI,SAAS,CAAC,KAAK,CAAC,CAAA;AAEnD,QAAA,MAAM,EAAE,QAAS,GAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAGhD,CAAA;AAED;;;;;AAKE;AACF,QAAA,MAAM,cAAa,GAAI,QAAQ,CAAoB,MAAM;AACvD,YAAA,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE;gBAC3B,OAAO,MAAM,CAAC,KAAK,CAAA;AACnB,aAAA;AAAK,iBAAA;gBACL,MAAM,iBAAiB,IAAI,CAAA;AAC3B,gBAAA,MAAM,QAAQ,GAAa,KAAK,CAAC,gBAAe;qBAC7C,KAAK,CAAC,GAAG,CAAA;qBACT,GAAG,CAAC,OAAM,IAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;gBACjC,MAAM,QAAQ,GAAa,EAAE,CAAA;gBAC7B,MAAM,QAAQ,GAAa,EAAE,CAAA;AAC7B,gBAAA,QAAQ,CAAC,OAAO,CAAC,OAAQ,IAAG;AAC1B,oBAAA,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;AAChC,wBAAA,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,CAAA;AAClD,qBAAA;AAAK,yBAAA;AACL,wBAAA,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACxB,qBAAA;AACF,iBAAC,CAAC,CAAA;AAEF,gBAAA,OAAO,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AACjD,aAAA;AACF,SAAC,CAAC,CAAA;AAEF;;;;AAIE;AACF,QAAA,MAAM,YAAa,GAAE,QAAQ,CAA0B,MAAM;AAC3D,YAAA,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,MAAM;AACpD,gBAAA,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC;AAClC,gBAAA,mBAAmB,EAAE,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC;gBACjD,KAAI;AACL,aAAA,CAAC,CAAC,CAAA;AACL,SAAC,CAAC,CAAA;AAEF;;;;AAIE;QACF,MAAM,SAAQ,GAAI,QAAQ,CAAU,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAA;AAErF;;;;;;;AAOE;AACF,QAAA,SAAS,oBAAoB,CAAC,QAAkB,EAAE,QAAkB,EAAA;AAClE,YAAA,MAAM,sBAAsB,QAAQ,CAAC,MAAK,GAAI,CAAC,CAAA;YAC/C,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,QAAO,IAAK;gBAC5C,MAAM,UAAS,GAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;gBACtD,MAAM,UAAS,GAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEtD,gBAAA,OAAO,mBAAoB,GAAE,UAAS,IAAK,CAAC,UAAW,GAAE,CAAC,UAAU,CAAA;AACtE,aAAC,CAAC,CAAA;SACJ;AAEA;;;;;;AAME;QACF,SAAS,OAAO,CAAC,IAAY,EAAA;AAC3B,YAAA,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;SACtB;QAEA,OAAO;YACL,sBAAsB;YACtB,SAAS;YACT,YAAY;YACZ,OAAM;SACP,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"facets.vue2.js","sources":["../../../../../../src/x-modules/facets/components/facets/facets.vue"],"sourcesContent":["<template>\n  <component :is=\"animation\" v-if=\"hasFacets\" class=\"x-facets-list\" data-test=\"facets\" tag=\"ul\">\n    <li\n      v-for=\"({ facet, slotNameById, slotNameByModelName }, facetId) in mappedFacets\"\n      :key=\"facetId\"\n      class=\"x-facets-list__item\"\n      data-test=\"facets-facet\"\n    >\n      <!--\n        @slot Customized Facet rendering. Specifying a slot with the facet's name will result in the\n        facet using that slot composition to render.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-if=\"hasSlot(slotNameById)\"\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n        :name=\"slotNameById\"\n      />\n      <!--\n        @slot Customized Facet rendering. Specifying a slot with the facet's modelName will result\n        in the facet using that slot composition to render.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-else-if=\"hasSlot(slotNameByModelName)\"\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n        :name=\"slotNameByModelName\"\n      />\n      <!--\n        @slot (required) Default Facet rendering. This slot will be used by default for rendering\n        the facets without an specific slot implementation.\n            @binding {Facet} facet - Facet to render\n            @binding {Filter[]} selectedFilters - List of selected filters of the given facet\n      -->\n      <slot\n        v-else\n        v-bind=\"{\n          facet,\n          selectedFilters: selectedFiltersByFacet[facetId] || []\n        }\"\n      >\n        This is the {{ facet.label }} facet. Pass something into its slot to display content.\n      </slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { Facet } from '@empathyco/x-types';\n  import { Dictionary, map, objectFilter } from '@empathyco/x-utils';\n  import { computed, ComputedRef, defineComponent, PropType } from 'vue';\n  import { useGetter } from '../../../../composables/use-getter';\n  import { toKebabCase } from '../../../../utils/string';\n  import { useFacets } from '../../composables/use-facets';\n  import { facetsXModule } from '../../x-module';\n  import { AnimationProp } from '../../../../types';\n\n  /**\n   * Custom interface to provide a slot name to a Facet.\n   *\n   * @internal\n   */\n  interface RenderFacet {\n    slotNameById: string;\n    slotNameByModelName: string;\n    facet: Facet;\n  }\n\n  /**\n   * This component renders the list of facets stored in the Facets module. Facets can be rendered\n   * differently based on their purpose and this can be achieved using the exposed slots:\n   * - A default and required slot.\n   * - A custom slot for each facet with the facetId as its name. This allows each facet to be\n   * rendered differently based on its needs.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'Facets',\n    xModule: facetsXModule.name,\n    props: {\n      /** Array of facets ids used to get the selected filters for those facets. */\n      facetsIds: Array as PropType<Array<Facet['id']>>,\n      /** Flag to render the component even if there are no filters selected. */\n      alwaysVisible: Boolean,\n      /** Animation component that will be used to animate the facets. */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      },\n      /**\n       * Discriminates the facets rendered by this component. It expects a string containing facets\n       * ids, comma separated. This property will include or exclude facets based on its value.\n       * The default value is an empty string and the component will render all existing facets.\n       *\n       * @remarks\n       * To behave as a `include`, simply set the facets ids, comma separated:\n       * `existingFacets=[{ brand: ... }, category: { ... }, color: { ... }, price: { ... }]`\n       * `renderableFacets=\"brand, category\"`\n       *\n       * The component will render brand and category facets.\n       *\n       * On the other hand, to simulate an `exclude` behaviour and exclude a facet from being\n       * rendered, append a '!' before its id:\n       * `existingFacets=[{ brand: ... }, category: { ... }, color: { ... }, price: { ... }]`\n       * `renderableFacets=\"!brand,!price\"`\n       *\n       * The component will render category and color facets.\n       */\n      renderableFacets: String\n    },\n    setup: function (props, { slots }) {\n      const { selectedFiltersByFacet } = useFacets(props);\n\n      const { facets } = useGetter('facets', ['facets']) as {\n        /** Dictionary of facets in the state. */\n        facets: ComputedRef<Record<Facet['id'], Facet>>;\n      };\n\n      /**\n       * The facets to be rendered after filtering {@link Facets.facets} by\n       * {@link Facets.renderableFacets} content.\n       *\n       * @returns The list of facets to be rendered.\n       */\n      const facetsToRender = computed<Dictionary<Facet>>(() => {\n        if (!props.renderableFacets) {\n          return facets.value;\n        } else {\n          const excludedRegExp = /^!/;\n          const facetIds: string[] = props.renderableFacets\n            .split(',')\n            .map(facetId => facetId.trim());\n          const included: string[] = [];\n          const excluded: string[] = [];\n          facetIds.forEach(facetId => {\n            if (excludedRegExp.test(facetId)) {\n              excluded.push(facetId.replace(excludedRegExp, ''));\n            } else {\n              included.push(facetId);\n            }\n          });\n\n          return filterFacetsToRender(included, excluded);\n        }\n      });\n\n      /**\n       * Transforms a dictionary of Facets including the slot name.\n       *\n       * @returns A dictionary of facets with the slot name.\n       */\n      const mappedFacets = computed<Dictionary<RenderFacet>>(() => {\n        return map(facetsToRender.value, (facetId, facet) => ({\n          slotNameById: toKebabCase(facetId),\n          slotNameByModelName: toKebabCase(facet.modelName),\n          facet\n        }));\n      });\n\n      /**\n       * Indicates if there are facets available to show.\n       *\n       * @returns True if there are facets available and false otherwise.\n       */\n      const hasFacets = computed<boolean>(() => !!Object.keys(facetsToRender.value).length);\n\n      /**\n       * Filter facets dictionary retrieving those included and/or removing excluded.\n       *\n       * @param included - List of facets to render.\n       * @param excluded - List of not renderable facets.\n       *\n       * @returns The filtered list of facets to render.\n       */\n      function filterFacetsToRender(included: string[], excluded: string[]): Dictionary<Facet> {\n        const hasAnyFacetIncluded = included.length > 0;\n        return objectFilter(facets.value, facetKey => {\n          const isIncluded = included.includes(String(facetKey));\n          const isExcluded = excluded.includes(String(facetKey));\n\n          return hasAnyFacetIncluded ? isIncluded && !isExcluded : !isExcluded;\n        });\n      }\n\n      /**\n       * Whether the slot is present in the template or not.\n       *\n       * @param name - The slot name.\n       *\n       * @returns True is the slot is present in the template. False otherwise.\n       */\n      function hasSlot(name: string): boolean {\n        return !!slots[name];\n      }\n\n      return {\n        selectedFiltersByFacet,\n        hasFacets,\n        mappedFacets,\n        hasSlot\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-facets-list {\n    display: flex;\n    flex-flow: column nowrap;\n    list-style-type: none;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Example\n\nThis component renders the list of facets stored in the Facets module. Facets can be rendered\ndifferently based on their purpose and this can be achieved using the exposed slots:\n\n- A default and required slot.\n- A custom slot for each facet with the facetId as its name. This allows each facet to be rendered\n  differently based on its needs.\n\nBelow, there are some examples showing how to use the component with its different configurations.\n\n### Default usage\n\nThe default slot of this component is mandatory. If no other slot is defined, every Facet will be\nrendered as specified in the default slot.\n\n```vue\n<template>\n  <Facets>\n    <template #default=\"{ facet, selectedFilters }\">\n      <h1>{{ ${facet.label} }}</h1>\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} selected` }}</span>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Customized usage\n\nCustomized compositions for a specific Facet can be achieved by using a slot with the same id as the\nfacet to customize. For example, the Facet with the id \"color\" requires a composition that differs\nfrom the rest of the Facets. Doing it in a slot with the name \"color\" will apply this customization\njust to the \"color\" Facet. The other facets will fallback to the composition of the default slot.\n\nIt is also possible to customize the Facet content by the facet \"model name\". For example, to\nconfigure different content for \"Hierarchical Facets\" the \"hierarchical-facet\" slot will apply that\ncustomization. This can be combined with the facets by facet id. If some hierarchical facet needs\nsome different customization from the rest of the hierarchical, it can be achieve using the slot\nwith the facet id.\n\n```vue\n<template>\n  <Facets>\n    <template #color=\"{ facet, selectedFilters }\">\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} colors chosen` }}</span>\n\n      <ul v-for=\"filter in facet.filters\" :key=\"filter.id\">\n        <li v-if=\"!filter.selected\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n\n    <template #hierarchical-facet=\"{ facet, selectedFilters }\">\n      <span v-if=\"selectedFilters.length > 0\">{{ `${selectedFilters.length} colors chosen` }}</span>\n\n      <ul v-for=\"filter in facet.filters\" :key=\"filter.id\">\n        <li v-if=\"!filter.selected\">\n          {{ filter.label }}\n          <ul v-for=\"childFilter in filter.children\" :key=\"filter.id\">\n            <li v-if=\"!childFilter.selected\">\n              {{ childFilter.label }}\n            </li>\n          </ul>\n        </li>\n      </ul>\n    </template>\n\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Render specific facets I\n\nBy default, this component will render all existing facets. However, it has the renderableFacets\nprop to filter which facets will be rendered. Its value is a string containing the different facets\nids. This value is treated as an include or exclude list (to exclude a facet from being rendered,\njust prefix its id with a `!`). The component will only render included facets and discard excluded\nones. In the following example, the component will only render color and category facets.\n\n```vue\n<template>\n  <Facets renderableFacets=\"color, category\">\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Render specific facets II\n\nExclude facets so the component does not render them. In the following example, the component will\nrender every facet except color and price.\n\n```vue\n<template>\n  <Facets renderableFacets=\"!color, !price\">\n    <template #default=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n\n      <ul>\n        <li v-for=\"filter in facet.filters\" :key=\"filter.id\">\n          {{ filter.label }}\n        </li>\n      </ul>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import { Facets } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      Facets\n    }\n  };\n</script>\n```\n\n### Integrating with the filters components\n\nThere are many components that will help you build your own awesome filters list. `Facets` just\nrenders the list, but what to render for each facet is up to you. Below you can see an example. of\nthe `Facets` component using the `FiltersSearch` `MultiSelectFilters`, `SimpleFilter`, `Filters`,\n`HierarchicalFilter`, `NumberRangeFilter` and `BasePriceFilterLabel`.\n\n```vue\n<template>\n  <Facets>\n    <template #default=\"{ facet, selectedFilters }\">\n      <h1>{{ facet.label }}</h1>\n      <FiltersSearch :filters=\"facet.filters\">\n        <MultiSelectFilters v-slot=\"{ filter }\">\n          <SimpleFilter :filter=\"filter\" />\n        </MultiSelectFilters>\n      </FiltersSearch>\n    </template>\n\n    <template #category=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n      <Filters v-slot=\"{ filter }\" :filters=\"facet.filters\">\n        <HierarchicalFilter :filter=\"filter\" />\n      </Filters>\n    </template>\n\n    <template #price=\"{ facet }\">\n      <h1>{{ facet.label }}</h1>\n      <Filters v-slot=\"{ filter }\" :filters=\"facet.filters\">\n        <NumberRangeFilter :filter=\"filter\">\n          <BasePriceFilterLabel :filter=\"filter\" />\n        </NumberRangeFilter>\n      </Filters>\n    </template>\n  </Facets>\n</template>\n\n<script>\n  import {\n    Facets,\n    Filters,\n    FiltersSearch,\n    HierarchicalFilter,\n    MultiSelectFilters,\n    NumberRangeFilter,\n    SimpleFilter\n  } from '@empathyco/x-components/facets';\n\n  import { BasePriceFilterLabel } from '@empathyco/x-components';\n\n  export default {\n    components: {\n      Facets,\n      MultiSelectFilters,\n      FiltersSearch,\n      SimpleFilter,\n      Filters,\n      HierarchicalFilter,\n      NumberRangeFilter,\n      BasePriceFilterLabel\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;;AA4EE;;;;;;;;AAQE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,aAAa,CAAC,IAAI;AAC3B,IAAA,KAAK,EAAE;;AAEL,QAAA,SAAS,EAAE,KAAqC;;AAEhD,QAAA,aAAa,EAAE,OAAO;;AAEtB,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,IAAG;AACb,SAAA;AACD;;;;;;;;;;;;;;;;;;AAkBE;AACF,QAAA,gBAAgB,EAAE,MAAK;AACxB,KAAA;AACD,IAAA,KAAK,EAAE,UAAU,KAAK,EAAE,EAAE,KAAM,EAAC,EAAA;QAC/B,MAAM,EAAE,sBAAuB,EAAA,GAAI,SAAS,CAAC,KAAK,CAAC,CAAA;AAEnD,QAAA,MAAM,EAAE,QAAS,GAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAGhD,CAAA;AAED;;;;;AAKE;AACF,QAAA,MAAM,cAAa,GAAI,QAAQ,CAAoB,MAAM;AACvD,YAAA,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE;gBAC3B,OAAO,MAAM,CAAC,KAAK,CAAA;AACnB,aAAA;AAAK,iBAAA;gBACL,MAAM,iBAAiB,IAAI,CAAA;AAC3B,gBAAA,MAAM,QAAQ,GAAa,KAAK,CAAC,gBAAe;qBAC7C,KAAK,CAAC,GAAG,CAAA;qBACT,GAAG,CAAC,OAAM,IAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;gBACjC,MAAM,QAAQ,GAAa,EAAE,CAAA;gBAC7B,MAAM,QAAQ,GAAa,EAAE,CAAA;AAC7B,gBAAA,QAAQ,CAAC,OAAO,CAAC,OAAQ,IAAG;AAC1B,oBAAA,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;AAChC,wBAAA,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,CAAA;AAClD,qBAAA;AAAK,yBAAA;AACL,wBAAA,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACxB,qBAAA;AACF,iBAAC,CAAC,CAAA;AAEF,gBAAA,OAAO,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AACjD,aAAA;AACF,SAAC,CAAC,CAAA;AAEF;;;;AAIE;AACF,QAAA,MAAM,YAAa,GAAE,QAAQ,CAA0B,MAAM;AAC3D,YAAA,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,MAAM;AACpD,gBAAA,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC;AAClC,gBAAA,mBAAmB,EAAE,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC;gBACjD,KAAI;AACL,aAAA,CAAC,CAAC,CAAA;AACL,SAAC,CAAC,CAAA;AAEF;;;;AAIE;QACF,MAAM,SAAQ,GAAI,QAAQ,CAAU,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAA;AAErF;;;;;;;AAOE;AACF,QAAA,SAAS,oBAAoB,CAAC,QAAkB,EAAE,QAAkB,EAAA;AAClE,YAAA,MAAM,sBAAsB,QAAQ,CAAC,MAAK,GAAI,CAAC,CAAA;YAC/C,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,QAAO,IAAK;gBAC5C,MAAM,UAAS,GAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;gBACtD,MAAM,UAAS,GAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEtD,gBAAA,OAAO,mBAAoB,GAAE,UAAS,IAAK,CAAC,UAAW,GAAE,CAAC,UAAU,CAAA;AACtE,aAAC,CAAC,CAAA;SACJ;AAEA;;;;;;AAME;QACF,SAAS,OAAO,CAAC,IAAY,EAAA;AAC3B,YAAA,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;SACtB;QAEA,OAAO;YACL,sBAAsB;YACtB,SAAS;YACT,YAAY;YACZ,OAAM;SACP,CAAA;KACH;AACD,CAAA,CAAC;;;;"}

package/js/x-modules/facets/components/lists/selected-filters-list.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"selected-filters-list.vue.js","sources":["../../../../../../src/x-modules/facets/components/lists/selected-filters-list.vue"],"sourcesContent":["<template>\n  <SelectedFilters\n    v-slot=\"{ selectedFilters }\"\n    :facetsIds=\"facetsIds\"\n    :alwaysVisible=\"alwaysVisible\"\n  >\n    <component\n      :is=\"animation\"\n      class=\"x-selected-filters-list\"\n      data-test=\"selected-filters-list\"\n      tag=\"ul\"\n    >\n      <li\n        v-for=\"{ slotName, selectedFilter } in mapSlot(selectedFilters)\"\n        :key=\"selectedFilter.id\"\n        class=\"x-selected-filters-list__item\"\n        data-test=\"selected-filters-list-item\"\n      >\n        <!--\n          @slot Custom filter rendering. Dynamic slot defined in the template with the filter\n          facet id. It renders the filter label by default.\n              @binding {Filter} filter - Filter to render.\n        -->\n        <slot v-if=\"hasSlot(slotName)\" :name=\"slotName\" :filter=\"selectedFilter\">\n          <span class=\"x-tag\">{{ selectedFilter.label }}</span>\n        </slot>\n\n        <!--\n          @slot Default filter rendering. It renders the filter label by default.\n              @binding {Filter} filter - Filter to render.\n        -->\n        <slot v-else name=\"default\" :filter=\"selectedFilter\">\n          {{ selectedFilter.label }}\n        </slot>\n      </li>\n    </component>\n  </SelectedFilters>\n</template>\n\n<script lang=\"ts\">\n  import { Facet, Filter, isFacetFilter } from '@empathyco/x-types';\n  import { defineComponent, PropType } from 'vue';\n  import { animationProp } from '../../../../utils/options-api';\n  import { toKebabCase } from '../../../../utils/string';\n  import { useFacets } from '../../composables/use-facets';\n  import { facetsXModule } from '../../x-module';\n  import SelectedFilters from './selected-filters.vue';\n\n  /**\n   * Custom interface to provide a slot name to a Filter.\n   *\n   * @internal\n   */\n  interface RenderFilter {\n    slotName: string;\n    selectedFilter: Filter;\n  }\n\n  /**\n   * This component renders a list of selected filters from every facet, or from the facet\n   * ids passed as property. It uses the SelectedFilters component (state).\n   *\n   * It provides two slots: a scoped one which name is the filter facet id; and a default one.\n   * Both exposes the filter and renders the filter label by default.\n   *\n   * The property \"alwaysVisible\" handles if the component is rendered if no filters are selected.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SelectedFiltersList',\n    xModule: facetsXModule.name,\n    components: { SelectedFilters },\n    props: {\n      /** Array of facets ids used to get the selected filters for those facets. */\n      facetsIds: Array as PropType<Array<Facet['id']>>,\n      /** Flag to render the component even if there are no filters selected. */\n      alwaysVisible: Boolean,\n      /** Animation component that will be used to animate the selected filters list. */\n      animation: {\n        type: animationProp,\n        default: 'ul'\n      }\n    },\n    setup: function (props, { slots }) {\n      const { selectedFilters } = useFacets(props);\n\n      /**\n       * Transforms a dictionary of Filters including the slot name.\n       *\n       * @param selectedFilters - A list of selected filters without slot name.\n       *\n       * @returns A dictionary of facets with the slot name.\n       */\n      function mapSlot(selectedFilters: Filter[]): RenderFilter[] {\n        return selectedFilters.map(filter => ({\n          slotName: isFacetFilter(filter) ? toKebabCase(filter.facetId as string) : 'default',\n          selectedFilter: filter\n        }));\n      }\n\n      /**\n       * Whether the slot is present in the template or not.\n       *\n       * @param name - The slot name.\n       *\n       * @returns True is the slot is present in the template. False otherwise.\n       */\n      function hasSlot(name: string): boolean {\n        return !!slots[name];\n      }\n\n      return {\n        selectedFilters,\n        mapSlot,\n        hasSlot\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Example\n\nThis component renders a list of selected filters from every facet, or from the facets which facets\nids are passed as property. It uses the SelectedFilters component (state).\n\nIt provides two slots: a scoped one which name is the filter facet id; and a default one. Both\nexposes the filter and renders the filter label by default.\n\nThe property \"alwaysVisible\" handles if the component is rendered if no filters are selected.\n\n### Default usage\n\n```vue\n<template>\n  <SelectedFiltersList />\n</template>\n\n<script>\n  import { SelectedFiltersList } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFiltersList\n    }\n  };\n</script>\n```\n\n### Customized usage\n\n```vue\n<template>\n  <SelectedFiltersList #default=\"{ filter }\">Default: {{ filter.label }}</SelectedFiltersList>\n</template>\n\n<script>\n  import { SelectedFilters } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFilters\n    }\n  };\n</script>\n```\n\n```vue\n<template>\n  <SelectedFiltersList>\n    <template #default=\"{ filter }\">Default: {{ filter.label }}</template>\n    <template #brand_facet=\"{ filter }\">Brand: {{ filter.label }}</template>\n    <template #age_facet=\"{ filter }\">Age: {{ filter.label }}</template>\n    <template #price_facet=\"{ filter }\">Price: {{ filter.label }}</template>\n  </SelectedFiltersList>\n</template>\n\n<script>\n  import { SelectedFilters } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFilters\n    }\n  };\n</script>\n```\n\n#### Always visible\n\nIf \"alwaysVisible\" is true, the component is rendered no matter if there are some filter selected.\nIf \"alwaysVisible\" is false (default), the component is rendered if there are some filter selected.\n\n```vue\n<SelectedFiltersList :alwaysVisible=\"true\" />\n```\n\nOutput:\n\n```html\n<div class=\"x-selected-filters\">\n  <ul class=\"x-selected-filters-list\" data-test=\"selected-filters-list\"></ul>\n</div>\n```\n\n#### Providing an array of facet ids\n\nIn this example, the selected filters computed are the ones that match the facet ids passed as\nproperties.\n\n```vue\n<SelectedFilters :facetsIds=\"['brand_facet', 'gender_facet']\" />\n```\n</docs>\n"],"names":["_resolveComponent","_openBlock","_createBlock","_withCtx","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","hasSlot","_toDisplayString","_createCommentVNode","_renderSlot"],"mappings":";;;;;;AAoCoB,EAAA,MAAA,0BAAA,GAAAA,gBAAA,CAAA,iBAAA,CAAA,CAAA;AAhCf,EAAA,OAAAC,SAAA,EAA4B,EAAAC,WAAA,CAAA,0BAAA,EAAA;AAAA,IAAA,SAAA,EAAA,IAAA,CAAA,SAAA;IAJjC,aAmCgB,EAAA,IAAA,CAAA,aAAA;AAAA,GAAA,EAAA;AA3BL,IAAA,OAAA,EAAAC,OAAA,CAAC,CAAyB,EAAA,eAAA,EAAA,KAAA;AAAA,OAAAF,SAAA,EACrB,EAAAC,WAAA;AAAA,QAAuBE,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA;AAAA,QAAA;AAAA,UACjC,KAAI,EAAA,yBAAA;AAAA,UAAA,WAAA,EAAA,uBAAA;AAVV,UAAA,GAAA,EAAA,IAAA;AAAA,SAAA;;;AAcc,aAAAH,SAAA,CAAA,IAAA,CAAA,EAAAI,kBAAA;AAAA,cAAiBC,QAAA;AAAA,cAAA,IAAA;AAAA,cAAAC,UAAA,CAAA,IAAA,CAAA,OAAA,CAAA,eAAA,CAAA,EAAA,CAAA,EAAA,QAAA,EAAA,cAAA,EAAA,KAAA;AAClB,gBAAA,OAAAN,SAAA,EAAgC,EAAAI,kBAAA,CAAA,IAAA,EAAA;AAAA,kBACrC,GAAU,EAAA,cAAA,CAAA,EAAA;AAAA,kBAAA,KAAA,EAAA,+BAAA;AAEV,kBAAA,WAAA,EAAA,4BAAA;AAAA,iBAKYG,EAAAA;AAAAA,kBAAAA,kBAAAA,CAEL,oOAFuC,CAAA;AAAA,kBAAA,IAAA,CAvBtD,+BAuBiE,IAAc,CAAA,MAAA,EAAA,QAAA,EAAA;AAAA,oBAEhE,GAAA,EAAA,CAAA;AAAA,oBADL,MAAA,EAAA,cAAA;AAAA,mBAAA,EAAA,MAAA;;AAOF,sBAAA,MAAA;AAAA,sBAAA,UAAA;AAAA,sBAEOC,eAjCf,CAAA,cAAA,CAAA,KAAA,CAAA;AAAA,sBAAA,CAAA;AAAA;AAAA,qBAAA;AAAA,mBAAA,CAAA,IAAAR,SAAA,EAiCe,EAAAI,kBAAA;AAAA,oBAAAC,QAAA;AAAA,oBAF4B,EAAE,GAAA,EAAA,CAAA,EAAA;AAAA,oBAAA;AAAA,sBAAAI,kBAAA,CA/B7C,2JAgCiC,CAAA;AAAA,sBAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,EAAA,EAAA,MAAA,EAAA,cAAA,EAAA,EAAA,MAAA;;;;;;;;;;;;AAhCjC,eAAA,CAAA;AAAA,cAAA,GAAA;AAAA;AAAA,aAAA;AAAA,WAAA,CAAA;;;AAAA,SAAA;AAAA,QAAA,IAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;;;;;;;;;"}
+{"version":3,"file":"selected-filters-list.vue.js","sources":["../../../../../../src/x-modules/facets/components/lists/selected-filters-list.vue"],"sourcesContent":["<template>\n  <SelectedFilters\n    v-slot=\"{ selectedFilters }\"\n    :facetsIds=\"facetsIds\"\n    :alwaysVisible=\"alwaysVisible\"\n  >\n    <component\n      :is=\"animation\"\n      class=\"x-selected-filters-list\"\n      data-test=\"selected-filters-list\"\n      tag=\"ul\"\n    >\n      <li\n        v-for=\"{ slotName, selectedFilter } in mapSlot(selectedFilters)\"\n        :key=\"selectedFilter.id\"\n        class=\"x-selected-filters-list__item\"\n        data-test=\"selected-filters-list-item\"\n      >\n        <!--\n          @slot Custom filter rendering. Dynamic slot defined in the template with the filter\n          facet id. It renders the filter label by default.\n              @binding {Filter} filter - Filter to render.\n        -->\n        <slot v-if=\"hasSlot(slotName)\" :name=\"slotName\" :filter=\"selectedFilter\">\n          <span class=\"x-tag\">{{ selectedFilter.label }}</span>\n        </slot>\n\n        <!--\n          @slot Default filter rendering. It renders the filter label by default.\n              @binding {Filter} filter - Filter to render.\n        -->\n        <slot v-else name=\"default\" :filter=\"selectedFilter\">\n          {{ selectedFilter.label }}\n        </slot>\n      </li>\n    </component>\n  </SelectedFilters>\n</template>\n\n<script lang=\"ts\">\n  import { Facet, Filter, isFacetFilter } from '@empathyco/x-types';\n  import { defineComponent, PropType } from 'vue';\n  import { toKebabCase } from '../../../../utils/string';\n  import { useFacets } from '../../composables/use-facets';\n  import { facetsXModule } from '../../x-module';\n  import { AnimationProp } from '../../../../types';\n  import SelectedFilters from './selected-filters.vue';\n\n  /**\n   * Custom interface to provide a slot name to a Filter.\n   *\n   * @internal\n   */\n  interface RenderFilter {\n    slotName: string;\n    selectedFilter: Filter;\n  }\n\n  /**\n   * This component renders a list of selected filters from every facet, or from the facet\n   * ids passed as property. It uses the SelectedFilters component (state).\n   *\n   * It provides two slots: a scoped one which name is the filter facet id; and a default one.\n   * Both exposes the filter and renders the filter label by default.\n   *\n   * The property \"alwaysVisible\" handles if the component is rendered if no filters are selected.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SelectedFiltersList',\n    xModule: facetsXModule.name,\n    components: { SelectedFilters },\n    props: {\n      /** Array of facets ids used to get the selected filters for those facets. */\n      facetsIds: Array as PropType<Array<Facet['id']>>,\n      /** Flag to render the component even if there are no filters selected. */\n      alwaysVisible: Boolean,\n      /** Animation component that will be used to animate the selected filters list. */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      }\n    },\n    setup: function (props, { slots }) {\n      const { selectedFilters } = useFacets(props);\n\n      /**\n       * Transforms a dictionary of Filters including the slot name.\n       *\n       * @param selectedFilters - A list of selected filters without slot name.\n       *\n       * @returns A dictionary of facets with the slot name.\n       */\n      function mapSlot(selectedFilters: Filter[]): RenderFilter[] {\n        return selectedFilters.map(filter => ({\n          slotName: isFacetFilter(filter) ? toKebabCase(filter.facetId as string) : 'default',\n          selectedFilter: filter\n        }));\n      }\n\n      /**\n       * Whether the slot is present in the template or not.\n       *\n       * @param name - The slot name.\n       *\n       * @returns True is the slot is present in the template. False otherwise.\n       */\n      function hasSlot(name: string): boolean {\n        return !!slots[name];\n      }\n\n      return {\n        selectedFilters,\n        mapSlot,\n        hasSlot\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Example\n\nThis component renders a list of selected filters from every facet, or from the facets which facets\nids are passed as property. It uses the SelectedFilters component (state).\n\nIt provides two slots: a scoped one which name is the filter facet id; and a default one. Both\nexposes the filter and renders the filter label by default.\n\nThe property \"alwaysVisible\" handles if the component is rendered if no filters are selected.\n\n### Default usage\n\n```vue\n<template>\n  <SelectedFiltersList />\n</template>\n\n<script>\n  import { SelectedFiltersList } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFiltersList\n    }\n  };\n</script>\n```\n\n### Customized usage\n\n```vue\n<template>\n  <SelectedFiltersList #default=\"{ filter }\">Default: {{ filter.label }}</SelectedFiltersList>\n</template>\n\n<script>\n  import { SelectedFilters } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFilters\n    }\n  };\n</script>\n```\n\n```vue\n<template>\n  <SelectedFiltersList>\n    <template #default=\"{ filter }\">Default: {{ filter.label }}</template>\n    <template #brand_facet=\"{ filter }\">Brand: {{ filter.label }}</template>\n    <template #age_facet=\"{ filter }\">Age: {{ filter.label }}</template>\n    <template #price_facet=\"{ filter }\">Price: {{ filter.label }}</template>\n  </SelectedFiltersList>\n</template>\n\n<script>\n  import { SelectedFilters } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFilters\n    }\n  };\n</script>\n```\n\n#### Always visible\n\nIf \"alwaysVisible\" is true, the component is rendered no matter if there are some filter selected.\nIf \"alwaysVisible\" is false (default), the component is rendered if there are some filter selected.\n\n```vue\n<SelectedFiltersList :alwaysVisible=\"true\" />\n```\n\nOutput:\n\n```html\n<div class=\"x-selected-filters\">\n  <ul class=\"x-selected-filters-list\" data-test=\"selected-filters-list\"></ul>\n</div>\n```\n\n#### Providing an array of facet ids\n\nIn this example, the selected filters computed are the ones that match the facet ids passed as\nproperties.\n\n```vue\n<SelectedFilters :facetsIds=\"['brand_facet', 'gender_facet']\" />\n```\n</docs>\n"],"names":["_resolveComponent","_openBlock","_createBlock","_withCtx","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","hasSlot","_toDisplayString","_createCommentVNode","_renderSlot"],"mappings":";;;;;;AAoCoB,EAAA,MAAA,0BAAA,GAAAA,gBAAA,CAAA,iBAAA,CAAA,CAAA;AAhCf,EAAA,OAAAC,SAAA,EAA4B,EAAAC,WAAA,CAAA,0BAAA,EAAA;AAAA,IAAA,SAAA,EAAA,IAAA,CAAA,SAAA;IAJjC,aAmCgB,EAAA,IAAA,CAAA,aAAA;AAAA,GAAA,EAAA;AA3BL,IAAA,OAAA,EAAAC,OAAA,CAAC,CAAyB,EAAA,eAAA,EAAA,KAAA;AAAA,OAAAF,SAAA,EACrB,EAAAC,WAAA;AAAA,QAAuBE,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA;AAAA,QAAA;AAAA,UACjC,KAAI,EAAA,yBAAA;AAAA,UAAA,WAAA,EAAA,uBAAA;AAVV,UAAA,GAAA,EAAA,IAAA;AAAA,SAAA;;;AAcc,aAAAH,SAAA,CAAA,IAAA,CAAA,EAAAI,kBAAA;AAAA,cAAiBC,QAAA;AAAA,cAAA,IAAA;AAAA,cAAAC,UAAA,CAAA,IAAA,CAAA,OAAA,CAAA,eAAA,CAAA,EAAA,CAAA,EAAA,QAAA,EAAA,cAAA,EAAA,KAAA;AAClB,gBAAA,OAAAN,SAAA,EAAgC,EAAAI,kBAAA,CAAA,IAAA,EAAA;AAAA,kBACrC,GAAU,EAAA,cAAA,CAAA,EAAA;AAAA,kBAAA,KAAA,EAAA,+BAAA;AAEV,kBAAA,WAAA,EAAA,4BAAA;AAAA,iBAKYG,EAAAA;AAAAA,kBAAAA,kBAAAA,CAEL,oOAFuC,CAAA;AAAA,kBAAA,IAAA,CAvBtD,+BAuBiE,IAAc,CAAA,MAAA,EAAA,QAAA,EAAA;AAAA,oBAEhE,GAAA,EAAA,CAAA;AAAA,oBADL,MAAA,EAAA,cAAA;AAAA,mBAAA,EAAA,MAAA;;AAOF,sBAAA,MAAA;AAAA,sBAAA,UAAA;AAAA,sBAEOC,eAjCf,CAAA,cAAA,CAAA,KAAA,CAAA;AAAA,sBAAA,CAAA;AAAA;AAAA,qBAAA;AAAA,mBAAA,CAAA,IAAAR,SAAA,EAiCe,EAAAI,kBAAA;AAAA,oBAAAC,QAAA;AAAA,oBAF4B,EAAE,GAAA,EAAA,CAAA,EAAA;AAAA,oBAAA;AAAA,sBAAAI,kBAAA,CA/B7C,2JAgCiC,CAAA;AAAA,sBAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,EAAA,EAAA,MAAA,EAAA,cAAA,EAAA,EAAA,MAAA;;;;;;;;;;;;AAhCjC,eAAA,CAAA;AAAA,cAAA,GAAA;AAAA;AAAA,aAAA;AAAA,WAAA,CAAA;;;AAAA,SAAA;AAAA,QAAA,IAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;;;;;;;;;"}

package/js/x-modules/facets/components/lists/selected-filters-list.vue2.js

@@ -1,9 +1,9 @@
 import { isFacetFilter } from '@empathyco/x-types';
 import { defineComponent } from 'vue';
-import { animationProp } from '../../../../utils/options-api.js';
 import { toKebabCase } from '../../../../utils/string.js';
 import { useFacets } from '../../composables/use-facets.js';
 import { facetsXModule } from '../../x-module.js';
+import { AnimationProp } from '../../../../types/animation-prop.js';
 import _sfc_main$1 from './selected-filters.vue.js';
 
 /**
@@ -28,7 +28,7 @@ var _sfc_main = defineComponent({
         alwaysVisible: Boolean,
         /** Animation component that will be used to animate the selected filters list. */
         animation: {
-            type: animationProp,
+            type: AnimationProp,
             default: 'ul'
         }
     },

package/js/x-modules/facets/components/lists/selected-filters-list.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"selected-filters-list.vue2.js","sources":["../../../../../../src/x-modules/facets/components/lists/selected-filters-list.vue"],"sourcesContent":["<template>\n  <SelectedFilters\n    v-slot=\"{ selectedFilters }\"\n    :facetsIds=\"facetsIds\"\n    :alwaysVisible=\"alwaysVisible\"\n  >\n    <component\n      :is=\"animation\"\n      class=\"x-selected-filters-list\"\n      data-test=\"selected-filters-list\"\n      tag=\"ul\"\n    >\n      <li\n        v-for=\"{ slotName, selectedFilter } in mapSlot(selectedFilters)\"\n        :key=\"selectedFilter.id\"\n        class=\"x-selected-filters-list__item\"\n        data-test=\"selected-filters-list-item\"\n      >\n        <!--\n          @slot Custom filter rendering. Dynamic slot defined in the template with the filter\n          facet id. It renders the filter label by default.\n              @binding {Filter} filter - Filter to render.\n        -->\n        <slot v-if=\"hasSlot(slotName)\" :name=\"slotName\" :filter=\"selectedFilter\">\n          <span class=\"x-tag\">{{ selectedFilter.label }}</span>\n        </slot>\n\n        <!--\n          @slot Default filter rendering. It renders the filter label by default.\n              @binding {Filter} filter - Filter to render.\n        -->\n        <slot v-else name=\"default\" :filter=\"selectedFilter\">\n          {{ selectedFilter.label }}\n        </slot>\n      </li>\n    </component>\n  </SelectedFilters>\n</template>\n\n<script lang=\"ts\">\n  import { Facet, Filter, isFacetFilter } from '@empathyco/x-types';\n  import { defineComponent, PropType } from 'vue';\n  import { animationProp } from '../../../../utils/options-api';\n  import { toKebabCase } from '../../../../utils/string';\n  import { useFacets } from '../../composables/use-facets';\n  import { facetsXModule } from '../../x-module';\n  import SelectedFilters from './selected-filters.vue';\n\n  /**\n   * Custom interface to provide a slot name to a Filter.\n   *\n   * @internal\n   */\n  interface RenderFilter {\n    slotName: string;\n    selectedFilter: Filter;\n  }\n\n  /**\n   * This component renders a list of selected filters from every facet, or from the facet\n   * ids passed as property. It uses the SelectedFilters component (state).\n   *\n   * It provides two slots: a scoped one which name is the filter facet id; and a default one.\n   * Both exposes the filter and renders the filter label by default.\n   *\n   * The property \"alwaysVisible\" handles if the component is rendered if no filters are selected.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SelectedFiltersList',\n    xModule: facetsXModule.name,\n    components: { SelectedFilters },\n    props: {\n      /** Array of facets ids used to get the selected filters for those facets. */\n      facetsIds: Array as PropType<Array<Facet['id']>>,\n      /** Flag to render the component even if there are no filters selected. */\n      alwaysVisible: Boolean,\n      /** Animation component that will be used to animate the selected filters list. */\n      animation: {\n        type: animationProp,\n        default: 'ul'\n      }\n    },\n    setup: function (props, { slots }) {\n      const { selectedFilters } = useFacets(props);\n\n      /**\n       * Transforms a dictionary of Filters including the slot name.\n       *\n       * @param selectedFilters - A list of selected filters without slot name.\n       *\n       * @returns A dictionary of facets with the slot name.\n       */\n      function mapSlot(selectedFilters: Filter[]): RenderFilter[] {\n        return selectedFilters.map(filter => ({\n          slotName: isFacetFilter(filter) ? toKebabCase(filter.facetId as string) : 'default',\n          selectedFilter: filter\n        }));\n      }\n\n      /**\n       * Whether the slot is present in the template or not.\n       *\n       * @param name - The slot name.\n       *\n       * @returns True is the slot is present in the template. False otherwise.\n       */\n      function hasSlot(name: string): boolean {\n        return !!slots[name];\n      }\n\n      return {\n        selectedFilters,\n        mapSlot,\n        hasSlot\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Example\n\nThis component renders a list of selected filters from every facet, or from the facets which facets\nids are passed as property. It uses the SelectedFilters component (state).\n\nIt provides two slots: a scoped one which name is the filter facet id; and a default one. Both\nexposes the filter and renders the filter label by default.\n\nThe property \"alwaysVisible\" handles if the component is rendered if no filters are selected.\n\n### Default usage\n\n```vue\n<template>\n  <SelectedFiltersList />\n</template>\n\n<script>\n  import { SelectedFiltersList } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFiltersList\n    }\n  };\n</script>\n```\n\n### Customized usage\n\n```vue\n<template>\n  <SelectedFiltersList #default=\"{ filter }\">Default: {{ filter.label }}</SelectedFiltersList>\n</template>\n\n<script>\n  import { SelectedFilters } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFilters\n    }\n  };\n</script>\n```\n\n```vue\n<template>\n  <SelectedFiltersList>\n    <template #default=\"{ filter }\">Default: {{ filter.label }}</template>\n    <template #brand_facet=\"{ filter }\">Brand: {{ filter.label }}</template>\n    <template #age_facet=\"{ filter }\">Age: {{ filter.label }}</template>\n    <template #price_facet=\"{ filter }\">Price: {{ filter.label }}</template>\n  </SelectedFiltersList>\n</template>\n\n<script>\n  import { SelectedFilters } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFilters\n    }\n  };\n</script>\n```\n\n#### Always visible\n\nIf \"alwaysVisible\" is true, the component is rendered no matter if there are some filter selected.\nIf \"alwaysVisible\" is false (default), the component is rendered if there are some filter selected.\n\n```vue\n<SelectedFiltersList :alwaysVisible=\"true\" />\n```\n\nOutput:\n\n```html\n<div class=\"x-selected-filters\">\n  <ul class=\"x-selected-filters-list\" data-test=\"selected-filters-list\"></ul>\n</div>\n```\n\n#### Providing an array of facet ids\n\nIn this example, the selected filters computed are the ones that match the facet ids passed as\nproperties.\n\n```vue\n<SelectedFilters :facetsIds=\"['brand_facet', 'gender_facet']\" />\n```\n</docs>\n"],"names":["SelectedFilters"],"mappings":";;;;;;;;AA0DE;;;;;;;;;;AAUE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,qBAAqB;IAC3B,OAAO,EAAE,aAAa,CAAC,IAAI;IAC3B,UAAU,EAAE,mBAAEA,WAAc,EAAG;AAC/B,IAAA,KAAK,EAAE;;AAEL,QAAA,SAAS,EAAE,KAAqC;;AAEhD,QAAA,aAAa,EAAE,OAAO;;AAEtB,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,IAAG;AACd,SAAA;AACD,KAAA;AACD,IAAA,KAAK,EAAE,UAAU,KAAK,EAAE,EAAE,KAAM,EAAC,EAAA;QAC/B,MAAM,EAAE,eAAc,KAAM,SAAS,CAAC,KAAK,CAAC,CAAA;AAE5C;;;;;;AAME;QACF,SAAS,OAAO,CAAC,eAAyB,EAAA;YACxC,OAAO,eAAe,CAAC,GAAG,CAAC,MAAO,KAAI;AACpC,gBAAA,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAA,GAAI,WAAW,CAAC,MAAM,CAAC,OAAiB,CAAE,GAAE,SAAS;AACnF,gBAAA,cAAc,EAAE,MAAK;AACtB,aAAA,CAAC,CAAC,CAAA;SACL;AAEA;;;;;;AAME;QACF,SAAS,OAAO,CAAC,IAAY,EAAA;AAC3B,YAAA,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;SACtB;QAEA,OAAO;YACL,eAAe;YACf,OAAO;YACP,OAAM;SACP,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"selected-filters-list.vue2.js","sources":["../../../../../../src/x-modules/facets/components/lists/selected-filters-list.vue"],"sourcesContent":["<template>\n  <SelectedFilters\n    v-slot=\"{ selectedFilters }\"\n    :facetsIds=\"facetsIds\"\n    :alwaysVisible=\"alwaysVisible\"\n  >\n    <component\n      :is=\"animation\"\n      class=\"x-selected-filters-list\"\n      data-test=\"selected-filters-list\"\n      tag=\"ul\"\n    >\n      <li\n        v-for=\"{ slotName, selectedFilter } in mapSlot(selectedFilters)\"\n        :key=\"selectedFilter.id\"\n        class=\"x-selected-filters-list__item\"\n        data-test=\"selected-filters-list-item\"\n      >\n        <!--\n          @slot Custom filter rendering. Dynamic slot defined in the template with the filter\n          facet id. It renders the filter label by default.\n              @binding {Filter} filter - Filter to render.\n        -->\n        <slot v-if=\"hasSlot(slotName)\" :name=\"slotName\" :filter=\"selectedFilter\">\n          <span class=\"x-tag\">{{ selectedFilter.label }}</span>\n        </slot>\n\n        <!--\n          @slot Default filter rendering. It renders the filter label by default.\n              @binding {Filter} filter - Filter to render.\n        -->\n        <slot v-else name=\"default\" :filter=\"selectedFilter\">\n          {{ selectedFilter.label }}\n        </slot>\n      </li>\n    </component>\n  </SelectedFilters>\n</template>\n\n<script lang=\"ts\">\n  import { Facet, Filter, isFacetFilter } from '@empathyco/x-types';\n  import { defineComponent, PropType } from 'vue';\n  import { toKebabCase } from '../../../../utils/string';\n  import { useFacets } from '../../composables/use-facets';\n  import { facetsXModule } from '../../x-module';\n  import { AnimationProp } from '../../../../types';\n  import SelectedFilters from './selected-filters.vue';\n\n  /**\n   * Custom interface to provide a slot name to a Filter.\n   *\n   * @internal\n   */\n  interface RenderFilter {\n    slotName: string;\n    selectedFilter: Filter;\n  }\n\n  /**\n   * This component renders a list of selected filters from every facet, or from the facet\n   * ids passed as property. It uses the SelectedFilters component (state).\n   *\n   * It provides two slots: a scoped one which name is the filter facet id; and a default one.\n   * Both exposes the filter and renders the filter label by default.\n   *\n   * The property \"alwaysVisible\" handles if the component is rendered if no filters are selected.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SelectedFiltersList',\n    xModule: facetsXModule.name,\n    components: { SelectedFilters },\n    props: {\n      /** Array of facets ids used to get the selected filters for those facets. */\n      facetsIds: Array as PropType<Array<Facet['id']>>,\n      /** Flag to render the component even if there are no filters selected. */\n      alwaysVisible: Boolean,\n      /** Animation component that will be used to animate the selected filters list. */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      }\n    },\n    setup: function (props, { slots }) {\n      const { selectedFilters } = useFacets(props);\n\n      /**\n       * Transforms a dictionary of Filters including the slot name.\n       *\n       * @param selectedFilters - A list of selected filters without slot name.\n       *\n       * @returns A dictionary of facets with the slot name.\n       */\n      function mapSlot(selectedFilters: Filter[]): RenderFilter[] {\n        return selectedFilters.map(filter => ({\n          slotName: isFacetFilter(filter) ? toKebabCase(filter.facetId as string) : 'default',\n          selectedFilter: filter\n        }));\n      }\n\n      /**\n       * Whether the slot is present in the template or not.\n       *\n       * @param name - The slot name.\n       *\n       * @returns True is the slot is present in the template. False otherwise.\n       */\n      function hasSlot(name: string): boolean {\n        return !!slots[name];\n      }\n\n      return {\n        selectedFilters,\n        mapSlot,\n        hasSlot\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Example\n\nThis component renders a list of selected filters from every facet, or from the facets which facets\nids are passed as property. It uses the SelectedFilters component (state).\n\nIt provides two slots: a scoped one which name is the filter facet id; and a default one. Both\nexposes the filter and renders the filter label by default.\n\nThe property \"alwaysVisible\" handles if the component is rendered if no filters are selected.\n\n### Default usage\n\n```vue\n<template>\n  <SelectedFiltersList />\n</template>\n\n<script>\n  import { SelectedFiltersList } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFiltersList\n    }\n  };\n</script>\n```\n\n### Customized usage\n\n```vue\n<template>\n  <SelectedFiltersList #default=\"{ filter }\">Default: {{ filter.label }}</SelectedFiltersList>\n</template>\n\n<script>\n  import { SelectedFilters } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFilters\n    }\n  };\n</script>\n```\n\n```vue\n<template>\n  <SelectedFiltersList>\n    <template #default=\"{ filter }\">Default: {{ filter.label }}</template>\n    <template #brand_facet=\"{ filter }\">Brand: {{ filter.label }}</template>\n    <template #age_facet=\"{ filter }\">Age: {{ filter.label }}</template>\n    <template #price_facet=\"{ filter }\">Price: {{ filter.label }}</template>\n  </SelectedFiltersList>\n</template>\n\n<script>\n  import { SelectedFilters } from '@empathyco/x-components/facets';\n\n  export default {\n    components: {\n      SelectedFilters\n    }\n  };\n</script>\n```\n\n#### Always visible\n\nIf \"alwaysVisible\" is true, the component is rendered no matter if there are some filter selected.\nIf \"alwaysVisible\" is false (default), the component is rendered if there are some filter selected.\n\n```vue\n<SelectedFiltersList :alwaysVisible=\"true\" />\n```\n\nOutput:\n\n```html\n<div class=\"x-selected-filters\">\n  <ul class=\"x-selected-filters-list\" data-test=\"selected-filters-list\"></ul>\n</div>\n```\n\n#### Providing an array of facet ids\n\nIn this example, the selected filters computed are the ones that match the facet ids passed as\nproperties.\n\n```vue\n<SelectedFilters :facetsIds=\"['brand_facet', 'gender_facet']\" />\n```\n</docs>\n"],"names":["SelectedFilters"],"mappings":";;;;;;;;AA0DE;;;;;;;;;;AAUE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,qBAAqB;IAC3B,OAAO,EAAE,aAAa,CAAC,IAAI;IAC3B,UAAU,EAAE,mBAAEA,WAAc,EAAG;AAC/B,IAAA,KAAK,EAAE;;AAEL,QAAA,SAAS,EAAE,KAAqC;;AAEhD,QAAA,aAAa,EAAE,OAAO;;AAEtB,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,IAAG;AACd,SAAA;AACD,KAAA;AACD,IAAA,KAAK,EAAE,UAAU,KAAK,EAAE,EAAE,KAAM,EAAC,EAAA;QAC/B,MAAM,EAAE,eAAc,KAAM,SAAS,CAAC,KAAK,CAAC,CAAA;AAE5C;;;;;;AAME;QACF,SAAS,OAAO,CAAC,eAAyB,EAAA;YACxC,OAAO,eAAe,CAAC,GAAG,CAAC,MAAO,KAAI;AACpC,gBAAA,QAAQ,EAAE,aAAa,CAAC,MAAM,CAAA,GAAI,WAAW,CAAC,MAAM,CAAC,OAAiB,CAAE,GAAE,SAAS;AACnF,gBAAA,cAAc,EAAE,MAAK;AACtB,aAAA,CAAC,CAAC,CAAA;SACL;AAEA;;;;;;AAME;QACF,SAAS,OAAO,CAAC,IAAY,EAAA;AAC3B,YAAA,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;SACtB;QAEA,OAAO;YACL,eAAe;YACf,OAAO;YACP,OAAM;SACP,CAAA;KACH;AACD,CAAA,CAAC;;;;"}

package/js/x-modules/related-prompts/store/module.js

@@ -13,6 +13,8 @@ const relatedPromptsXStoreModule = {
     state: () => ({
         query: '',
         relatedPrompts: [],
+        selectedPrompt: -1,
+        selectedQuery: -1,
         status: 'initial',
         params: {}
     }),
@@ -28,7 +30,15 @@ const relatedPromptsXStoreModule = {
         setRelatedPromptsProducts(state, products) {
             state.relatedPrompts = products;
         },
+        setSelectedPrompt(state, selectedPrompt) {
+            state.selectedPrompt = selectedPrompt;
+        },
+        setSelectedQuery(state, selectedQuery) {
+            state.selectedQuery = selectedQuery;
+        },
         resetRelatedPromptsState(state) {
+            state.selectedQuery = -1;
+            state.selectedPrompt = -1;
             state.relatedPrompts = [];
         }
     },