@empathyco/x-components 6.0.0-alpha.200 → 6.0.0-alpha.202

package/js/x-modules/queries-preview/components/query-preview.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-preview.vue.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview.vue"],"sourcesContent":["<template>\n  <ul v-if=\"hasResults\" data-test=\"query-preview\" class=\"x-query-preview\">\n    <li\n      v-for=\"result in queryPreviewResults?.results\"\n      :key=\"result.id\"\n      class=\"x-query-preview__item\"\n      data-test=\"query-preview-item\"\n    >\n      <!--\n        @slot Query Preview result slot.\n        @binding {Result} result - A Query Preview result\n      -->\n      <slot name=\"result\" :result=\"result\">\n        <span data-test=\"result-name\">{{ result.name }}</span>\n      </slot>\n    </li>\n  </ul>\n</template>\n\n<script lang=\"ts\">\nimport type { Filter, SearchRequest } from '@empathyco/x-types'\nimport type { PropType, Ref } from 'vue'\nimport type { FeatureLocation, QueryFeature } from '../../../types'\nimport type { DebouncedFunction } from '../../../utils'\nimport type { QueryPreviewInfo } from '../store/types'\nimport { deepEqual } from '@empathyco/x-utils'\nimport { computed, defineComponent, inject, onBeforeUnmount, provide, watch } from 'vue'\nimport { LIST_ITEMS_KEY } from '../../../components'\nimport { useState, useXBus } from '../../../composables'\nimport { createOrigin, createRawFilters, debounceFunction } from '../../../utils'\nimport { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview'\nimport { queriesPreviewXModule } from '../x-module'\n\n/**\n * Retrieves a preview of the results of a query and exposes them in the default slot,\n * along with the query preview and the totalResults of the search request.\n * By default, it renders the names of the results.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'QueryPreview',\n  xModule: queriesPreviewXModule.name,\n  props: {\n    /** The information about the request of the query preview. */\n    queryPreviewInfo: {\n      type: Object as PropType<QueryPreviewInfo>,\n      required: true,\n    },\n    /** The origin property for the request. */\n    queryFeature: {\n      type: String as PropType<QueryFeature>,\n    },\n    /** Number of query preview results to be rendered. */\n    maxItemsToRender: {\n      type: Number,\n    },\n    /**\n     * Debounce time in milliseconds for triggering the search requests.\n     * It will default to 0 to fit the most common use case (pre-search),\n     * and it would work properly with a 250 value inside empathize.\n     */\n    debounceTimeMs: {\n      type: Number,\n      default: 0,\n    },\n    /**\n     * Controls whether the QueryPreview should be removed from the state\n     * when the component is destroyed.\n     */\n    persistInCache: {\n      type: Boolean,\n      default: false,\n    },\n  },\n  emits: ['load', 'error'],\n  setup(props, { emit, slots }) {\n    const xBus = useXBus()\n\n    /**\n     * previewResults: The results preview of the queries preview cacheable mounted.\n     * It is a dictionary, indexed by the query preview query.\n     *\n     * params: As the request is handled in this component, we need\n     * the extra params that will be used in the request.\n     *\n     * config: As the request is handled in this component, we need\n     * the config that will be used in the request.\n     */\n    const { queriesPreview: previewResults, params, config } = useState('queriesPreview')\n\n    /**\n     * Query Preview key converted into a unique id.\n     *\n     * @returns The query hash.\n     */\n    const queryPreviewHash = computed(() =>\n      getHashFromQueryPreviewInfo(props.queryPreviewInfo, {\n        ...params.value,\n        ...props.queryPreviewInfo.extraParams,\n      }),\n    )\n\n    provide('queryPreviewHash', queryPreviewHash)\n\n    /**\n     * Gets from the state the results preview of the query preview.\n     *\n     * @returns The results preview of the actual query preview.\n     */\n    const queryPreviewResults = computed(() => {\n      const resultsPreview = previewResults.value[queryPreviewHash.value]\n      return resultsPreview?.results\n        ? {\n            ...resultsPreview,\n            results: resultsPreview.results.slice(0, props.maxItemsToRender),\n          }\n        : undefined\n    })\n\n    /**\n     * The results to render from the state.\n     *\n     * @remarks The results list are provided with `items` key. It can be\n     * concatenated with list items from components such as `BannersList`, `PromotedsList`,\n     * `BaseGrid` or any component that injects the list.\n     *\n     * @returns A list of results.\n     */\n    const results = computed(() => queryPreviewResults.value?.results)\n    provide(LIST_ITEMS_KEY as string, results)\n\n    /**\n     * It injects the provided {@link FeatureLocation} of the selected query in the search request.\n     *\n     * @internal\n     */\n    const injectedLocation = inject<Ref<FeatureLocation> | FeatureLocation>('location', 'none')\n    const location =\n      typeof injectedLocation === 'object' && 'value' in injectedLocation\n        ? injectedLocation.value\n        : injectedLocation\n\n    /**\n     * The computed request object to be used to retrieve the query preview results.\n     *\n     * @returns The search request object.\n     */\n    const queryPreviewRequest = computed<SearchRequest>(() => {\n      const origin = createOrigin({\n        feature: props.queryFeature,\n        location,\n      })\n      const filters = props.queryPreviewInfo.filters?.reduce(\n        (filtersList, filterId) => {\n          const facetId = filterId.split(':')[0]\n          const rawFilter = createRawFilters([filterId])[0]\n          filtersList[facetId] = filtersList[facetId]\n            ? filtersList[facetId].concat(rawFilter)\n            : [rawFilter]\n\n          return filtersList\n        },\n        {} as Record<string, Filter[]>,\n      )\n\n      return {\n        query: props.queryPreviewInfo.query,\n        rows: config.value.maxItemsToRequest,\n        extraParams: {\n          ...params.value,\n          ...props.queryPreviewInfo.extraParams,\n        },\n        filters,\n        ...(origin && { origin }),\n      }\n    })\n\n    /**\n     * The debounce method to trigger the request after the debounceTimeMs defined\n     * for cacheable queries.\n     *\n     * @returns The search request object.\n     */\n    const emitQueryPreviewRequestUpdated = computed<DebouncedFunction<[SearchRequest]>>(() =>\n      debounceFunction(request => {\n        xBus.emit('QueryPreviewRequestUpdated', request, { priority: 0, replaceable: false })\n      }, props.debounceTimeMs),\n    )\n\n    /**\n     * Initialises watcher to emit debounced requests, and first value for the requests.\n     *\n     * @internal\n     */\n    watch(queryPreviewRequest, (newRequest, oldRequest) => {\n      if (!deepEqual(newRequest, oldRequest)) {\n        emitQueryPreviewRequestUpdated.value(newRequest)\n      }\n    })\n\n    const cachedQueryPreview = previewResults.value[queryPreviewHash.value]\n\n    // If the query has been saved it will emit load instead of the emitting the updated request.\n    if (cachedQueryPreview?.status === 'success') {\n      emit('load', queryPreviewHash.value)\n      xBus.emit('QueryPreviewMounted', queryPreviewHash.value, {\n        priority: 0,\n        replaceable: false,\n      })\n    } else {\n      emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value)\n    }\n\n    /**\n     * Cancels the (remaining) requests when the component is destroyed\n     * via the `debounce.cancel()` method.\n     * If the prop 'persistInCache' is set to false, it also removes the QueryPreview\n     * from the state when the component is destroyed.\n     */\n    onBeforeUnmount(() => {\n      emitQueryPreviewRequestUpdated.value.cancel()\n      xBus.emit(\n        'QueryPreviewUnmounted',\n        { queryPreviewHash: queryPreviewHash.value, cache: props.persistInCache },\n        {\n          priority: 0,\n          replaceable: false,\n        },\n      )\n    })\n\n    /**\n     * Cancels the previous request when the debounced function changes (e.g: the debounceTimeMs\n     * prop changes or there is a request in progress that cancels it).\n     *\n     * @param _new - The new debounced function.\n     * @param old - The previous debounced function.\n     * @internal\n     */\n    watch(\n      emitQueryPreviewRequestUpdated,\n      (_new: DebouncedFunction<[SearchRequest]>, old: DebouncedFunction<[SearchRequest]>) => {\n        old.cancel()\n      },\n    )\n\n    const queryPreviewResultsStatus = computed(() => queryPreviewResults.value?.status)\n\n    /**\n     * Emits an event when the query results are loaded or fail to load.\n     *\n     * @param status - The status of the query preview request.\n     */\n    watch(queryPreviewResultsStatus, () => {\n      if (queryPreviewResultsStatus.value === 'success') {\n        emit(results.value?.length ? 'load' : 'error', queryPreviewHash.value)\n      } else if (queryPreviewResultsStatus.value === 'error') {\n        emit('error', queryPreviewHash.value)\n      }\n    })\n\n    const hasResults = computed(() => (queryPreviewResults.value?.totalResults ?? 0) > 0)\n\n    /**\n     * Render function to execute the `default` slot, binding `slotsProps` and getting only the\n     * first `vNode` to avoid Fragments and Text root nodes.\n     * If there are no results, nothing is rendered.\n     *\n     * @remarks `slotProps` must be values without Vue reactivity and located inside the\n     * render-function to update the binding data properly.\n     *\n     * @returns The root `vNode` of the `default` slot or empty string if there are no results.\n     */\n    function renderDefaultSlot() {\n      const slotProps = {\n        queryPreviewInfo: props.queryPreviewInfo,\n        results: queryPreviewResults.value?.results,\n        totalResults: queryPreviewResults.value?.totalResults,\n        displayTagging: queryPreviewResults.value?.displayTagging,\n        queryTagging: queryPreviewResults.value?.queryTagging,\n      }\n\n      return hasResults.value ? slots.default?.(slotProps)[0] : ''\n    }\n\n    /* Hack to render through a render-function, the `default` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n    const componentProps = { hasResults, queryPreviewResults }\n    return (slots.default ? renderDefaultSlot : componentProps) as typeof componentProps\n  },\n})\n</script>\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`QueryPreviewRequestUpdated`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted when the component is mounted and when the properties of the request object\n  changes. The event payload is the `queryPreviewRequest` object.\n\n## Vue Events\n\nA list of vue events that the component will emit:\n\n- `load`: the event is emitted when the query results have been loaded.\n- `error`: the event is emitted if there is some error when retrieving the query results.\n\n## See it in action\n\nHere you have a basic example of how the QueryPreview is rendered. Keep in mind that this component\nis intended to be used overriding its default slot. By default it will only render the names of the\nresults.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" />\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'sandals' })\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #default=\"{ totalResults, results }\">\n    <section>\n      <p>Total results: {{ totalResults }}</p>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <article\n          v-for=\"result in results\"\n          :key=\"result.id\"\n          class=\"x-result\"\n          style=\"max-width: 300px; overflow: hidden\"\n        >\n          <BaseResultLink :result=\"result\">\n            <BaseResultImage :result=\"result\" class=\"x-result__picture\" />\n          </BaseResultLink>\n          <div class=\"x-result__description\">\n            <BaseResultLink :result=\"result\">\n              <h1 class=\"x-title3\">{{ result.name }}</h1>\n            </BaseResultLink>\n          </div>\n        </article>\n      </SlidingPanel>\n    </section>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #result=\"{ result }\">\n    <span>{{ result.id }}</span>\n    <span>{{ result.name }}</span>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n\n### Play with props\n\nIn this example, the query preview has been limited to render a maximum of 4 results.\n\n```vue\n<template>\n  <QueryPreview\n    :maxItemsToRender=\"maxItemsToRender\"\n    :queryPreviewInfo=\"queryPreviewInfo\"\n    #default=\"{ results }\"\n  >\n    <BaseGrid #default=\"{ item }\" :items=\"results\">\n      <BaseResultLink :result=\"item\">\n        <BaseResultImage :result=\"item\" />\n      </BaseResultLink>\n    </BaseGrid>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { BaseGrid, BaseResultImage, BaseResultLink } from '@empathyco/x-components'\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst maxItemsToRender = 4\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_Fragment","_renderList","_renderSlot","_createElementVNode","_toDisplayString"],"mappings":";;;;;;EACwB,WAAA,EAAU,eAAA;AAAA,EAAgB,KAAA,EAAM;;AAY1C,MAAA,UAAA,GAAA,EAAA,WAAA,EAAU,aAAA,EAAa;;SAZzB,IAAA,CAAA,UAAA,IAAAA,SAAA,EAAA,EAAVC,kBAAA,CAeK,MAfL,UAAA,EAeK;AAAA,KAAAD,SAAA,CAAA,IAAA,CAAA,EAdHC,kBAAA;AAAA,MAaKC,QAAA;AAAA,MAAA,IAAA;AAAA,MAAAC,UAAA,CAZc,IAAA,CAAA,mBAAA,EAAqB,OAAA,EAAO,CAAtC,MAAA,KAAM;4BADfF,kBAAA,CAaK,IAAA,EAAA;AAAA,UAXF,KAAK,MAAA,CAAO,EAAA;AAAA,UACb,KAAA,EAAM,uBAAA;AAAA,UACN,WAAA,EAAU;AAAA,SAAA,EAAA;UAMVG,UAAA,CAEO,IAAA,CAAA,MAAA,EAAA,QAAA,EAAA,EAFc,MAAA,EAAc,EAAnC,MAEO;AAAA,YADLC,kBAAA;AAAA,cAAsD,MAAA;AAAA,cAAtD,UAAA;AAAA,cAAsDC,eAAA,CAArB,OAAO,IAAI,CAAA;AAAA,cAAA;AAAA;AAAA;AAAA,WAAA;;;;;;;;;;;;"}
+{"version":3,"file":"query-preview.vue.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview.vue"],"sourcesContent":["<template>\n  <!-- eslint-disable-next-line vue/no-unused-refs -->\n  <section ref=\"queryPreviewElement\" class=\"x-query-preview-wrapper__default-content\">\n    <ul v-if=\"hasResults\" data-test=\"query-preview\" class=\"x-query-preview\">\n      <li\n        v-for=\"result in queryPreviewResults?.results\"\n        :key=\"result.id\"\n        class=\"x-query-preview__item\"\n        data-test=\"query-preview-item\"\n      >\n        <!--\n          @slot Query Preview result slot.\n          @binding {Result} result - A Query Preview result\n        -->\n        <slot name=\"result\" :result=\"result\">\n          <span data-test=\"result-name\">{{ result.name }}</span>\n        </slot>\n      </li>\n    </ul>\n  </section>\n</template>\n\n<script lang=\"ts\">\nimport type { Filter, SearchRequest } from '@empathyco/x-types'\nimport type { PropType, Ref } from 'vue'\nimport type { FeatureLocation, QueryFeature } from '../../../types'\nimport type { DebouncedFunction } from '../../../utils'\nimport type { QueryPreviewInfo } from '../store/types'\nimport { deepEqual } from '@empathyco/x-utils'\nimport { computed, defineComponent, h, inject, onBeforeUnmount, provide, ref, watch } from 'vue'\nimport { LIST_ITEMS_KEY } from '../../../components'\nimport { useOnDisplay, useState, useXBus } from '../../../composables'\nimport { createOrigin, createRawFilters, debounceFunction } from '../../../utils'\nimport { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview'\nimport { queriesPreviewXModule } from '../x-module'\n\n/**\n * Retrieves a preview of the results of a query and exposes them in the default slot,\n * along with the query preview and the totalResults of the search request.\n * By default, it renders the names of the results.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'QueryPreview',\n  xModule: queriesPreviewXModule.name,\n  props: {\n    /** The information about the request of the query preview. */\n    queryPreviewInfo: {\n      type: Object as PropType<QueryPreviewInfo>,\n      required: true,\n    },\n    /** The origin property for the request. */\n    queryFeature: {\n      type: String as PropType<QueryFeature>,\n    },\n    /** Number of query preview results to be rendered. */\n    maxItemsToRender: {\n      type: Number,\n    },\n    /**\n     * Controls whether the query preview requests should be triggered when the component is visible in the viewport.\n     */\n    loadWhenVisible: {\n      type: Boolean,\n      default: false,\n    },\n    /**\n     * Debounce time in milliseconds for triggering the search requests.\n     * It will default to 0 to fit the most common use case (pre-search),\n     * and it would work properly with a 250 value inside empathize.\n     */\n    debounceTimeMs: {\n      type: Number,\n      default: 0,\n    },\n    /**\n     * Controls whether the QueryPreview should be removed from the state\n     * when the component is destroyed.\n     */\n    persistInCache: {\n      type: Boolean,\n      default: false,\n    },\n  },\n  emits: ['load', 'error'],\n  setup(props, { emit, slots }) {\n    const xBus = useXBus()\n\n    /**\n     * previewResults: The results preview of the queries preview cacheable mounted.\n     * It is a dictionary, indexed by the query preview query.\n     *\n     * params: As the request is handled in this component, we need\n     * the extra params that will be used in the request.\n     *\n     * config: As the request is handled in this component, we need\n     * the config that will be used in the request.\n     */\n    const { queriesPreview: previewResults, params, config } = useState('queriesPreview')\n\n    /**\n     * Template ref for the root element to track visibility.\n     */\n    const queryPreviewElement = ref<HTMLElement | null>(null)\n\n    /**\n     * Query Preview key converted into a unique id.\n     *\n     * @returns The query hash.\n     */\n    const queryPreviewHash = computed(() =>\n      getHashFromQueryPreviewInfo(props.queryPreviewInfo, {\n        ...params.value,\n        ...props.queryPreviewInfo.extraParams,\n      }),\n    )\n\n    provide('queryPreviewHash', queryPreviewHash)\n\n    /**\n     * Gets from the state the results preview of the query preview.\n     *\n     * @returns The results preview of the actual query preview.\n     */\n    const queryPreviewResults = computed(() => {\n      const resultsPreview = previewResults.value[queryPreviewHash.value]\n      return resultsPreview?.results\n        ? {\n            ...resultsPreview,\n            results: resultsPreview.results.slice(0, props.maxItemsToRender),\n          }\n        : undefined\n    })\n\n    /**\n     * The results to render from the state.\n     *\n     * @remarks The results list are provided with `items` key. It can be\n     * concatenated with list items from components such as `BannersList`, `PromotedsList`,\n     * `BaseGrid` or any component that injects the list.\n     *\n     * @returns A list of results.\n     */\n    const results = computed(() => queryPreviewResults.value?.results)\n    provide(LIST_ITEMS_KEY as string, results)\n\n    /**\n     * It injects the provided {@link FeatureLocation} of the selected query in the search request.\n     *\n     * @internal\n     */\n    const injectedLocation = inject<Ref<FeatureLocation> | FeatureLocation>('location', 'none')\n    const location =\n      typeof injectedLocation === 'object' && 'value' in injectedLocation\n        ? injectedLocation.value\n        : injectedLocation\n\n    /**\n     * The computed request object to be used to retrieve the query preview results.\n     *\n     * @returns The search request object.\n     */\n    const queryPreviewRequest = computed<SearchRequest>(() => {\n      const origin = createOrigin({\n        feature: props.queryFeature,\n        location,\n      })\n      const filters = props.queryPreviewInfo.filters?.reduce(\n        (filtersList, filterId) => {\n          const facetId = filterId.split(':')[0]\n          const rawFilter = createRawFilters([filterId])[0]\n          filtersList[facetId] = filtersList[facetId]\n            ? filtersList[facetId].concat(rawFilter)\n            : [rawFilter]\n\n          return filtersList\n        },\n        {} as Record<string, Filter[]>,\n      )\n\n      return {\n        query: props.queryPreviewInfo.query,\n        rows: config.value.maxItemsToRequest,\n        extraParams: {\n          ...params.value,\n          ...props.queryPreviewInfo.extraParams,\n        },\n        filters,\n        ...(origin && { origin }),\n      }\n    })\n\n    /**\n     * The debounce method to trigger the request after the debounceTimeMs defined\n     * for cacheable queries.\n     *\n     * @returns The search request object.\n     */\n    const emitQueryPreviewRequestUpdated = computed<DebouncedFunction<[SearchRequest]>>(() =>\n      debounceFunction(request => {\n        xBus.emit('QueryPreviewRequestUpdated', request, { priority: 0, replaceable: false })\n      }, props.debounceTimeMs),\n    )\n\n    /**\n     * Initialises watcher to emit debounced requests, and first value for the requests.\n     *\n     * @internal\n     */\n    watch(queryPreviewRequest, (newRequest, oldRequest) => {\n      if (!deepEqual(newRequest, oldRequest) && !props.loadWhenVisible) {\n        emitQueryPreviewRequestUpdated.value(newRequest)\n      }\n    })\n\n    const cachedQueryPreview = previewResults.value[queryPreviewHash.value]\n\n    // If the query has been saved it will emit load instead of the emitting the updated request.\n    if (cachedQueryPreview?.status === 'success') {\n      emit('load', queryPreviewHash.value)\n      xBus.emit('QueryPreviewMounted', queryPreviewHash.value, {\n        priority: 0,\n        replaceable: false,\n      })\n    } else if (!props.loadWhenVisible) {\n      emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value)\n    }\n\n    /**\n     * Watch element visibility and emit request when it becomes visible for the first time\n     * (only when loadWhenVisible is true).\n     */\n    const { unwatchDisplay } = useOnDisplay({\n      element: queryPreviewElement,\n      callback: () => {\n        if (props.loadWhenVisible && cachedQueryPreview?.status !== 'success') {\n          emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value)\n        }\n      },\n    })\n\n    /**\n     * Cancels the (remaining) requests when the component is destroyed\n     * via the `debounce.cancel()` method.\n     * If the prop 'persistInCache' is set to false, it also removes the QueryPreview\n     * from the state when the component is destroyed.\n     */\n    onBeforeUnmount(() => {\n      unwatchDisplay?.()\n      emitQueryPreviewRequestUpdated.value.cancel()\n      xBus.emit(\n        'QueryPreviewUnmounted',\n        { queryPreviewHash: queryPreviewHash.value, cache: props.persistInCache },\n        {\n          priority: 0,\n          replaceable: false,\n        },\n      )\n    })\n\n    /**\n     * Cancels the previous request when the debounced function changes (e.g: the debounceTimeMs\n     * prop changes or there is a request in progress that cancels it).\n     *\n     * @param _new - The new debounced function.\n     * @param old - The previous debounced function.\n     * @internal\n     */\n    watch(\n      emitQueryPreviewRequestUpdated,\n      (_new: DebouncedFunction<[SearchRequest]>, old: DebouncedFunction<[SearchRequest]>) => {\n        old.cancel()\n      },\n    )\n\n    const queryPreviewResultsStatus = computed(() => queryPreviewResults.value?.status)\n\n    /**\n     * Emits an event when the query results are loaded or fail to load.\n     *\n     * @param status - The status of the query preview request.\n     */\n    watch(queryPreviewResultsStatus, () => {\n      if (queryPreviewResultsStatus.value === 'success') {\n        emit(results.value?.length ? 'load' : 'error', queryPreviewHash.value)\n      } else if (queryPreviewResultsStatus.value === 'error') {\n        emit('error', queryPreviewHash.value)\n      }\n    })\n\n    const hasResults = computed(() => (queryPreviewResults.value?.totalResults ?? 0) > 0)\n\n    /**\n     * Render function to execute the `default` slot, binding `slotsProps` and getting only the\n     * first `vNode` to avoid Fragments and Text root nodes.\n     *\n     * @remarks `slotProps` must be values without Vue reactivity and located inside the\n     * render-function to update the binding data properly.\n     *\n     * @returns The root `vNode` of the `default` slot or empty string if there are no results. Always wrapped in a section\n     * element with the `x-query-preview-wrapper__slot-content` class.\n     */\n    function renderDefaultSlot() {\n      const slotProps = {\n        queryPreviewInfo: props.queryPreviewInfo,\n        results: queryPreviewResults.value?.results,\n        totalResults: queryPreviewResults.value?.totalResults,\n        displayTagging: queryPreviewResults.value?.displayTagging,\n        queryTagging: queryPreviewResults.value?.queryTagging,\n      }\n\n      const slotContent = hasResults.value ? slots.default?.(slotProps)[0] : ''\n\n      return h(\n        'section',\n        { ref: queryPreviewElement, class: 'x-query-preview-wrapper__slot-content' },\n        [slotContent],\n      )\n    }\n\n    /* Hack to render through a render-function, the `default` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n    const componentProps = { hasResults, queryPreviewResults, queryPreviewElement }\n    return (slots.default ? renderDefaultSlot : componentProps) as typeof componentProps\n  },\n})\n</script>\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`QueryPreviewRequestUpdated`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted when the component is mounted and when the properties of the request object\n  changes. The event payload is the `queryPreviewRequest` object.\n\n## Vue Events\n\nA list of vue events that the component will emit:\n\n- `load`: the event is emitted when the query results have been loaded.\n- `error`: the event is emitted if there is some error when retrieving the query results.\n\n## See it in action\n\nHere you have a basic example of how the QueryPreview is rendered. Keep in mind that this component\nis intended to be used overriding its default slot. By default it will only render the names of the\nresults.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" />\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'sandals' })\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #default=\"{ totalResults, results }\">\n    <section>\n      <p>Total results: {{ totalResults }}</p>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <article\n          v-for=\"result in results\"\n          :key=\"result.id\"\n          class=\"x-result\"\n          style=\"max-width: 300px; overflow: hidden\"\n        >\n          <BaseResultLink :result=\"result\">\n            <BaseResultImage :result=\"result\" class=\"x-result__picture\" />\n          </BaseResultLink>\n          <div class=\"x-result__description\">\n            <BaseResultLink :result=\"result\">\n              <h1 class=\"x-title3\">{{ result.name }}</h1>\n            </BaseResultLink>\n          </div>\n        </article>\n      </SlidingPanel>\n    </section>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #result=\"{ result }\">\n    <span>{{ result.id }}</span>\n    <span>{{ result.name }}</span>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n\n### Play with props\n\nIn this example, the query preview has been limited to render a maximum of 4 results.\n\n```vue\n<template>\n  <QueryPreview\n    :maxItemsToRender=\"maxItemsToRender\"\n    :queryPreviewInfo=\"queryPreviewInfo\"\n    #default=\"{ results }\"\n  >\n    <BaseGrid #default=\"{ item }\" :items=\"results\">\n      <BaseResultLink :result=\"item\">\n        <BaseResultImage :result=\"item\" />\n      </BaseResultLink>\n    </BaseGrid>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { BaseGrid, BaseResultImage, BaseResultLink } from '@empathyco/x-components'\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst maxItemsToRender = 4\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_Fragment","_renderList","_renderSlot","_createElementVNode","_toDisplayString"],"mappings":";;;;;EAEW,GAAA,EAAI,qBAAA;AAAA,EAAsB,KAAA,EAAM;;;;EACjB,WAAA,EAAU,eAAA;AAAA,EAAgB,KAAA,EAAM;;AAY1C,MAAA,UAAA,GAAA,EAAA,WAAA,EAAU,aAAA,EAAa;;AAbrC,EAAA,OAAAA,SAAA,EAAA,EAAAC,kBAAA;AAAA,IAiBU,SAAA;AAAA,IAjBV,UAAA;AAAA,IAiBU;AAAA,MAhBE,IAAA,CAAA,UAAA,IAAAD,SAAA,EAAA,EAAVC,kBAAA,CAeK,IAAA,EAfL,UAAA,EAeK;AAAA,SAAAD,SAAA,CAAA,IAAA,CAAA,EAdHC,kBAAA;AAAA,UAaKC,QAAA;AAAA,UAAA,IAAA;AAAA,UAAAC,UAAA,CAZc,IAAA,CAAA,mBAAA,EAAqB,OAAA,EAAO,CAAtC,MAAA,KAAM;gCADfF,kBAAA,CAaK,IAAA,EAAA;AAAA,cAXF,KAAK,MAAA,CAAO,EAAA;AAAA,cACb,KAAA,EAAM,uBAAA;AAAA,cACN,WAAA,EAAU;AAAA,aAAA,EAAA;cAMVG,UAAA,CAEO,IAAA,CAAA,MAAA,EAAA,QAAA,EAAA,EAFc,MAAA,EAAc,EAAnC,MAEO;AAAA,gBADLC,kBAAA;AAAA,kBAAsD,MAAA;AAAA,kBAAtD,UAAA;AAAA,kBAAsDC,eAAA,CAArB,OAAO,IAAI,CAAA;AAAA,kBAAA;AAAA;AAAA;AAAA,eAAA;;;;;;;;;;;;;;;;"}

package/js/x-modules/queries-preview/components/query-preview.vue2.js

@@ -1,5 +1,5 @@
 import { deepEqual } from '@empathyco/x-utils';
-import { defineComponent, computed, provide, inject, watch, onBeforeUnmount } from 'vue';
+import { defineComponent, ref, computed, provide, inject, watch, onBeforeUnmount, h } from 'vue';
 import '../../../components/animations/animate-clip-path/animate-clip-path.style.scss.js';
 import '../../../components/animations/animate-scale/animate-scale.style.scss.js';
 import '../../../components/animations/animate-translate/animate-translate.style.scss.js';
@@ -106,7 +106,7 @@ import '../../../components/suggestions/base-suggestions.vue2.js';
 import '../../../components/suggestions/base-suggestions.vue3.js';
 import '../../../composables/create-use-device.js';
 import { debounce } from '../../../utils/debounce.js';
-import '@vueuse/core';
+import { useOnDisplay } from '../../../composables/use-on-display.js';
 import { useState } from '../../../composables/use-state.js';
 import { createRawFilters } from '../../../utils/filters.js';
 import { createOrigin } from '../../../utils/origin.js';
@@ -138,6 +138,13 @@ var _sfc_main = defineComponent({
         maxItemsToRender: {
             type: Number,
         },
+        /**
+         * Controls whether the query preview requests should be triggered when the component is visible in the viewport.
+         */
+        loadWhenVisible: {
+            type: Boolean,
+            default: false,
+        },
         /**
          * Debounce time in milliseconds for triggering the search requests.
          * It will default to 0 to fit the most common use case (pre-search),
@@ -170,6 +177,10 @@ var _sfc_main = defineComponent({
          * the config that will be used in the request.
          */
         const { queriesPreview: previewResults, params, config } = useState('queriesPreview');
+        /**
+         * Template ref for the root element to track visibility.
+         */
+        const queryPreviewElement = ref(null);
         /**
          * Query Preview key converted into a unique id.
          *
@@ -258,7 +269,7 @@ var _sfc_main = defineComponent({
          * @internal
          */
         watch(queryPreviewRequest, (newRequest, oldRequest) => {
-            if (!deepEqual(newRequest, oldRequest)) {
+            if (!deepEqual(newRequest, oldRequest) && !props.loadWhenVisible) {
                 emitQueryPreviewRequestUpdated.value(newRequest);
             }
         });
@@ -271,9 +282,21 @@ var _sfc_main = defineComponent({
                 replaceable: false,
             });
         }
-        else {
+        else if (!props.loadWhenVisible) {
             emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value);
         }
+        /**
+         * Watch element visibility and emit request when it becomes visible for the first time
+         * (only when loadWhenVisible is true).
+         */
+        const { unwatchDisplay } = useOnDisplay({
+            element: queryPreviewElement,
+            callback: () => {
+                if (props.loadWhenVisible && cachedQueryPreview?.status !== 'success') {
+                    emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value);
+                }
+            },
+        });
         /**
          * Cancels the (remaining) requests when the component is destroyed
          * via the `debounce.cancel()` method.
@@ -281,6 +304,7 @@ var _sfc_main = defineComponent({
          * from the state when the component is destroyed.
          */
         onBeforeUnmount(() => {
+            unwatchDisplay?.();
             emitQueryPreviewRequestUpdated.value.cancel();
             xBus.emit('QueryPreviewUnmounted', { queryPreviewHash: queryPreviewHash.value, cache: props.persistInCache }, {
                 priority: 0,
@@ -316,12 +340,12 @@ var _sfc_main = defineComponent({
         /**
          * Render function to execute the `default` slot, binding `slotsProps` and getting only the
          * first `vNode` to avoid Fragments and Text root nodes.
-         * If there are no results, nothing is rendered.
          *
          * @remarks `slotProps` must be values without Vue reactivity and located inside the
          * render-function to update the binding data properly.
          *
-         * @returns The root `vNode` of the `default` slot or empty string if there are no results.
+         * @returns The root `vNode` of the `default` slot or empty string if there are no results. Always wrapped in a section
+         * element with the `x-query-preview-wrapper__slot-content` class.
          */
         function renderDefaultSlot() {
             const slotProps = {
@@ -331,11 +355,12 @@ var _sfc_main = defineComponent({
                 displayTagging: queryPreviewResults.value?.displayTagging,
                 queryTagging: queryPreviewResults.value?.queryTagging,
             };
-            return hasResults.value ? slots.default?.(slotProps)[0] : '';
+            const slotContent = hasResults.value ? slots.default?.(slotProps)[0] : '';
+            return h('section', { ref: queryPreviewElement, class: 'x-query-preview-wrapper__slot-content' }, [slotContent]);
         }
         /* Hack to render through a render-function, the `default` slot or, in its absence,
            the component itself. It is the alternative for the NoElement antipattern. */
-        const componentProps = { hasResults, queryPreviewResults };
+        const componentProps = { hasResults, queryPreviewResults, queryPreviewElement };
         return (slots.default ? renderDefaultSlot : componentProps);
     },
 });

package/js/x-modules/queries-preview/components/query-preview.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-preview.vue2.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview.vue"],"sourcesContent":["<template>\n  <ul v-if=\"hasResults\" data-test=\"query-preview\" class=\"x-query-preview\">\n    <li\n      v-for=\"result in queryPreviewResults?.results\"\n      :key=\"result.id\"\n      class=\"x-query-preview__item\"\n      data-test=\"query-preview-item\"\n    >\n      <!--\n        @slot Query Preview result slot.\n        @binding {Result} result - A Query Preview result\n      -->\n      <slot name=\"result\" :result=\"result\">\n        <span data-test=\"result-name\">{{ result.name }}</span>\n      </slot>\n    </li>\n  </ul>\n</template>\n\n<script lang=\"ts\">\nimport type { Filter, SearchRequest } from '@empathyco/x-types'\nimport type { PropType, Ref } from 'vue'\nimport type { FeatureLocation, QueryFeature } from '../../../types'\nimport type { DebouncedFunction } from '../../../utils'\nimport type { QueryPreviewInfo } from '../store/types'\nimport { deepEqual } from '@empathyco/x-utils'\nimport { computed, defineComponent, inject, onBeforeUnmount, provide, watch } from 'vue'\nimport { LIST_ITEMS_KEY } from '../../../components'\nimport { useState, useXBus } from '../../../composables'\nimport { createOrigin, createRawFilters, debounceFunction } from '../../../utils'\nimport { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview'\nimport { queriesPreviewXModule } from '../x-module'\n\n/**\n * Retrieves a preview of the results of a query and exposes them in the default slot,\n * along with the query preview and the totalResults of the search request.\n * By default, it renders the names of the results.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'QueryPreview',\n  xModule: queriesPreviewXModule.name,\n  props: {\n    /** The information about the request of the query preview. */\n    queryPreviewInfo: {\n      type: Object as PropType<QueryPreviewInfo>,\n      required: true,\n    },\n    /** The origin property for the request. */\n    queryFeature: {\n      type: String as PropType<QueryFeature>,\n    },\n    /** Number of query preview results to be rendered. */\n    maxItemsToRender: {\n      type: Number,\n    },\n    /**\n     * Debounce time in milliseconds for triggering the search requests.\n     * It will default to 0 to fit the most common use case (pre-search),\n     * and it would work properly with a 250 value inside empathize.\n     */\n    debounceTimeMs: {\n      type: Number,\n      default: 0,\n    },\n    /**\n     * Controls whether the QueryPreview should be removed from the state\n     * when the component is destroyed.\n     */\n    persistInCache: {\n      type: Boolean,\n      default: false,\n    },\n  },\n  emits: ['load', 'error'],\n  setup(props, { emit, slots }) {\n    const xBus = useXBus()\n\n    /**\n     * previewResults: The results preview of the queries preview cacheable mounted.\n     * It is a dictionary, indexed by the query preview query.\n     *\n     * params: As the request is handled in this component, we need\n     * the extra params that will be used in the request.\n     *\n     * config: As the request is handled in this component, we need\n     * the config that will be used in the request.\n     */\n    const { queriesPreview: previewResults, params, config } = useState('queriesPreview')\n\n    /**\n     * Query Preview key converted into a unique id.\n     *\n     * @returns The query hash.\n     */\n    const queryPreviewHash = computed(() =>\n      getHashFromQueryPreviewInfo(props.queryPreviewInfo, {\n        ...params.value,\n        ...props.queryPreviewInfo.extraParams,\n      }),\n    )\n\n    provide('queryPreviewHash', queryPreviewHash)\n\n    /**\n     * Gets from the state the results preview of the query preview.\n     *\n     * @returns The results preview of the actual query preview.\n     */\n    const queryPreviewResults = computed(() => {\n      const resultsPreview = previewResults.value[queryPreviewHash.value]\n      return resultsPreview?.results\n        ? {\n            ...resultsPreview,\n            results: resultsPreview.results.slice(0, props.maxItemsToRender),\n          }\n        : undefined\n    })\n\n    /**\n     * The results to render from the state.\n     *\n     * @remarks The results list are provided with `items` key. It can be\n     * concatenated with list items from components such as `BannersList`, `PromotedsList`,\n     * `BaseGrid` or any component that injects the list.\n     *\n     * @returns A list of results.\n     */\n    const results = computed(() => queryPreviewResults.value?.results)\n    provide(LIST_ITEMS_KEY as string, results)\n\n    /**\n     * It injects the provided {@link FeatureLocation} of the selected query in the search request.\n     *\n     * @internal\n     */\n    const injectedLocation = inject<Ref<FeatureLocation> | FeatureLocation>('location', 'none')\n    const location =\n      typeof injectedLocation === 'object' && 'value' in injectedLocation\n        ? injectedLocation.value\n        : injectedLocation\n\n    /**\n     * The computed request object to be used to retrieve the query preview results.\n     *\n     * @returns The search request object.\n     */\n    const queryPreviewRequest = computed<SearchRequest>(() => {\n      const origin = createOrigin({\n        feature: props.queryFeature,\n        location,\n      })\n      const filters = props.queryPreviewInfo.filters?.reduce(\n        (filtersList, filterId) => {\n          const facetId = filterId.split(':')[0]\n          const rawFilter = createRawFilters([filterId])[0]\n          filtersList[facetId] = filtersList[facetId]\n            ? filtersList[facetId].concat(rawFilter)\n            : [rawFilter]\n\n          return filtersList\n        },\n        {} as Record<string, Filter[]>,\n      )\n\n      return {\n        query: props.queryPreviewInfo.query,\n        rows: config.value.maxItemsToRequest,\n        extraParams: {\n          ...params.value,\n          ...props.queryPreviewInfo.extraParams,\n        },\n        filters,\n        ...(origin && { origin }),\n      }\n    })\n\n    /**\n     * The debounce method to trigger the request after the debounceTimeMs defined\n     * for cacheable queries.\n     *\n     * @returns The search request object.\n     */\n    const emitQueryPreviewRequestUpdated = computed<DebouncedFunction<[SearchRequest]>>(() =>\n      debounceFunction(request => {\n        xBus.emit('QueryPreviewRequestUpdated', request, { priority: 0, replaceable: false })\n      }, props.debounceTimeMs),\n    )\n\n    /**\n     * Initialises watcher to emit debounced requests, and first value for the requests.\n     *\n     * @internal\n     */\n    watch(queryPreviewRequest, (newRequest, oldRequest) => {\n      if (!deepEqual(newRequest, oldRequest)) {\n        emitQueryPreviewRequestUpdated.value(newRequest)\n      }\n    })\n\n    const cachedQueryPreview = previewResults.value[queryPreviewHash.value]\n\n    // If the query has been saved it will emit load instead of the emitting the updated request.\n    if (cachedQueryPreview?.status === 'success') {\n      emit('load', queryPreviewHash.value)\n      xBus.emit('QueryPreviewMounted', queryPreviewHash.value, {\n        priority: 0,\n        replaceable: false,\n      })\n    } else {\n      emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value)\n    }\n\n    /**\n     * Cancels the (remaining) requests when the component is destroyed\n     * via the `debounce.cancel()` method.\n     * If the prop 'persistInCache' is set to false, it also removes the QueryPreview\n     * from the state when the component is destroyed.\n     */\n    onBeforeUnmount(() => {\n      emitQueryPreviewRequestUpdated.value.cancel()\n      xBus.emit(\n        'QueryPreviewUnmounted',\n        { queryPreviewHash: queryPreviewHash.value, cache: props.persistInCache },\n        {\n          priority: 0,\n          replaceable: false,\n        },\n      )\n    })\n\n    /**\n     * Cancels the previous request when the debounced function changes (e.g: the debounceTimeMs\n     * prop changes or there is a request in progress that cancels it).\n     *\n     * @param _new - The new debounced function.\n     * @param old - The previous debounced function.\n     * @internal\n     */\n    watch(\n      emitQueryPreviewRequestUpdated,\n      (_new: DebouncedFunction<[SearchRequest]>, old: DebouncedFunction<[SearchRequest]>) => {\n        old.cancel()\n      },\n    )\n\n    const queryPreviewResultsStatus = computed(() => queryPreviewResults.value?.status)\n\n    /**\n     * Emits an event when the query results are loaded or fail to load.\n     *\n     * @param status - The status of the query preview request.\n     */\n    watch(queryPreviewResultsStatus, () => {\n      if (queryPreviewResultsStatus.value === 'success') {\n        emit(results.value?.length ? 'load' : 'error', queryPreviewHash.value)\n      } else if (queryPreviewResultsStatus.value === 'error') {\n        emit('error', queryPreviewHash.value)\n      }\n    })\n\n    const hasResults = computed(() => (queryPreviewResults.value?.totalResults ?? 0) > 0)\n\n    /**\n     * Render function to execute the `default` slot, binding `slotsProps` and getting only the\n     * first `vNode` to avoid Fragments and Text root nodes.\n     * If there are no results, nothing is rendered.\n     *\n     * @remarks `slotProps` must be values without Vue reactivity and located inside the\n     * render-function to update the binding data properly.\n     *\n     * @returns The root `vNode` of the `default` slot or empty string if there are no results.\n     */\n    function renderDefaultSlot() {\n      const slotProps = {\n        queryPreviewInfo: props.queryPreviewInfo,\n        results: queryPreviewResults.value?.results,\n        totalResults: queryPreviewResults.value?.totalResults,\n        displayTagging: queryPreviewResults.value?.displayTagging,\n        queryTagging: queryPreviewResults.value?.queryTagging,\n      }\n\n      return hasResults.value ? slots.default?.(slotProps)[0] : ''\n    }\n\n    /* Hack to render through a render-function, the `default` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n    const componentProps = { hasResults, queryPreviewResults }\n    return (slots.default ? renderDefaultSlot : componentProps) as typeof componentProps\n  },\n})\n</script>\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`QueryPreviewRequestUpdated`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted when the component is mounted and when the properties of the request object\n  changes. The event payload is the `queryPreviewRequest` object.\n\n## Vue Events\n\nA list of vue events that the component will emit:\n\n- `load`: the event is emitted when the query results have been loaded.\n- `error`: the event is emitted if there is some error when retrieving the query results.\n\n## See it in action\n\nHere you have a basic example of how the QueryPreview is rendered. Keep in mind that this component\nis intended to be used overriding its default slot. By default it will only render the names of the\nresults.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" />\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'sandals' })\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #default=\"{ totalResults, results }\">\n    <section>\n      <p>Total results: {{ totalResults }}</p>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <article\n          v-for=\"result in results\"\n          :key=\"result.id\"\n          class=\"x-result\"\n          style=\"max-width: 300px; overflow: hidden\"\n        >\n          <BaseResultLink :result=\"result\">\n            <BaseResultImage :result=\"result\" class=\"x-result__picture\" />\n          </BaseResultLink>\n          <div class=\"x-result__description\">\n            <BaseResultLink :result=\"result\">\n              <h1 class=\"x-title3\">{{ result.name }}</h1>\n            </BaseResultLink>\n          </div>\n        </article>\n      </SlidingPanel>\n    </section>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #result=\"{ result }\">\n    <span>{{ result.id }}</span>\n    <span>{{ result.name }}</span>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n\n### Play with props\n\nIn this example, the query preview has been limited to render a maximum of 4 results.\n\n```vue\n<template>\n  <QueryPreview\n    :maxItemsToRender=\"maxItemsToRender\"\n    :queryPreviewInfo=\"queryPreviewInfo\"\n    #default=\"{ results }\"\n  >\n    <BaseGrid #default=\"{ item }\" :items=\"results\">\n      <BaseResultLink :result=\"item\">\n        <BaseResultImage :result=\"item\" />\n      </BaseResultLink>\n    </BaseGrid>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { BaseGrid, BaseResultImage, BaseResultLink } from '@empathyco/x-components'\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst maxItemsToRender = 4\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n</docs>\n"],"names":["debounceFunction"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA;;;;;;AAME;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,qBAAqB,CAAC,IAAI;AACnC,IAAA,KAAK,EAAE;;AAEL,QAAA,gBAAgB,EAAE;AAChB,YAAA,IAAI,EAAE,MAAoC;AAC1C,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;;AAED,QAAA,YAAY,EAAE;AACZ,YAAA,IAAI,EAAE,MAAgC;AACvC,SAAA;;AAED,QAAA,gBAAgB,EAAE;AAChB,YAAA,IAAI,EAAE,MAAM;AACb,SAAA;AACD;;;;AAIE;AACF,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,CAAC;AACX,SAAA;AACD;;;AAGE;AACF,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,OAAO;AACb,YAAA,OAAO,EAAE,KAAK;AACf,SAAA;AACF,KAAA;AACD,IAAA,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;AACxB,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAI,EAAG,EAAA;AAC1B,QAAA,MAAM,IAAG,GAAI,OAAO,EAAC;AAErB;;;;;;;;;AASE;AACF,QAAA,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,MAAK,KAAM,QAAQ,CAAC,gBAAgB,CAAA;AAEpF;;;;AAIE;AACF,QAAA,MAAM,gBAAe,GAAI,QAAQ,CAAC,MAChC,2BAA2B,CAAC,KAAK,CAAC,gBAAgB,EAAE;YAClD,GAAG,MAAM,CAAC,KAAK;AACf,YAAA,GAAG,KAAK,CAAC,gBAAgB,CAAC,WAAW;AACtC,SAAA,CAAC,CACJ;AAEA,QAAA,OAAO,CAAC,kBAAkB,EAAE,gBAAgB,CAAA;AAE5C;;;;AAIE;AACF,QAAA,MAAM,mBAAkB,GAAI,QAAQ,CAAC,MAAI;YACvC,MAAM,cAAa,GAAI,cAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAA;YAClE,OAAO,cAAc,EAAE;AACrB,kBAAE;AACE,oBAAA,GAAG,cAAc;AACjB,oBAAA,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC;AAClE;kBACA,SAAQ;AACd,QAAA,CAAC,CAAA;AAED;;;;;;;;AAQE;AACF,QAAA,MAAM,OAAM,GAAI,QAAQ,CAAC,MAAM,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAA;AACjE,QAAA,OAAO,CAAC,cAAwB,EAAE,OAAO,CAAA;AAEzC;;;;AAIE;QACF,MAAM,gBAAe,GAAI,MAAM,CAAyC,UAAU,EAAE,MAAM,CAAA;QAC1F,MAAM,QAAO,GACX,OAAO,gBAAe,KAAM,QAAO,IAAK,OAAM,IAAK;cAC/C,gBAAgB,CAAC;cACjB,gBAAe;AAErB;;;;AAIE;AACF,QAAA,MAAM,mBAAkB,GAAI,QAAQ,CAAgB,MAAI;YACtD,MAAM,MAAK,GAAI,YAAY,CAAC;gBAC1B,OAAO,EAAE,KAAK,CAAC,YAAY;gBAC3B,QAAQ;AACT,aAAA,CAAA;AACD,YAAA,MAAM,OAAM,GAAI,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CACpD,CAAC,WAAW,EAAE,QAAQ,KAAG;gBACvB,MAAM,OAAM,GAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBACrC,MAAM,YAAY,gBAAgB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;AAChD,gBAAA,WAAW,CAAC,OAAO,CAAA,GAAI,WAAW,CAAC,OAAO;sBACtC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,SAAS;AACvC,sBAAE,CAAC,SAAS,CAAA;AAEd,gBAAA,OAAO,WAAU;YACnB,CAAC,EACD,EAA8B,CAChC;YAEA,OAAO;AACL,gBAAA,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,KAAK;AACnC,gBAAA,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,iBAAiB;AACpC,gBAAA,WAAW,EAAE;oBACX,GAAG,MAAM,CAAC,KAAK;AACf,oBAAA,GAAG,KAAK,CAAC,gBAAgB,CAAC,WAAW;AACtC,iBAAA;gBACD,OAAO;AACP,gBAAA,IAAI,MAAK,IAAK,EAAE,MAAK,EAAG,CAAC;aAC3B;AACF,QAAA,CAAC,CAAA;AAED;;;;;AAKE;QACF,MAAM,8BAA6B,GAAI,QAAQ,CAAqC,MAClFA,QAAgB,CAAC,OAAM,IAAG;AACxB,YAAA,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,CAAA;AACtF,QAAA,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAC1B;AAEA;;;;AAIE;QACF,KAAK,CAAC,mBAAmB,EAAE,CAAC,UAAU,EAAE,UAAU,KAAG;YACnD,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;AACtC,gBAAA,8BAA8B,CAAC,KAAK,CAAC,UAAU,CAAA;YACjD;AACF,QAAA,CAAC,CAAA;QAED,MAAM,kBAAiB,GAAI,cAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAA;;AAGtE,QAAA,IAAI,kBAAkB,EAAE,MAAK,KAAM,SAAS,EAAE;AAC5C,YAAA,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAA;YACnC,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,KAAK,EAAE;AACvD,gBAAA,QAAQ,EAAE,CAAC;AACX,gBAAA,WAAW,EAAE,KAAK;AACnB,aAAA,CAAA;QACH;aAAO;AACL,YAAA,8BAA8B,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAA;QAChE;AAEA;;;;;AAKE;QACF,eAAe,CAAC,MAAI;AAClB,YAAA,8BAA8B,CAAC,KAAK,CAAC,MAAM,EAAC;AAC5C,YAAA,IAAI,CAAC,IAAI,CACP,uBAAuB,EACvB,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,gBAAgB,EACzE;AACE,gBAAA,QAAQ,EAAE,CAAC;AACX,gBAAA,WAAW,EAAE,KAAK;AACnB,aAAA,CACH;AACF,QAAA,CAAC,CAAA;AAED;;;;;;;AAOE;QACF,KAAK,CACH,8BAA8B,EAC9B,CAAC,IAAwC,EAAE,GAAuC,KAAG;YACnF,GAAG,CAAC,MAAM,EAAC;AACb,QAAA,CAAC,CACH;AAEA,QAAA,MAAM,yBAAwB,GAAI,QAAQ,CAAC,MAAM,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAA;AAElF;;;;AAIE;AACF,QAAA,KAAK,CAAC,yBAAyB,EAAE,MAAI;AACnC,YAAA,IAAI,yBAAyB,CAAC,KAAI,KAAM,SAAS,EAAE;AACjD,gBAAA,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAK,GAAI,MAAK,GAAI,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAA;YACvE;AAAO,iBAAA,IAAI,yBAAyB,CAAC,UAAU,OAAO,EAAE;AACtD,gBAAA,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAA;YACtC;AACF,QAAA,CAAC,CAAA;AAED,QAAA,MAAM,UAAS,GAAI,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAA;AAEpF;;;;;;;;;AASE;AACF,QAAA,SAAS,iBAAiB,GAAA;AACxB,YAAA,MAAM,YAAY;gBAChB,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;AACxC,gBAAA,OAAO,EAAE,mBAAmB,CAAC,KAAK,EAAE,OAAO;AAC3C,gBAAA,YAAY,EAAE,mBAAmB,CAAC,KAAK,EAAE,YAAY;AACrD,gBAAA,cAAc,EAAE,mBAAmB,CAAC,KAAK,EAAE,cAAc;AACzD,gBAAA,YAAY,EAAE,mBAAmB,CAAC,KAAK,EAAE,YAAY;aACvD;YAEA,OAAO,UAAU,CAAC,KAAI,GAAI,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA,GAAI,EAAC;QAC7D;AAEA;AAC+E;AAC/E,QAAA,MAAM,iBAAiB,EAAE,UAAU,EAAE,mBAAkB,EAAE;AACzD,QAAA,QAAQ,KAAK,CAAC,OAAM,GAAI,iBAAgB,GAAI,cAAc;IAC5D,CAAC;AACF,CAAA,CAAA;;;;"}
+{"version":3,"file":"query-preview.vue2.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview.vue"],"sourcesContent":["<template>\n  <!-- eslint-disable-next-line vue/no-unused-refs -->\n  <section ref=\"queryPreviewElement\" class=\"x-query-preview-wrapper__default-content\">\n    <ul v-if=\"hasResults\" data-test=\"query-preview\" class=\"x-query-preview\">\n      <li\n        v-for=\"result in queryPreviewResults?.results\"\n        :key=\"result.id\"\n        class=\"x-query-preview__item\"\n        data-test=\"query-preview-item\"\n      >\n        <!--\n          @slot Query Preview result slot.\n          @binding {Result} result - A Query Preview result\n        -->\n        <slot name=\"result\" :result=\"result\">\n          <span data-test=\"result-name\">{{ result.name }}</span>\n        </slot>\n      </li>\n    </ul>\n  </section>\n</template>\n\n<script lang=\"ts\">\nimport type { Filter, SearchRequest } from '@empathyco/x-types'\nimport type { PropType, Ref } from 'vue'\nimport type { FeatureLocation, QueryFeature } from '../../../types'\nimport type { DebouncedFunction } from '../../../utils'\nimport type { QueryPreviewInfo } from '../store/types'\nimport { deepEqual } from '@empathyco/x-utils'\nimport { computed, defineComponent, h, inject, onBeforeUnmount, provide, ref, watch } from 'vue'\nimport { LIST_ITEMS_KEY } from '../../../components'\nimport { useOnDisplay, useState, useXBus } from '../../../composables'\nimport { createOrigin, createRawFilters, debounceFunction } from '../../../utils'\nimport { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview'\nimport { queriesPreviewXModule } from '../x-module'\n\n/**\n * Retrieves a preview of the results of a query and exposes them in the default slot,\n * along with the query preview and the totalResults of the search request.\n * By default, it renders the names of the results.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'QueryPreview',\n  xModule: queriesPreviewXModule.name,\n  props: {\n    /** The information about the request of the query preview. */\n    queryPreviewInfo: {\n      type: Object as PropType<QueryPreviewInfo>,\n      required: true,\n    },\n    /** The origin property for the request. */\n    queryFeature: {\n      type: String as PropType<QueryFeature>,\n    },\n    /** Number of query preview results to be rendered. */\n    maxItemsToRender: {\n      type: Number,\n    },\n    /**\n     * Controls whether the query preview requests should be triggered when the component is visible in the viewport.\n     */\n    loadWhenVisible: {\n      type: Boolean,\n      default: false,\n    },\n    /**\n     * Debounce time in milliseconds for triggering the search requests.\n     * It will default to 0 to fit the most common use case (pre-search),\n     * and it would work properly with a 250 value inside empathize.\n     */\n    debounceTimeMs: {\n      type: Number,\n      default: 0,\n    },\n    /**\n     * Controls whether the QueryPreview should be removed from the state\n     * when the component is destroyed.\n     */\n    persistInCache: {\n      type: Boolean,\n      default: false,\n    },\n  },\n  emits: ['load', 'error'],\n  setup(props, { emit, slots }) {\n    const xBus = useXBus()\n\n    /**\n     * previewResults: The results preview of the queries preview cacheable mounted.\n     * It is a dictionary, indexed by the query preview query.\n     *\n     * params: As the request is handled in this component, we need\n     * the extra params that will be used in the request.\n     *\n     * config: As the request is handled in this component, we need\n     * the config that will be used in the request.\n     */\n    const { queriesPreview: previewResults, params, config } = useState('queriesPreview')\n\n    /**\n     * Template ref for the root element to track visibility.\n     */\n    const queryPreviewElement = ref<HTMLElement | null>(null)\n\n    /**\n     * Query Preview key converted into a unique id.\n     *\n     * @returns The query hash.\n     */\n    const queryPreviewHash = computed(() =>\n      getHashFromQueryPreviewInfo(props.queryPreviewInfo, {\n        ...params.value,\n        ...props.queryPreviewInfo.extraParams,\n      }),\n    )\n\n    provide('queryPreviewHash', queryPreviewHash)\n\n    /**\n     * Gets from the state the results preview of the query preview.\n     *\n     * @returns The results preview of the actual query preview.\n     */\n    const queryPreviewResults = computed(() => {\n      const resultsPreview = previewResults.value[queryPreviewHash.value]\n      return resultsPreview?.results\n        ? {\n            ...resultsPreview,\n            results: resultsPreview.results.slice(0, props.maxItemsToRender),\n          }\n        : undefined\n    })\n\n    /**\n     * The results to render from the state.\n     *\n     * @remarks The results list are provided with `items` key. It can be\n     * concatenated with list items from components such as `BannersList`, `PromotedsList`,\n     * `BaseGrid` or any component that injects the list.\n     *\n     * @returns A list of results.\n     */\n    const results = computed(() => queryPreviewResults.value?.results)\n    provide(LIST_ITEMS_KEY as string, results)\n\n    /**\n     * It injects the provided {@link FeatureLocation} of the selected query in the search request.\n     *\n     * @internal\n     */\n    const injectedLocation = inject<Ref<FeatureLocation> | FeatureLocation>('location', 'none')\n    const location =\n      typeof injectedLocation === 'object' && 'value' in injectedLocation\n        ? injectedLocation.value\n        : injectedLocation\n\n    /**\n     * The computed request object to be used to retrieve the query preview results.\n     *\n     * @returns The search request object.\n     */\n    const queryPreviewRequest = computed<SearchRequest>(() => {\n      const origin = createOrigin({\n        feature: props.queryFeature,\n        location,\n      })\n      const filters = props.queryPreviewInfo.filters?.reduce(\n        (filtersList, filterId) => {\n          const facetId = filterId.split(':')[0]\n          const rawFilter = createRawFilters([filterId])[0]\n          filtersList[facetId] = filtersList[facetId]\n            ? filtersList[facetId].concat(rawFilter)\n            : [rawFilter]\n\n          return filtersList\n        },\n        {} as Record<string, Filter[]>,\n      )\n\n      return {\n        query: props.queryPreviewInfo.query,\n        rows: config.value.maxItemsToRequest,\n        extraParams: {\n          ...params.value,\n          ...props.queryPreviewInfo.extraParams,\n        },\n        filters,\n        ...(origin && { origin }),\n      }\n    })\n\n    /**\n     * The debounce method to trigger the request after the debounceTimeMs defined\n     * for cacheable queries.\n     *\n     * @returns The search request object.\n     */\n    const emitQueryPreviewRequestUpdated = computed<DebouncedFunction<[SearchRequest]>>(() =>\n      debounceFunction(request => {\n        xBus.emit('QueryPreviewRequestUpdated', request, { priority: 0, replaceable: false })\n      }, props.debounceTimeMs),\n    )\n\n    /**\n     * Initialises watcher to emit debounced requests, and first value for the requests.\n     *\n     * @internal\n     */\n    watch(queryPreviewRequest, (newRequest, oldRequest) => {\n      if (!deepEqual(newRequest, oldRequest) && !props.loadWhenVisible) {\n        emitQueryPreviewRequestUpdated.value(newRequest)\n      }\n    })\n\n    const cachedQueryPreview = previewResults.value[queryPreviewHash.value]\n\n    // If the query has been saved it will emit load instead of the emitting the updated request.\n    if (cachedQueryPreview?.status === 'success') {\n      emit('load', queryPreviewHash.value)\n      xBus.emit('QueryPreviewMounted', queryPreviewHash.value, {\n        priority: 0,\n        replaceable: false,\n      })\n    } else if (!props.loadWhenVisible) {\n      emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value)\n    }\n\n    /**\n     * Watch element visibility and emit request when it becomes visible for the first time\n     * (only when loadWhenVisible is true).\n     */\n    const { unwatchDisplay } = useOnDisplay({\n      element: queryPreviewElement,\n      callback: () => {\n        if (props.loadWhenVisible && cachedQueryPreview?.status !== 'success') {\n          emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value)\n        }\n      },\n    })\n\n    /**\n     * Cancels the (remaining) requests when the component is destroyed\n     * via the `debounce.cancel()` method.\n     * If the prop 'persistInCache' is set to false, it also removes the QueryPreview\n     * from the state when the component is destroyed.\n     */\n    onBeforeUnmount(() => {\n      unwatchDisplay?.()\n      emitQueryPreviewRequestUpdated.value.cancel()\n      xBus.emit(\n        'QueryPreviewUnmounted',\n        { queryPreviewHash: queryPreviewHash.value, cache: props.persistInCache },\n        {\n          priority: 0,\n          replaceable: false,\n        },\n      )\n    })\n\n    /**\n     * Cancels the previous request when the debounced function changes (e.g: the debounceTimeMs\n     * prop changes or there is a request in progress that cancels it).\n     *\n     * @param _new - The new debounced function.\n     * @param old - The previous debounced function.\n     * @internal\n     */\n    watch(\n      emitQueryPreviewRequestUpdated,\n      (_new: DebouncedFunction<[SearchRequest]>, old: DebouncedFunction<[SearchRequest]>) => {\n        old.cancel()\n      },\n    )\n\n    const queryPreviewResultsStatus = computed(() => queryPreviewResults.value?.status)\n\n    /**\n     * Emits an event when the query results are loaded or fail to load.\n     *\n     * @param status - The status of the query preview request.\n     */\n    watch(queryPreviewResultsStatus, () => {\n      if (queryPreviewResultsStatus.value === 'success') {\n        emit(results.value?.length ? 'load' : 'error', queryPreviewHash.value)\n      } else if (queryPreviewResultsStatus.value === 'error') {\n        emit('error', queryPreviewHash.value)\n      }\n    })\n\n    const hasResults = computed(() => (queryPreviewResults.value?.totalResults ?? 0) > 0)\n\n    /**\n     * Render function to execute the `default` slot, binding `slotsProps` and getting only the\n     * first `vNode` to avoid Fragments and Text root nodes.\n     *\n     * @remarks `slotProps` must be values without Vue reactivity and located inside the\n     * render-function to update the binding data properly.\n     *\n     * @returns The root `vNode` of the `default` slot or empty string if there are no results. Always wrapped in a section\n     * element with the `x-query-preview-wrapper__slot-content` class.\n     */\n    function renderDefaultSlot() {\n      const slotProps = {\n        queryPreviewInfo: props.queryPreviewInfo,\n        results: queryPreviewResults.value?.results,\n        totalResults: queryPreviewResults.value?.totalResults,\n        displayTagging: queryPreviewResults.value?.displayTagging,\n        queryTagging: queryPreviewResults.value?.queryTagging,\n      }\n\n      const slotContent = hasResults.value ? slots.default?.(slotProps)[0] : ''\n\n      return h(\n        'section',\n        { ref: queryPreviewElement, class: 'x-query-preview-wrapper__slot-content' },\n        [slotContent],\n      )\n    }\n\n    /* Hack to render through a render-function, the `default` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n    const componentProps = { hasResults, queryPreviewResults, queryPreviewElement }\n    return (slots.default ? renderDefaultSlot : componentProps) as typeof componentProps\n  },\n})\n</script>\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`QueryPreviewRequestUpdated`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted when the component is mounted and when the properties of the request object\n  changes. The event payload is the `queryPreviewRequest` object.\n\n## Vue Events\n\nA list of vue events that the component will emit:\n\n- `load`: the event is emitted when the query results have been loaded.\n- `error`: the event is emitted if there is some error when retrieving the query results.\n\n## See it in action\n\nHere you have a basic example of how the QueryPreview is rendered. Keep in mind that this component\nis intended to be used overriding its default slot. By default it will only render the names of the\nresults.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" />\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'sandals' })\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #default=\"{ totalResults, results }\">\n    <section>\n      <p>Total results: {{ totalResults }}</p>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <article\n          v-for=\"result in results\"\n          :key=\"result.id\"\n          class=\"x-result\"\n          style=\"max-width: 300px; overflow: hidden\"\n        >\n          <BaseResultLink :result=\"result\">\n            <BaseResultImage :result=\"result\" class=\"x-result__picture\" />\n          </BaseResultLink>\n          <div class=\"x-result__description\">\n            <BaseResultLink :result=\"result\">\n              <h1 class=\"x-title3\">{{ result.name }}</h1>\n            </BaseResultLink>\n          </div>\n        </article>\n      </SlidingPanel>\n    </section>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #result=\"{ result }\">\n    <span>{{ result.id }}</span>\n    <span>{{ result.name }}</span>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n\n### Play with props\n\nIn this example, the query preview has been limited to render a maximum of 4 results.\n\n```vue\n<template>\n  <QueryPreview\n    :maxItemsToRender=\"maxItemsToRender\"\n    :queryPreviewInfo=\"queryPreviewInfo\"\n    #default=\"{ results }\"\n  >\n    <BaseGrid #default=\"{ item }\" :items=\"results\">\n      <BaseResultLink :result=\"item\">\n        <BaseResultImage :result=\"item\" />\n      </BaseResultLink>\n    </BaseGrid>\n  </QueryPreview>\n</template>\n\n<script setup>\nimport { BaseGrid, BaseResultImage, BaseResultLink } from '@empathyco/x-components'\nimport { QueryPreview } from '@empathyco/x-components/queries-preview'\nimport { reactive } from 'vue'\nconst maxItemsToRender = 4\nconst queryPreviewInfo = reactive({ query: 'flip-flops' })\n</script>\n```\n</docs>\n"],"names":["debounceFunction"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCA;;;;;;AAME;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,qBAAqB,CAAC,IAAI;AACnC,IAAA,KAAK,EAAE;;AAEL,QAAA,gBAAgB,EAAE;AAChB,YAAA,IAAI,EAAE,MAAoC;AAC1C,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;;AAED,QAAA,YAAY,EAAE;AACZ,YAAA,IAAI,EAAE,MAAgC;AACvC,SAAA;;AAED,QAAA,gBAAgB,EAAE;AAChB,YAAA,IAAI,EAAE,MAAM;AACb,SAAA;AACD;;AAEE;AACF,QAAA,eAAe,EAAE;AACf,YAAA,IAAI,EAAE,OAAO;AACb,YAAA,OAAO,EAAE,KAAK;AACf,SAAA;AACD;;;;AAIE;AACF,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,CAAC;AACX,SAAA;AACD;;;AAGE;AACF,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,OAAO;AACb,YAAA,OAAO,EAAE,KAAK;AACf,SAAA;AACF,KAAA;AACD,IAAA,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;AACxB,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAI,EAAG,EAAA;AAC1B,QAAA,MAAM,IAAG,GAAI,OAAO,EAAC;AAErB;;;;;;;;;AASE;AACF,QAAA,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,MAAK,KAAM,QAAQ,CAAC,gBAAgB,CAAA;AAEpF;;AAEE;AACF,QAAA,MAAM,mBAAkB,GAAI,GAAG,CAAqB,IAAI,CAAA;AAExD;;;;AAIE;AACF,QAAA,MAAM,gBAAe,GAAI,QAAQ,CAAC,MAChC,2BAA2B,CAAC,KAAK,CAAC,gBAAgB,EAAE;YAClD,GAAG,MAAM,CAAC,KAAK;AACf,YAAA,GAAG,KAAK,CAAC,gBAAgB,CAAC,WAAW;AACtC,SAAA,CAAC,CACJ;AAEA,QAAA,OAAO,CAAC,kBAAkB,EAAE,gBAAgB,CAAA;AAE5C;;;;AAIE;AACF,QAAA,MAAM,mBAAkB,GAAI,QAAQ,CAAC,MAAI;YACvC,MAAM,cAAa,GAAI,cAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAA;YAClE,OAAO,cAAc,EAAE;AACrB,kBAAE;AACE,oBAAA,GAAG,cAAc;AACjB,oBAAA,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC;AAClE;kBACA,SAAQ;AACd,QAAA,CAAC,CAAA;AAED;;;;;;;;AAQE;AACF,QAAA,MAAM,OAAM,GAAI,QAAQ,CAAC,MAAM,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAA;AACjE,QAAA,OAAO,CAAC,cAAwB,EAAE,OAAO,CAAA;AAEzC;;;;AAIE;QACF,MAAM,gBAAe,GAAI,MAAM,CAAyC,UAAU,EAAE,MAAM,CAAA;QAC1F,MAAM,QAAO,GACX,OAAO,gBAAe,KAAM,QAAO,IAAK,OAAM,IAAK;cAC/C,gBAAgB,CAAC;cACjB,gBAAe;AAErB;;;;AAIE;AACF,QAAA,MAAM,mBAAkB,GAAI,QAAQ,CAAgB,MAAI;YACtD,MAAM,MAAK,GAAI,YAAY,CAAC;gBAC1B,OAAO,EAAE,KAAK,CAAC,YAAY;gBAC3B,QAAQ;AACT,aAAA,CAAA;AACD,YAAA,MAAM,OAAM,GAAI,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CACpD,CAAC,WAAW,EAAE,QAAQ,KAAG;gBACvB,MAAM,OAAM,GAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBACrC,MAAM,YAAY,gBAAgB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;AAChD,gBAAA,WAAW,CAAC,OAAO,CAAA,GAAI,WAAW,CAAC,OAAO;sBACtC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,SAAS;AACvC,sBAAE,CAAC,SAAS,CAAA;AAEd,gBAAA,OAAO,WAAU;YACnB,CAAC,EACD,EAA8B,CAChC;YAEA,OAAO;AACL,gBAAA,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,KAAK;AACnC,gBAAA,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,iBAAiB;AACpC,gBAAA,WAAW,EAAE;oBACX,GAAG,MAAM,CAAC,KAAK;AACf,oBAAA,GAAG,KAAK,CAAC,gBAAgB,CAAC,WAAW;AACtC,iBAAA;gBACD,OAAO;AACP,gBAAA,IAAI,MAAK,IAAK,EAAE,MAAK,EAAG,CAAC;aAC3B;AACF,QAAA,CAAC,CAAA;AAED;;;;;AAKE;QACF,MAAM,8BAA6B,GAAI,QAAQ,CAAqC,MAClFA,QAAgB,CAAC,OAAM,IAAG;AACxB,YAAA,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,CAAA;AACtF,QAAA,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAC1B;AAEA;;;;AAIE;QACF,KAAK,CAAC,mBAAmB,EAAE,CAAC,UAAU,EAAE,UAAU,KAAG;AACnD,YAAA,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAA,IAAK,CAAC,KAAK,CAAC,eAAe,EAAE;AAChE,gBAAA,8BAA8B,CAAC,KAAK,CAAC,UAAU,CAAA;YACjD;AACF,QAAA,CAAC,CAAA;QAED,MAAM,kBAAiB,GAAI,cAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAA;;AAGtE,QAAA,IAAI,kBAAkB,EAAE,MAAK,KAAM,SAAS,EAAE;AAC5C,YAAA,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAA;YACnC,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,KAAK,EAAE;AACvD,gBAAA,QAAQ,EAAE,CAAC;AACX,gBAAA,WAAW,EAAE,KAAK;AACnB,aAAA,CAAA;QACH;AAAO,aAAA,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE;AACjC,YAAA,8BAA8B,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAA;QAChE;AAEA;;;AAGE;AACF,QAAA,MAAM,EAAE,cAAa,EAAE,GAAI,YAAY,CAAC;AACtC,YAAA,OAAO,EAAE,mBAAmB;YAC5B,QAAQ,EAAE,MAAI;gBACZ,IAAI,KAAK,CAAC,eAAc,IAAK,kBAAkB,EAAE,MAAK,KAAM,SAAS,EAAE;AACrE,oBAAA,8BAA8B,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAA;gBAChE;YACF,CAAC;AACF,SAAA,CAAA;AAED;;;;;AAKE;QACF,eAAe,CAAC,MAAI;YAClB,cAAc,IAAG;AACjB,YAAA,8BAA8B,CAAC,KAAK,CAAC,MAAM,EAAC;AAC5C,YAAA,IAAI,CAAC,IAAI,CACP,uBAAuB,EACvB,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,gBAAgB,EACzE;AACE,gBAAA,QAAQ,EAAE,CAAC;AACX,gBAAA,WAAW,EAAE,KAAK;AACnB,aAAA,CACH;AACF,QAAA,CAAC,CAAA;AAED;;;;;;;AAOE;QACF,KAAK,CACH,8BAA8B,EAC9B,CAAC,IAAwC,EAAE,GAAuC,KAAG;YACnF,GAAG,CAAC,MAAM,EAAC;AACb,QAAA,CAAC,CACH;AAEA,QAAA,MAAM,yBAAwB,GAAI,QAAQ,CAAC,MAAM,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAA;AAElF;;;;AAIE;AACF,QAAA,KAAK,CAAC,yBAAyB,EAAE,MAAI;AACnC,YAAA,IAAI,yBAAyB,CAAC,KAAI,KAAM,SAAS,EAAE;AACjD,gBAAA,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAK,GAAI,MAAK,GAAI,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAA;YACvE;AAAO,iBAAA,IAAI,yBAAyB,CAAC,UAAU,OAAO,EAAE;AACtD,gBAAA,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAA;YACtC;AACF,QAAA,CAAC,CAAA;AAED,QAAA,MAAM,UAAS,GAAI,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAA;AAEpF;;;;;;;;;AASE;AACF,QAAA,SAAS,iBAAiB,GAAA;AACxB,YAAA,MAAM,YAAY;gBAChB,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;AACxC,gBAAA,OAAO,EAAE,mBAAmB,CAAC,KAAK,EAAE,OAAO;AAC3C,gBAAA,YAAY,EAAE,mBAAmB,CAAC,KAAK,EAAE,YAAY;AACrD,gBAAA,cAAc,EAAE,mBAAmB,CAAC,KAAK,EAAE,cAAc;AACzD,gBAAA,YAAY,EAAE,mBAAmB,CAAC,KAAK,EAAE,YAAY;aACvD;YAEA,MAAM,WAAU,GAAI,UAAU,CAAC,KAAI,GAAI,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA,GAAI,EAAC;AAExE,YAAA,OAAO,CAAC,CACN,SAAS,EACT,EAAE,GAAG,EAAE,mBAAmB,EAAE,KAAK,EAAE,yCAAyC,EAC5E,CAAC,WAAW,CAAC,CACf;QACF;AAEA;AAC+E;QAC/E,MAAM,cAAa,GAAI,EAAE,UAAU,EAAE,mBAAmB,EAAE,mBAAkB,EAAE;AAC9E,QAAA,QAAQ,KAAK,CAAC,OAAM,GAAI,iBAAgB,GAAI,cAAc;IAC5D,CAAC;AACF,CAAA,CAAA;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "6.0.0-alpha.200",
+  "version": "6.0.0-alpha.202",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -143,5 +143,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "54fb952d29874732259857df8fbadb4c25e2bca1"
+  "gitHead": "24227b2e9617df5be735f870d67b43d1854f031d"
 }

package/report/x-components.api.json

@@ -49556,7 +49556,16 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n    debounceTimeMs: {\n        type: "
+              "text": ";\n    };\n    loadWhenVisible: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "BooleanConstructor",
+              "canonicalReference": "!BooleanConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n        default: boolean;\n    };\n    debounceTimeMs: {\n        type: "
             },
             {
               "kind": "Reference",
@@ -49637,7 +49646,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    } | undefined>;\n}, {}, {}, {}, import(\"vue\")."
+              "text": ";\n    } | undefined>;\n    queryPreviewElement: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Ref",
+              "canonicalReference": "@vue/reactivity!Ref:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null, "
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null>;\n}, {}, {}, {}, import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -49727,7 +49763,16 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n    debounceTimeMs: {\n        type: "
+              "text": ";\n    };\n    loadWhenVisible: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "BooleanConstructor",
+              "canonicalReference": "!BooleanConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n        default: boolean;\n    };\n    debounceTimeMs: {\n        type: "
             },
             {
               "kind": "Reference",
@@ -49754,7 +49799,7 @@
             },
             {
               "kind": "Content",
-              "text": "<{\n    onLoad?: ((...args: any[]) => any) | undefined;\n    onError?: ((...args: any[]) => any) | undefined;\n}>, {\n    debounceTimeMs: number;\n    persistInCache: boolean;\n}, {}, {}, {}, string, import(\"vue\")."
+              "text": "<{\n    onLoad?: ((...args: any[]) => any) | undefined;\n    onError?: ((...args: any[]) => any) | undefined;\n}>, {\n    loadWhenVisible: boolean;\n    debounceTimeMs: number;\n    persistInCache: boolean;\n}, {}, {}, {}, string, import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -49772,7 +49817,7 @@
           "name": "QueryPreview",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 62
+            "endIndex": 72
           }
         },
         {
@@ -50474,7 +50519,16 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n    debounceTimeMs: {\n        type: "
+              "text": ";\n    };\n    loadWhenVisible: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "BooleanConstructor",
+              "canonicalReference": "!BooleanConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n        default: boolean;\n    };\n    debounceTimeMs: {\n        type: "
             },
             {
               "kind": "Reference",
@@ -50627,7 +50681,16 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n    debounceTimeMs: {\n        type: "
+              "text": ";\n    };\n    loadWhenVisible: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "BooleanConstructor",
+              "canonicalReference": "!BooleanConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n        default: boolean;\n    };\n    debounceTimeMs: {\n        type: "
             },
             {
               "kind": "Reference",
@@ -50681,7 +50744,7 @@
             },
             {
               "kind": "Content",
-              "text": "<{}>, {\n    persistInCache: boolean;\n    debounceTimeMs: number;\n    animation: string | "
+              "text": "<{}>, {\n    persistInCache: boolean;\n    loadWhenVisible: boolean;\n    debounceTimeMs: number;\n    animation: string | "
             },
             {
               "kind": "Reference",
@@ -50726,7 +50789,7 @@
           "name": "QueryPreviewList",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 70
+            "endIndex": 74
           }
         },
         {

package/report/x-components.api.md

@@ -5383,6 +5383,10 @@ type: PropType<QueryFeature>;
 maxItemsToRender: {
 type: NumberConstructor;
 };
+loadWhenVisible: {
+type: BooleanConstructor;
+default: boolean;
+};
 debounceTimeMs: {
 type: NumberConstructor;
 default: number;
@@ -5402,6 +5406,7 @@ totalResults: number;
 instances: number;
 status: RequestStatus;
 } | undefined>;
+queryPreviewElement: Ref<HTMLElement | null, HTMLElement | null>;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("load" | "error")[], "load" | "error", PublicProps, Readonly<ExtractPropTypes<    {
 queryPreviewInfo: {
 type: PropType<QueryPreviewInfo>;
@@ -5413,6 +5418,10 @@ type: PropType<QueryFeature>;
 maxItemsToRender: {
 type: NumberConstructor;
 };
+loadWhenVisible: {
+type: BooleanConstructor;
+default: boolean;
+};
 debounceTimeMs: {
 type: NumberConstructor;
 default: number;
@@ -5425,6 +5434,7 @@ default: boolean;
 onLoad?: ((...args: any[]) => any) | undefined;
 onError?: ((...args: any[]) => any) | undefined;
 }>, {
+loadWhenVisible: boolean;
 debounceTimeMs: number;
 persistInCache: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
@@ -5484,6 +5494,10 @@ type: PropType<QueryFeature>;
 maxItemsToRender: {
 type: NumberConstructor;
 };
+loadWhenVisible: {
+type: BooleanConstructor;
+default: boolean;
+};
 debounceTimeMs: {
 type: NumberConstructor;
 default: number;
@@ -5508,6 +5522,10 @@ type: PropType<QueryFeature>;
 maxItemsToRender: {
 type: NumberConstructor;
 };
+loadWhenVisible: {
+type: BooleanConstructor;
+default: boolean;
+};
 debounceTimeMs: {
 type: NumberConstructor;
 default: number;
@@ -5519,6 +5537,7 @@ default: string;
 };
 }>> & Readonly<{}>, {
 persistInCache: boolean;
+loadWhenVisible: boolean;
 debounceTimeMs: number;
 animation: string | Function | Record<string, any>;
 }, {}, {

package/types/x-modules/queries-preview/components/query-preview-list.vue.d.ts

@@ -34,9 +34,19 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     maxItemsToRender: {
         type: NumberConstructor;
     };
+    /**
+     * Controls whether the query preview requests should be triggered when the component is visible in the viewport.
+     *
+     * @public
+     */
+    loadWhenVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Debounce time in milliseconds for triggering the search requests
      * on each query preview.
+     *
      * It will default to 0 to fit the most common use case (pre-search),
      * and it would work properly with a 250 value inside empathize.
      */
@@ -90,9 +100,19 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     maxItemsToRender: {
         type: NumberConstructor;
     };
+    /**
+     * Controls whether the query preview requests should be triggered when the component is visible in the viewport.
+     *
+     * @public
+     */
+    loadWhenVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Debounce time in milliseconds for triggering the search requests
      * on each query preview.
+     *
      * It will default to 0 to fit the most common use case (pre-search),
      * and it would work properly with a 250 value inside empathize.
      */
@@ -118,6 +138,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     };
 }>> & Readonly<{}>, {
     persistInCache: boolean;
+    loadWhenVisible: boolean;
     debounceTimeMs: number;
     animation: string | Function | Record<string, any>;
 }, {}, {

package/types/x-modules/queries-preview/components/query-preview-list.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-preview-list.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/components/query-preview-list.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AAEnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAYtD;;;;;;GAMG;;IAMC;;;;OAIG;;cAEc,QAAQ,CAAC,gBAAgB,EAAE,CAAC;;;IAG7C;;;;OAIG;;cAEe,QAAQ,CAAC,YAAY,CAAC;;IAExC;;;;OAIG;;;;IAIH;;;;;OAKG;;;;;IAKH;;;;;OAKG;;IAEH;;;;OAIG;;;;;;;gCAgGgC,MAAM,KAAG,IAAI;gCAXb,MAAM,KAAG,IAAI;;IAnIhD;;;;OAIG;;cAEc,QAAQ,CAAC,gBAAgB,EAAE,CAAC;;;IAG7C;;;;OAIG;;cAEe,QAAQ,CAAC,YAAY,CAAC;;IAExC;;;;OAIG;;;;IAIH;;;;;OAKG;;;;;IAKH;;;;;OAKG;;IAEH;;;;OAIG;;;;;;;;;;;;AAnDP,wBA8JE"}
+{"version":3,"file":"query-preview-list.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/components/query-preview-list.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AAEnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAYtD;;;;;;GAMG;;IAMC;;;;OAIG;;cAEc,QAAQ,CAAC,gBAAgB,EAAE,CAAC;;;IAG7C;;;;OAIG;;cAEe,QAAQ,CAAC,YAAY,CAAC;;IAExC;;;;OAIG;;;;IAIH;;;;OAIG;;;;;IAKH;;;;;;OAMG;;;;;IAKH;;;;;OAKG;;IAEH;;;;OAIG;;;;;;;gCAgGgC,MAAM,KAAG,IAAI;gCAXb,MAAM,KAAG,IAAI;;IA7IhD;;;;OAIG;;cAEc,QAAQ,CAAC,gBAAgB,EAAE,CAAC;;;IAG7C;;;;OAIG;;cAEe,QAAQ,CAAC,YAAY,CAAC;;IAExC;;;;OAIG;;;;IAIH;;;;OAIG;;;;;IAKH;;;;;;OAMG;;;;;IAKH;;;;;OAKG;;IAEH;;;;OAIG;;;;;;;;;;;;;AA7DP,wBAwKE"}

package/types/x-modules/queries-preview/components/query-preview.vue.d.ts

@@ -1,5 +1,5 @@
 import type { SearchRequest } from '@empathyco/x-types';
-import type { PropType } from 'vue';
+import type { PropType, Ref } from 'vue';
 import type { QueryFeature } from '../../../types';
 import type { QueryPreviewInfo } from '../store/types';
 /**
@@ -23,6 +23,13 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     maxItemsToRender: {
         type: NumberConstructor;
     };
+    /**
+     * Controls whether the query preview requests should be triggered when the component is visible in the viewport.
+     */
+    loadWhenVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Debounce time in milliseconds for triggering the search requests.
      * It will default to 0 to fit the most common use case (pre-search),
@@ -51,6 +58,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         instances: number;
         status: import("../../..").RequestStatus;
     } | undefined>;
+    queryPreviewElement: Ref<HTMLElement | null, HTMLElement | null>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("load" | "error")[], "load" | "error", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /** The information about the request of the query preview. */
     queryPreviewInfo: {
@@ -65,6 +73,13 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     maxItemsToRender: {
         type: NumberConstructor;
     };
+    /**
+     * Controls whether the query preview requests should be triggered when the component is visible in the viewport.
+     */
+    loadWhenVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
     /**
      * Debounce time in milliseconds for triggering the search requests.
      * It will default to 0 to fit the most common use case (pre-search),
@@ -86,6 +101,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     onLoad?: ((...args: any[]) => any) | undefined;
     onError?: ((...args: any[]) => any) | undefined;
 }>, {
+    loadWhenVisible: boolean;
     debounceTimeMs: number;
     persistInCache: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

package/types/x-modules/queries-preview/components/query-preview.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-preview.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/components/query-preview.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAU,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,KAAK,EAAE,QAAQ,EAAO,MAAM,KAAK,CAAA;AACxC,OAAO,KAAK,EAAmB,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAEnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAStD;;;;;;GAMG;;IAKC,8DAA8D;;cAE5C,QAAQ,CAAC,gBAAgB,CAAC;;;IAG5C,2CAA2C;;cAEzB,QAAQ,CAAC,YAAY,CAAC;;IAExC,sDAAsD;;;;IAItD;;;;OAIG;;;;;IAKH;;;OAGG;;;;;;;;;;;;;;;;;IAzBH,8DAA8D;;cAE5C,QAAQ,CAAC,gBAAgB,CAAC;;;IAG5C,2CAA2C;;cAEzB,QAAQ,CAAC,YAAY,CAAC;;IAExC,sDAAsD;;;;IAItD;;;;OAIG;;;;;IAKH;;;OAGG;;;;;;;;;;;;AA7BP,wBA2PE"}
+{"version":3,"file":"query-preview.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/queries-preview/components/query-preview.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAU,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AACxC,OAAO,KAAK,EAAmB,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAEnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAStD;;;;;;GAMG;;IAKC,8DAA8D;;cAE5C,QAAQ,CAAC,gBAAgB,CAAC;;;IAG5C,2CAA2C;;cAEzB,QAAQ,CAAC,YAAY,CAAC;;IAExC,sDAAsD;;;;IAItD;;OAEG;;;;;IAKH;;;;OAIG;;;;;IAKH;;;OAGG;;;;;;;;;;;;;;;;;;IAhCH,8DAA8D;;cAE5C,QAAQ,CAAC,gBAAgB,CAAC;;;IAG5C,2CAA2C;;cAEzB,QAAQ,CAAC,YAAY,CAAC;;IAExC,sDAAsD;;;;IAItD;;OAEG;;;;;IAKH;;;;OAIG;;;;;IAKH;;;OAGG;;;;;;;;;;;;;AApCP,wBA2RE"}