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

package/js/components/base-dropdown.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-dropdown.vue2.js","sources":["../../../src/components/base-dropdown.vue"],"sourcesContent":["<template>\n  <div\n    ref=\"rootRef\"\n    @keydown=\"updateSearchBuffer\"\n    @keydown.down.prevent=\"highlightNextItem\"\n    @keydown.up.prevent=\"highlightPreviousItem\"\n    :class=\"dropdownCSSClasses\"\n    class=\"x-dropdown\"\n  >\n    <button\n      ref=\"toggleButtonRef\"\n      @click=\"toggle\"\n      @keydown.up.down.prevent.stop=\"open\"\n      class=\"x-dropdown__toggle\"\n      data-test=\"dropdown-toggle\"\n      role=\"combobox\"\n      aria-haspopup=\"listbox\"\n      :aria-expanded=\"isOpen.toString()\"\n      :aria-controls=\"listId\"\n      :aria-label=\"ariaLabel\"\n      aria-autocomplete=\"none\"\n    >\n      <!--\n       @slot Used to render the contents of the dropdown toggle button. If not provided, it uses\n       the item slot as fallback.\n       @binding {string|number|Identifiable} item - The item data to render.\n       @binding {boolean} isOpen - True if the dropdown is opened, and false if it is closed.\n     -->\n      <slot v-if=\"hasToggleSlot\" :isOpen=\"isOpen\" :item=\"modelValue\" name=\"toggle\">\n        {{ modelValue }}\n      </slot>\n      <slot v-else :item=\"modelValue\" name=\"item\">{{ modelValue }}</slot>\n    </button>\n\n    <component :is=\"animation\">\n      <ul\n        v-show=\"isOpen\"\n        @keydown.end=\"highlightLastItem\"\n        @keydown.esc=\"closeAndFocusToggleButton\"\n        @keydown.home=\"highlightFirstItem\"\n        :id=\"listId\"\n        class=\"x-dropdown__items-list\"\n        data-test=\"dropdown-list\"\n        role=\"listbox\"\n        tabindex=\"-1\"\n      >\n        <li v-for=\"(item, index) in items\" :key=\"item.id || item\" class=\"x-dropdown__list-item\">\n          <button\n            :ref=\"el => (itemsButtonRefs[index] = el)\"\n            @click=\"emitSelectedItemChanged(item)\"\n            :aria-selected=\"(item === modelValue).toString()\"\n            :class=\"itemsCSSClasses[index]\"\n            class=\"x-dropdown__item\"\n            data-test=\"dropdown-item\"\n            role=\"option\"\n          >\n            <!--\n               @slot (required) Used to render each one of the items content, and as fallback\n               for the toggle button content slot if it is not provided.\n               @binding {string|number|Identifiable} item - Item to render\n               @binding {boolean} isHighlighted - True when the item has the focus.\n               @binding {boolean} isSelected - True when the item is selected.\n             -->\n            <slot\n              :isHighlighted=\"index === highlightedItemIndex\"\n              :isSelected=\"item === modelValue\"\n              :item=\"item\"\n              name=\"item\"\n            >\n              {{ item }}\n            </slot>\n          </button>\n        </li>\n      </ul>\n    </component>\n  </div>\n</template>\n\n<script lang=\"ts\">\n  import { Identifiable } from '@empathyco/x-types';\n  import { computed, defineComponent, nextTick, onBeforeUnmount, PropType, ref, watch } from 'vue';\n  import { AnimationProp } from '../types';\n  import { debounceFunction, normalizeString, getTargetElement, isInRange } from '../utils';\n  import { NoAnimation } from './animations';\n\n  type DropdownItem = string | number | Identifiable;\n  let dropdownCount = 0;\n\n  /**\n   * Dropdown component that mimics a Select element behavior, but with the option\n   * to customize the toggle button and each item contents.\n   */\n  export default defineComponent({\n    name: 'BaseDropdown',\n    props: {\n      /** List of items to display.*/\n      items: {\n        type: Array as PropType<DropdownItem[]>,\n        required: true\n      },\n      /** The selected item. */\n      modelValue: {\n        type: null as unknown as PropType<DropdownItem | null>,\n        validator: (v: any) =>\n          typeof v === 'string' || typeof v === 'number' || typeof v === 'object' || v === null,\n        required: true\n      },\n      /** Description of what the dropdown is used for. */\n      ariaLabel: String,\n      /**\n       * Animation component to use for expanding the dropdown. This is a single element animation,\n       * so only `<transition>` components are allowed.\n       */\n      animation: {\n        type: AnimationProp,\n        default: () => NoAnimation\n      },\n      /** Time to wait without receiving any keystroke before resetting the items search query. */\n      searchTimeoutMs: {\n        type: Number,\n        default: 1000\n      }\n    },\n    emits: ['update:modelValue'],\n    setup(props, { emit, slots }) {\n      const rootRef = ref<HTMLElement>();\n      /** The button that opens and closes the list of options. */\n      const toggleButtonRef = ref<HTMLButtonElement>();\n      /** Array containing the dropdown list buttons HTMLElements. */\n      const itemsButtonRefs = ref<HTMLButtonElement[]>([]);\n\n      /** Property to check whether the dropdown is expanded or closed. */\n      const isOpen = ref(false);\n      /** Index of the element that has the focus in the list. -1 means no element has focus. */\n      const highlightedItemIndex = ref(-1);\n      /** String to search for the first element that starts with it. */\n      const searchBuffer = ref('');\n\n      /** Resets the search buffer after a certain time has passed. */\n      let restartResetSearchTimeout: () => void;\n      /* Unique ID to identify the dropdown. */\n      const listId = `x-dropdown-${dropdownCount++}`;\n\n      /**\n       * Dynamic CSS classes to add to the dropdown root element.\n       *\n       * @returns An object containing the CSS classes to add to the dropdown root element.\n       */\n      const dropdownCSSClasses = computed(() => ({ 'x-dropdown--is-open': isOpen }));\n\n      /**\n       * Dynamic CSS classes to add to each one of the items.\n       *\n       * @returns An object containing the CSS classes to add to each item.\n       */\n      const itemsCSSClasses = computed(() =>\n        props.items.map((item, index) => ({\n          'x-dropdown__item--is-selected': props.modelValue === item,\n          'x-dropdown__item--is-highlighted': highlightedItemIndex.value === index\n        }))\n      );\n\n      /* Opens the dropdown. */\n      const open = () => (isOpen.value = true);\n      /* Closes the dropdown. */\n      const close = () => (isOpen.value = false);\n      /* Toggles the dropdown. */\n      const toggle = () => (isOpen.value = !isOpen.value);\n\n      /**\n       * Closes the modal and focuses the toggle button.\n       */\n      function closeAndFocusToggleButton() {\n        close();\n        toggleButtonRef.value?.focus();\n      }\n\n      /**\n       * Emits the event that the selected item has changed.\n       *\n       * @param item - The new selected item.\n       */\n      function emitSelectedItemChanged(item: DropdownItem) {\n        emit('update:modelValue', item);\n        closeAndFocusToggleButton();\n      }\n\n      /**\n       * Highlights the item after the one that is currently highlighted.\n       */\n      function highlightNextItem() {\n        open();\n        highlightedItemIndex.value = (highlightedItemIndex.value + 1) % props.items.length;\n      }\n\n      /**\n       * Highlights the item before the one that is currently highlighted.\n       */\n      function highlightPreviousItem() {\n        const currentIndex = highlightedItemIndex.value;\n        open();\n        highlightedItemIndex.value = currentIndex > 0 ? currentIndex - 1 : props.items.length - 1;\n      }\n\n      /**\n       * Highlights the first of the provided items.\n       */\n      function highlightFirstItem() {\n        highlightedItemIndex.value = 0;\n      }\n\n      /**\n       * Highlights the last of the provided items.\n       */\n      function highlightLastItem() {\n        highlightedItemIndex.value = props.items.length - 1;\n      }\n\n      /**\n       * Updates the variable that is used to search in the filters.\n       *\n       * @param event - The event coming from the user typing.\n       */\n      function updateSearchBuffer(event: KeyboardEvent) {\n        if (/^\\w$/.test(event.key)) {\n          const key = event.key;\n          searchBuffer.value += key;\n          restartResetSearchTimeout();\n        }\n      }\n\n      /**\n       * Resets the search buffer.\n       */\n      function resetSearchBuffer() {\n        searchBuffer.value = '';\n      }\n\n      /**\n       * Closes the dropdown if the passed event has happened on an element out of the dropdown.\n       *\n       * @param event - The event to check if it has happened out of the dropdown component.\n       */\n      function closeIfEventIsOutOfDropdown(event: MouseEvent | TouchEvent | FocusEvent) {\n        if (!rootRef.value?.contains(getTargetElement(event))) {\n          close();\n        }\n      }\n\n      /**\n       * Adds listeners to the document element to detect if the focus has moved out from the\n       * dropdown.\n       */\n      function addDocumentCloseListeners() {\n        document.addEventListener('mousedown', closeIfEventIsOutOfDropdown);\n        document.addEventListener('touchstart', closeIfEventIsOutOfDropdown);\n        document.addEventListener('focusin', closeIfEventIsOutOfDropdown);\n      }\n\n      /**\n       * Removes the listeners of the document element to detect if the focus has moved out from the\n       * dropdown.\n       */\n      function removeDocumentCloseListeners() {\n        document.removeEventListener('mousedown', closeIfEventIsOutOfDropdown);\n        document.removeEventListener('touchstart', closeIfEventIsOutOfDropdown);\n        document.removeEventListener('focusin', closeIfEventIsOutOfDropdown);\n      }\n\n      /**\n       * Highlights the item that matches the search buffer. To do so it checks the list buttons\n       * text content. It highlights items following this priority:\n       * - If an element is already highlighted, it starts searching from that element.\n       * - If no element is found starting from the previously highlighted, it returns the first one.\n       * - If no element is found matching the search query it highlights the first element.\n       *\n       * @param search - The search string to find in the HTML.\n       */\n      watch(searchBuffer, search => {\n        if (search) {\n          const normalizedSearch = normalizeString(search);\n          const matchingIndices = itemsButtonRefs?.value?.reduce<number[]>(\n            (matchingIndices, button, index) => {\n              const safeButtonWordCharacters = button.textContent!.replace(/[^\\w]/g, '');\n              const normalizedButtonText = normalizeString(safeButtonWordCharacters);\n              if (normalizedButtonText.startsWith(normalizedSearch)) {\n                matchingIndices.push(index);\n              }\n              return matchingIndices;\n            },\n            []\n          );\n          highlightedItemIndex.value =\n            // First matching item starting to search from the current highlighted element\n            matchingIndices?.find(index => index >= highlightedItemIndex.value) ??\n            // First matching item\n            matchingIndices?.[0] ??\n            // First item\n            0;\n        }\n      });\n\n      /**\n       * Updates the debounced function to reset the search.\n       *\n       * @param searchTimeoutMs - The new milliseconds that have to pass without typing before\n       * resetting the search.\n       */\n      watch(\n        () => props.searchTimeoutMs,\n        searchTimeoutMs => {\n          restartResetSearchTimeout = debounceFunction(resetSearchBuffer, searchTimeoutMs);\n        },\n        { immediate: true }\n      );\n\n      /**\n       * Focuses the DOM element which matches the `highlightedItemIndex`.\n       *\n       * @param highlightedItemIndex - The index of the HTML element to focus.\n       */\n      watch(\n        highlightedItemIndex,\n        highlightedItemIndex => {\n          nextTick(() => {\n            if (itemsButtonRefs && isInRange(highlightedItemIndex, [0, props.items.length - 1])) {\n              const newItem = itemsButtonRefs?.value?.[highlightedItemIndex];\n              newItem?.focus();\n            }\n          });\n        },\n        { immediate: true }\n      );\n\n      /**\n       * When the dropdown is open it sets the focused element to the one that is selected.\n       *\n       * @param isOpen - True if the dropdown is open, false otherwise.\n       */\n      watch(isOpen, isOpen => {\n        highlightedItemIndex.value = isOpen\n          ? props.modelValue === null\n            ? 0\n            : props.items.indexOf(props.modelValue)\n          : -1;\n      });\n\n      /**\n       * Adds and removes listeners to close the dropdown when it loses the focus.\n       *\n       * @param isOpen - True if the dropdown is open, false otherwise.\n       */\n      watch(isOpen, isOpen => {\n        /*\n         * Because there is an issue with Firefox in macOS and Safari that doesn't focus the target\n         * element of the `mousedown` events, the `focusout` event `relatedTarget` property can't be\n         * used to detect whether the user has blurred the dropdown. The hack here is to use\n         * document listeners that have the side effect of losing the focus.\n         */\n        if (isOpen) {\n          addDocumentCloseListeners();\n        } else {\n          removeDocumentCloseListeners();\n        }\n      });\n\n      /**\n       * If the dropdown is destroyed before removing the document listeners, it ensures that they\n       * are removed too.\n       */\n      onBeforeUnmount(() => {\n        removeDocumentCloseListeners();\n      });\n\n      return {\n        hasToggleSlot: !!slots.toggle,\n        closeAndFocusToggleButton,\n        dropdownCSSClasses,\n        emitSelectedItemChanged,\n        highlightFirstItem,\n        highlightLastItem,\n        highlightNextItem,\n        highlightPreviousItem,\n        highlightedItemIndex,\n        isOpen,\n        itemsButtonRefs,\n        itemsCSSClasses,\n        listId,\n        open,\n        rootRef,\n        toggle,\n        toggleButtonRef,\n        updateSearchBuffer\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-dropdown {\n    position: relative;\n  }\n\n  .x-dropdown__items-list {\n    z-index: 1;\n    list-style: none;\n    position: absolute;\n    padding: 0;\n    margin: 0;\n    top: calc(100% + var(--x-size-gap-dropdown-default, 0));\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Example\n\nThe `Dropdown` component is a simple yet customizable select component. The component needs to work\nthe list of items available to select, which are passed using the `items` prop, and the selected\nitem, which is passed in using the `value` prop.\n\nThe supported items must be an array that can contain unique strings, unique numbers, or objects\nwith a unique `id` property.\n\nThe content of each item can be customized using the `item` slot, which apart from the data of the\nitem, it also receives via prop if the element is selected or highlighted.\n\nThere `toggle` slot can be used to customize the button that opens the dropdown. If this is not\nprovided, the `item` slot will be used for that.\n\n```vue\n<template>\n  <BaseDropdown v-model=\"value\" :items=\"items\">\n    <template #toggle=\"{ item, isOpen }\">{{ item }} {{ isOpen ? '🔼' : '🔽' }}️</template>\n\n    <template #item=\"{ item, isSelected, isHighlighted }\">\n      <span v-if=\"isHighlighted\">🟢</span>\n      <span v-if=\"isSelected\">✅</span>\n      <span>{{ item }}</span>\n    </template>\n  </BaseDropdown>\n</template>\n\n<script>\n  import { BaseDropdown } from '@empathyco/x-components';\n\n  export default {\n    name: 'DropdownTest',\n    components: {\n      BaseDropdown\n    },\n    data() {\n      return {\n        items: ['a', 2, { id: '3' }],\n        value: 'a'\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["NoAnimation","debounceFunction"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAsFE,IAAI,aAAY,GAAI,CAAC,CAAA;AAErB;;;AAGE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,cAAc;AACpB,IAAA,KAAK,EAAE;;AAEL,QAAA,KAAK,EAAE;AACL,YAAA,IAAI,EAAE,KAAiC;AACvC,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;;AAED,QAAA,UAAU,EAAE;AACV,YAAA,IAAI,EAAE,IAAgD;YACtD,SAAS,EAAE,CAAC,CAAM,KAChB,OAAO,CAAA,KAAM,QAAO,IAAK,OAAO,CAAA,KAAM,QAAO,IAAK,OAAO,CAAE,KAAI,YAAY,CAAE,KAAI,IAAI;AACvF,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;;AAED,QAAA,SAAS,EAAE,MAAM;AACjB;;;AAGE;AACF,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,MAAMA,WAAU;AAC1B,SAAA;;AAED,QAAA,eAAe,EAAE;AACf,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,IAAG;AACd,SAAA;AACD,KAAA;IACD,KAAK,EAAE,CAAC,mBAAmB,CAAC;AAC5B,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAM,EAAC,EAAA;AAC1B,QAAA,MAAM,OAAQ,GAAE,GAAG,EAAe,CAAA;;AAElC,QAAA,MAAM,kBAAkB,GAAG,EAAqB,CAAA;;AAEhD,QAAA,MAAM,eAAc,GAAI,GAAG,CAAsB,EAAE,CAAC,CAAA;;AAGpD,QAAA,MAAM,MAAK,GAAI,GAAG,CAAC,KAAK,CAAC,CAAA;;AAEzB,QAAA,MAAM,oBAAmB,GAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;;AAEpC,QAAA,MAAM,YAAW,GAAI,GAAG,CAAC,EAAE,CAAC,CAAA;;AAG5B,QAAA,IAAI,yBAAqC,CAAA;;AAEzC,QAAA,MAAM,MAAO,GAAE,CAAA,WAAA,EAAc,aAAa,EAAE,EAAE,CAAA;AAE9C;;;;AAIE;AACF,QAAA,MAAM,kBAAiB,GAAI,QAAQ,CAAC,OAAO,EAAE,qBAAqB,EAAE,MAAO,EAAC,CAAC,CAAC,CAAA;AAE9E;;;;AAIE;QACF,MAAM,eAAc,GAAI,QAAQ,CAAC,MAC/B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,MAAM;AAChC,YAAA,+BAA+B,EAAE,KAAK,CAAC,UAAS,KAAM,IAAI;AAC1D,YAAA,kCAAkC,EAAE,oBAAoB,CAAC,KAAM,KAAI,KAAI;SACxE,CAAC,CAAA,CACH,CAAA;;AAGD,QAAA,MAAM,IAAG,GAAI,OAAO,MAAM,CAAC,KAAI,GAAI,IAAI,CAAC,CAAA;;AAExC,QAAA,MAAM,KAAI,GAAI,OAAO,MAAM,CAAC,KAAI,GAAI,KAAK,CAAC,CAAA;;AAE1C,QAAA,MAAM,SAAS,OAAO,MAAM,CAAC,KAAM,GAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAEnD;;AAEE;AACF,QAAA,SAAS,yBAAyB,GAAA;AAChC,YAAA,KAAK,EAAE,CAAA;AACP,YAAA,eAAe,CAAC,KAAK,EAAE,KAAK,EAAE,CAAA;SAChC;AAEA;;;;AAIE;QACF,SAAS,uBAAuB,CAAC,IAAkB,EAAA;AACjD,YAAA,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAA;AAC/B,YAAA,yBAAyB,EAAE,CAAA;SAC7B;AAEA;;AAEE;AACF,QAAA,SAAS,iBAAiB,GAAA;AACxB,YAAA,IAAI,EAAE,CAAA;AACN,YAAA,oBAAoB,CAAC,QAAQ,CAAC,oBAAoB,CAAC,KAAI,GAAI,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAA;SACpF;AAEA;;AAEE;AACF,QAAA,SAAS,qBAAqB,GAAA;AAC5B,YAAA,MAAM,eAAe,oBAAoB,CAAC,KAAK,CAAA;AAC/C,YAAA,IAAI,EAAE,CAAA;YACN,oBAAoB,CAAC,QAAQ,YAAa,GAAE,IAAI,YAAa,GAAE,IAAI,KAAK,CAAC,KAAK,CAAC,MAAK,GAAI,CAAC,CAAA;SAC3F;AAEA;;AAEE;AACF,QAAA,SAAS,kBAAkB,GAAA;AACzB,YAAA,oBAAoB,CAAC,KAAM,GAAE,CAAC,CAAA;SAChC;AAEA;;AAEE;AACF,QAAA,SAAS,iBAAiB,GAAA;YACxB,oBAAoB,CAAC,KAAI,GAAI,KAAK,CAAC,KAAK,CAAC,MAAO,GAAE,CAAC,CAAA;SACrD;AAEA;;;;AAIE;QACF,SAAS,kBAAkB,CAAC,KAAoB,EAAA;YAC9C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;AAC1B,gBAAA,MAAM,GAAI,GAAE,KAAK,CAAC,GAAG,CAAA;AACrB,gBAAA,YAAY,CAAC,SAAS,GAAG,CAAA;AACzB,gBAAA,yBAAyB,EAAE,CAAA;AAC7B,aAAA;SACF;AAEA;;AAEE;AACF,QAAA,SAAS,iBAAiB,GAAA;AACxB,YAAA,YAAY,CAAC,KAAM,GAAE,EAAE,CAAA;SACzB;AAEA;;;;AAIE;QACF,SAAS,2BAA2B,CAAC,KAA2C,EAAA;AAC9E,YAAA,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE;AACrD,gBAAA,KAAK,EAAE,CAAA;AACT,aAAA;SACF;AAEA;;;AAGE;AACF,QAAA,SAAS,yBAAyB,GAAA;AAChC,YAAA,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAA;AACnE,YAAA,QAAQ,CAAC,gBAAgB,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAA;AACpE,YAAA,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,2BAA2B,CAAC,CAAA;SACnE;AAEA;;;AAGE;AACF,QAAA,SAAS,4BAA4B,GAAA;AACnC,YAAA,QAAQ,CAAC,mBAAmB,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAA;AACtE,YAAA,QAAQ,CAAC,mBAAmB,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAA;AACvE,YAAA,QAAQ,CAAC,mBAAmB,CAAC,SAAS,EAAE,2BAA2B,CAAC,CAAA;SACtE;AAEA;;;;;;;;AAQE;AACF,QAAA,KAAK,CAAC,YAAY,EAAE,MAAO,IAAG;AAC5B,YAAA,IAAI,MAAM,EAAE;AACV,gBAAA,MAAM,gBAAiB,GAAE,eAAe,CAAC,MAAM,CAAC,CAAA;AAChD,gBAAA,MAAM,eAAc,GAAI,eAAe,EAAE,KAAK,EAAE,MAAM,CACpD,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,KAAK;AAClC,oBAAA,MAAM,wBAAyB,GAAE,MAAM,CAAC,WAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;AAC1E,oBAAA,MAAM,oBAAqB,GAAE,eAAe,CAAC,wBAAwB,CAAC,CAAA;AACtE,oBAAA,IAAI,oBAAoB,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;AACrD,wBAAA,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAC7B,qBAAA;AACA,oBAAA,OAAO,eAAe,CAAA;iBACvB,EACD,EAAC,CACF,CAAA;AACD,gBAAA,oBAAoB,CAAC,KAAM;;AAEzB,oBAAA,eAAe,EAAE,IAAI,CAAC,KAAI,IAAK,KAAI,IAAK,oBAAoB,CAAC,KAAK;;wBAElE,eAAe,GAAG,CAAC;;AAEnB,wBAAA,CAAC,CAAA;AACL,aAAA;AACF,SAAC,CAAC,CAAA;AAEF;;;;;AAKE;QACF,KAAK,CACH,MAAM,KAAK,CAAC,eAAe,EAC3B,eAAc,IAAK;AACjB,YAAA,yBAAwB,GAAIC,QAAgB,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAA;AAClF,SAAC,EACD,EAAE,SAAS,EAAE,IAAK,EAAA,CACnB,CAAA;AAED;;;;AAIE;AACF,QAAA,KAAK,CACH,oBAAoB,EACpB,oBAAmB,IAAK;YACtB,QAAQ,CAAC,MAAM;AACb,gBAAA,IAAI,eAAc,IAAK,SAAS,CAAC,oBAAoB,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAO,GAAE,CAAC,CAAC,CAAC,EAAE;oBACnF,MAAM,OAAM,GAAI,eAAe,EAAE,KAAK,GAAG,oBAAoB,CAAC,CAAA;oBAC9D,OAAO,EAAE,KAAK,EAAE,CAAA;AAClB,iBAAA;AACF,aAAC,CAAC,CAAA;AACJ,SAAC,EACD,EAAE,SAAS,EAAE,IAAK,EAAA,CACnB,CAAA;AAED;;;;AAIE;AACF,QAAA,KAAK,CAAC,MAAM,EAAE,MAAK,IAAK;YACtB,oBAAoB,CAAC,KAAI,GAAI,MAAK;AAChC,kBAAE,KAAK,CAAC,UAAS,KAAM,IAAG;AACxB,sBAAE,CAAA;sBACA,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAA;kBACtC,CAAC,CAAC,CAAA;AACR,SAAC,CAAC,CAAA;AAEF;;;;AAIE;AACF,QAAA,KAAK,CAAC,MAAM,EAAE,MAAK,IAAK;AACtB;;;;;AAKE;AACF,YAAA,IAAI,MAAM,EAAE;AACV,gBAAA,yBAAyB,EAAE,CAAA;AAC3B,aAAA;AAAK,iBAAA;AACL,gBAAA,4BAA4B,EAAE,CAAA;AAChC,aAAA;AACF,SAAC,CAAC,CAAA;AAEF;;;AAGE;QACF,eAAe,CAAC,MAAM;AACpB,YAAA,4BAA4B,EAAE,CAAA;AAChC,SAAC,CAAC,CAAA;QAEF,OAAO;AACL,YAAA,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM;YAC7B,yBAAyB;YACzB,kBAAkB;YAClB,uBAAuB;YACvB,kBAAkB;YAClB,iBAAiB;YACjB,iBAAiB;YACjB,qBAAqB;YACrB,oBAAoB;YACpB,MAAM;YACN,eAAe;YACf,eAAe;YACf,MAAM;YACN,IAAI;YACJ,OAAO;YACP,MAAM;YACN,eAAe;YACf,kBAAiB;SAClB,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"base-dropdown.vue2.js","sources":["../../../src/components/base-dropdown.vue"],"sourcesContent":["<template>\n  <div\n    ref=\"rootRef\"\n    :class=\"dropdownCSSClasses\"\n    class=\"x-dropdown\"\n    @keydown=\"updateSearchBuffer\"\n    @keydown.down.prevent=\"highlightNextItem\"\n    @keydown.up.prevent=\"highlightPreviousItem\"\n  >\n    <button\n      ref=\"toggleButtonRef\"\n      class=\"x-dropdown__toggle\"\n      data-test=\"dropdown-toggle\"\n      role=\"combobox\"\n      aria-haspopup=\"listbox\"\n      :aria-expanded=\"isOpen.toString()\"\n      :aria-controls=\"listId\"\n      :aria-label=\"ariaLabel\"\n      aria-autocomplete=\"none\"\n      @click=\"toggle\"\n      @keydown.up.down.prevent.stop=\"open\"\n    >\n      <!--\n       @slot Used to render the contents of the dropdown toggle button. If not provided, it uses\n       the item slot as fallback.\n       @binding {string|number|Identifiable} item - The item data to render.\n       @binding {boolean} isOpen - True if the dropdown is opened, and false if it is closed.\n     -->\n      <slot v-if=\"hasToggleSlot\" :is-open=\"isOpen\" :item=\"modelValue\" name=\"toggle\">\n        {{ modelValue }}\n      </slot>\n      <slot v-else :item=\"modelValue\" name=\"item\">{{ modelValue }}</slot>\n    </button>\n\n    <component :is=\"animation\">\n      <ul\n        v-show=\"isOpen\"\n        :id=\"listId\"\n        class=\"x-dropdown__items-list\"\n        data-test=\"dropdown-list\"\n        role=\"listbox\"\n        tabindex=\"-1\"\n        @keydown.end=\"highlightLastItem\"\n        @keydown.esc=\"closeAndFocusToggleButton\"\n        @keydown.home=\"highlightFirstItem\"\n      >\n        <li v-for=\"(item, index) in items\" :key=\"item.id || item\" class=\"x-dropdown__list-item\">\n          <button\n            :ref=\"el => (itemsButtonRefs[index] = el)\"\n            :aria-selected=\"(item === modelValue).toString()\"\n            :class=\"itemsCSSClasses[index]\"\n            class=\"x-dropdown__item\"\n            data-test=\"dropdown-item\"\n            role=\"option\"\n            @click=\"emitSelectedItemChanged(item)\"\n          >\n            <!--\n               @slot (required) Used to render each one of the items content, and as fallback\n               for the toggle button content slot if it is not provided.\n               @binding {string|number|Identifiable} item - Item to render\n               @binding {boolean} isHighlighted - True when the item has the focus.\n               @binding {boolean} isSelected - True when the item is selected.\n             -->\n            <slot\n              :is-highlighted=\"index === highlightedItemIndex\"\n              :is-selected=\"item === modelValue\"\n              :item=\"item\"\n              name=\"item\"\n            >\n              {{ item }}\n            </slot>\n          </button>\n        </li>\n      </ul>\n    </component>\n  </div>\n</template>\n\n<script lang=\"ts\">\nimport type { Identifiable } from '@empathyco/x-types'\nimport type { PropType } from 'vue'\nimport { computed, defineComponent, nextTick, onBeforeUnmount, ref, watch } from 'vue'\nimport { AnimationProp } from '../types'\nimport { debounceFunction, getTargetElement, normalizeString } from '../utils'\nimport { NoAnimation } from './animations'\n\ntype DropdownItem = string | number | Identifiable\nlet dropdownCount = 0\n\n/**\n * Dropdown component that mimics a Select element behavior, but with the option\n * to customize the toggle button and each item contents.\n */\nexport default defineComponent({\n  name: 'BaseDropdown',\n  props: {\n    /** List of items to display.*/\n    items: {\n      type: Array as PropType<DropdownItem[]>,\n      required: true,\n    },\n    /** The selected item. */\n    modelValue: {\n      type: null as unknown as PropType<DropdownItem | null>,\n      validator: (v: any) =>\n        typeof v === 'string' || typeof v === 'number' || typeof v === 'object' || v === null,\n      required: true,\n    },\n    /** Description of what the dropdown is used for. */\n    ariaLabel: String,\n    /**\n     * Animation component to use for expanding the dropdown. This is a single element animation,\n     * so only `<transition>` components are allowed.\n     */\n    animation: {\n      type: AnimationProp,\n      default: () => NoAnimation,\n    },\n    /** Time to wait without receiving any keystroke before resetting the items search query. */\n    searchTimeoutMs: {\n      type: Number,\n      default: 1000,\n    },\n  },\n  emits: ['update:modelValue'],\n  setup(props, { emit, slots }) {\n    const rootRef = ref<HTMLElement>()\n    /** The button that opens and closes the list of options. */\n    const toggleButtonRef = ref<HTMLButtonElement>()\n    /** Array containing the dropdown list buttons HTMLElements. */\n    const itemsButtonRefs = ref<HTMLButtonElement[]>([])\n\n    /** Property to check whether the dropdown is expanded or closed. */\n    const isOpen = ref(false)\n    /** Index of the element that has the focus in the list. -1 means no element has focus. */\n    const highlightedItemIndex = ref(-1)\n    /** String to search for the first element that starts with it. */\n    const searchBuffer = ref('')\n\n    /** Resets the search buffer after a certain time has passed. */\n    let restartResetSearchTimeout: () => void\n    /* Unique ID to identify the dropdown. */\n    const listId = `x-dropdown-${dropdownCount++}`\n\n    /**\n     * Dynamic CSS classes to add to the dropdown root element.\n     *\n     * @returns An object containing the CSS classes to add to the dropdown root element.\n     */\n    const dropdownCSSClasses = computed(() => ({ 'x-dropdown--is-open': isOpen }))\n\n    /**\n     * Dynamic CSS classes to add to each one of the items.\n     *\n     * @returns An object containing the CSS classes to add to each item.\n     */\n    const itemsCSSClasses = computed(() =>\n      props.items.map((item, index) => ({\n        'x-dropdown__item--is-selected': props.modelValue === item,\n        'x-dropdown__item--is-highlighted': highlightedItemIndex.value === index,\n      })),\n    )\n\n    /* Opens the dropdown. */\n    const open = () => (isOpen.value = true)\n    /* Closes the dropdown. */\n    const close = () => (isOpen.value = false)\n    /* Toggles the dropdown. */\n    const toggle = () => (isOpen.value = !isOpen.value)\n\n    /**\n     * Closes the modal and focuses the toggle button.\n     */\n    function closeAndFocusToggleButton() {\n      close()\n      toggleButtonRef.value?.focus()\n    }\n\n    /**\n     * Emits the event that the selected item has changed.\n     *\n     * @param item - The new selected item.\n     */\n    function emitSelectedItemChanged(item: DropdownItem) {\n      emit('update:modelValue', item)\n      closeAndFocusToggleButton()\n    }\n\n    /**\n     * Highlights the item after the one that is currently highlighted.\n     */\n    function highlightNextItem() {\n      open()\n      highlightedItemIndex.value = (highlightedItemIndex.value + 1) % props.items.length\n    }\n\n    /**\n     * Highlights the item before the one that is currently highlighted.\n     */\n    function highlightPreviousItem() {\n      const currentIndex = highlightedItemIndex.value\n      open()\n      highlightedItemIndex.value = currentIndex > 0 ? currentIndex - 1 : props.items.length - 1\n    }\n\n    /**\n     * Highlights the first of the provided items.\n     */\n    function highlightFirstItem() {\n      highlightedItemIndex.value = 0\n    }\n\n    /**\n     * Highlights the last of the provided items.\n     */\n    function highlightLastItem() {\n      highlightedItemIndex.value = props.items.length - 1\n    }\n\n    /**\n     * Updates the variable that is used to search in the filters.\n     *\n     * @param event - The event coming from the user typing.\n     */\n    function updateSearchBuffer(event: KeyboardEvent) {\n      if (/^\\w$/.test(event.key)) {\n        const key = event.key\n        searchBuffer.value += key\n        restartResetSearchTimeout()\n      }\n    }\n\n    /**\n     * Resets the search buffer.\n     */\n    function resetSearchBuffer() {\n      searchBuffer.value = ''\n    }\n\n    /**\n     * Closes the dropdown if the passed event has happened on an element out of the dropdown.\n     *\n     * @param event - The event to check if it has happened out of the dropdown component.\n     */\n    function closeIfEventIsOutOfDropdown(event: MouseEvent | TouchEvent | FocusEvent) {\n      if (!rootRef.value?.contains(getTargetElement(event))) {\n        close()\n      }\n    }\n\n    /**\n     * Adds listeners to the document element to detect if the focus has moved out from the\n     * dropdown.\n     */\n    function addDocumentCloseListeners() {\n      document.addEventListener('mousedown', closeIfEventIsOutOfDropdown)\n      document.addEventListener('touchstart', closeIfEventIsOutOfDropdown)\n      document.addEventListener('focusin', closeIfEventIsOutOfDropdown)\n    }\n\n    /**\n     * Removes the listeners of the document element to detect if the focus has moved out from the\n     * dropdown.\n     */\n    function removeDocumentCloseListeners() {\n      document.removeEventListener('mousedown', closeIfEventIsOutOfDropdown)\n      document.removeEventListener('touchstart', closeIfEventIsOutOfDropdown)\n      document.removeEventListener('focusin', closeIfEventIsOutOfDropdown)\n    }\n\n    /**\n     * Highlights the item that matches the search buffer. To do so it checks the list buttons\n     * text content. It highlights items following this priority:\n     * - If an element is already highlighted, it starts searching from that element.\n     * - If no element is found starting from the previously highlighted, it returns the first one.\n     * - If no element is found matching the search query it highlights the first element.\n     *\n     * @param search - The search string to find in the HTML.\n     */\n    watch(searchBuffer, search => {\n      if (search) {\n        const normalizedSearch = normalizeString(search)\n        const matchingIndices = itemsButtonRefs?.value?.reduce<number[]>(\n          (matchingIndices, button, index) => {\n            const safeButtonWordCharacters = button.textContent!.replace(/\\W/g, '')\n            const normalizedButtonText = normalizeString(safeButtonWordCharacters)\n            if (normalizedButtonText.startsWith(normalizedSearch)) {\n              matchingIndices.push(index)\n            }\n            return matchingIndices\n          },\n          [],\n        )\n        highlightedItemIndex.value =\n          // First matching item starting to search from the current highlighted element\n          matchingIndices?.find(index => index >= highlightedItemIndex.value) ??\n          // First matching item\n          matchingIndices?.[0] ??\n          // First item\n          0\n      }\n    })\n\n    /**\n     * Updates the debounced function to reset the search.\n     *\n     * @param searchTimeoutMs - The new milliseconds that have to pass without typing before\n     * resetting the search.\n     */\n    watch(\n      () => props.searchTimeoutMs,\n      searchTimeoutMs => {\n        restartResetSearchTimeout = debounceFunction(resetSearchBuffer, searchTimeoutMs)\n      },\n      { immediate: true },\n    )\n\n    /**\n     * Focuses the DOM element which matches the `highlightedItemIndex`.\n     *\n     * @param highlightedItemIndex - The index of the HTML element to focus.\n     */\n    watch(\n      highlightedItemIndex,\n      highlightedItemIndex => {\n        nextTick(() => itemsButtonRefs.value[highlightedItemIndex]?.focus())\n      },\n      { immediate: true },\n    )\n\n    /**\n     * When the dropdown is open it sets the focused element to the one that is selected.\n     *\n     * @param isOpen - True if the dropdown is open, false otherwise.\n     */\n    watch(isOpen, isOpen => {\n      highlightedItemIndex.value = isOpen\n        ? props.modelValue === null\n          ? 0\n          : props.items.indexOf(props.modelValue)\n        : -1\n    })\n\n    /**\n     * Adds and removes listeners to close the dropdown when it loses the focus.\n     *\n     * @param isOpen - True if the dropdown is open, false otherwise.\n     */\n    watch(isOpen, isOpen => {\n      /*\n       * Because there is an issue with Firefox in macOS and Safari that doesn't focus the target\n       * element of the `mousedown` events, the `focusout` event `relatedTarget` property can't be\n       * used to detect whether the user has blurred the dropdown. The hack here is to use\n       * document listeners that have the side effect of losing the focus.\n       */\n      if (isOpen) {\n        addDocumentCloseListeners()\n      } else {\n        removeDocumentCloseListeners()\n      }\n    })\n\n    /**\n     * If the dropdown is destroyed before removing the document listeners, it ensures that they\n     * are removed too.\n     */\n    onBeforeUnmount(() => {\n      removeDocumentCloseListeners()\n    })\n\n    return {\n      hasToggleSlot: !!slots.toggle,\n      closeAndFocusToggleButton,\n      dropdownCSSClasses,\n      emitSelectedItemChanged,\n      highlightFirstItem,\n      highlightLastItem,\n      highlightNextItem,\n      highlightPreviousItem,\n      highlightedItemIndex,\n      isOpen,\n      itemsButtonRefs,\n      itemsCSSClasses,\n      listId,\n      open,\n      rootRef,\n      toggle,\n      toggleButtonRef,\n      updateSearchBuffer,\n    }\n  },\n})\n</script>\n\n<style lang=\"css\" scoped>\n.x-dropdown {\n  position: relative;\n}\n\n.x-dropdown__items-list {\n  z-index: 1;\n  list-style: none;\n  position: absolute;\n  padding: 0;\n  margin: 0;\n  top: calc(100% + var(--x-size-gap-dropdown-default, 0));\n}\n</style>\n\n<docs lang=\"mdx\">\n## Example\n\nThe `Dropdown` component is a simple yet customizable select component. The component needs to work\nthe list of items available to select, which are passed using the `items` prop, and the selected\nitem, which is passed in using the `value` prop.\n\nThe supported items must be an array that can contain unique strings, unique numbers, or objects\nwith a unique `id` property.\n\nThe content of each item can be customized using the `item` slot, which apart from the data of the\nitem, it also receives via prop if the element is selected or highlighted.\n\nThere `toggle` slot can be used to customize the button that opens the dropdown. If this is not\nprovided, the `item` slot will be used for that.\n\n```vue\n<template>\n  <BaseDropdown v-model=\"value\" :items=\"items\">\n    <template #toggle=\"{ item, isOpen }\">{{ item }} {{ isOpen ? '🔼' : '🔽' }}️</template>\n\n    <template #item=\"{ item, isSelected, isHighlighted }\">\n      <span v-if=\"isHighlighted\">🟢</span>\n      <span v-if=\"isSelected\">✅</span>\n      <span>{{ item }}</span>\n    </template>\n  </BaseDropdown>\n</template>\n\n<script>\nimport { BaseDropdown } from '@empathyco/x-components'\n\nexport default {\n  name: 'DropdownTest',\n  components: {\n    BaseDropdown,\n  },\n  data() {\n    return {\n      items: ['a', 2, { id: '3' }],\n      value: 'a',\n    }\n  },\n}\n</script>\n```\n</docs>\n"],"names":["NoAnimation","debounceFunction"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAuFA,IAAI,gBAAgB,CAAA,CAAA;AAEpB;;;AAGE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,cAAc;AACpB,IAAA,KAAK,EAAE;;AAEL,QAAA,KAAK,EAAE;AACL,YAAA,IAAI,EAAE,KAAiC;AACvC,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;;AAED,QAAA,UAAU,EAAE;AACV,YAAA,IAAI,EAAE,IAAgD;YACtD,SAAS,EAAE,CAAC,CAAM,KAChB,OAAO,CAAA,KAAM,QAAO,IAAK,OAAO,CAAA,KAAM,QAAO,IAAK,OAAO,CAAE,KAAI,YAAY,CAAE,KAAI,IAAI;AACvF,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;;AAED,QAAA,SAAS,EAAE,MAAM;AACjB;;;AAGE;AACF,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,MAAMA,WAAW;AAC3B,SAAA;;AAED,QAAA,eAAe,EAAE;AACf,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;AACF,KAAA;IACD,KAAK,EAAE,CAAC,mBAAmB,CAAC;AAC5B,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,KAAM,EAAC,EAAA;AAC1B,QAAA,MAAM,OAAQ,GAAE,GAAG,EAAc,CAAA;;AAEjC,QAAA,MAAM,kBAAkB,GAAG,EAAoB,CAAA;;AAE/C,QAAA,MAAM,eAAc,GAAI,GAAG,CAAsB,EAAE,CAAA,CAAA;;AAGnD,QAAA,MAAM,SAAS,GAAG,CAAC,KAAK,CAAA,CAAA;;AAExB,QAAA,MAAM,oBAAqB,GAAE,GAAG,CAAC,CAAC,CAAC,CAAA,CAAA;;AAEnC,QAAA,MAAM,YAAa,GAAE,GAAG,CAAC,EAAE,CAAA,CAAA;;AAG3B,QAAA,IAAI,yBAAoC,CAAA;;AAExC,QAAA,MAAM,MAAO,GAAE,CAAA,WAAA,EAAc,aAAa,EAAE,EAAC,CAAA;AAE7C;;;;AAIE;AACF,QAAA,MAAM,qBAAqB,QAAQ,CAAC,OAAO,EAAE,qBAAqB,EAAE,MAAK,EAAG,CAAC,CAAA,CAAA;AAE7E;;;;AAIE;QACF,MAAM,eAAc,GAAI,QAAQ,CAAC,MAC/B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,MAAM;AAChC,YAAA,+BAA+B,EAAE,KAAK,CAAC,UAAS,KAAM,IAAI;AAC1D,YAAA,kCAAkC,EAAE,oBAAoB,CAAC,KAAI,KAAM,KAAK;SACzE,CAAC,CAAC,CACL,CAAA;;AAGA,QAAA,MAAM,IAAG,GAAI,OAAO,MAAM,CAAC,KAAM,GAAE,IAAI,CAAA,CAAA;;AAEvC,QAAA,MAAM,KAAI,GAAI,OAAO,MAAM,CAAC,KAAI,GAAI,KAAK,CAAA,CAAA;;AAEzC,QAAA,MAAM,MAAO,GAAE,OAAO,MAAM,CAAC,KAAI,GAAI,CAAC,MAAM,CAAC,KAAK,CAAA,CAAA;AAElD;;AAEE;AACF,QAAA,SAAS,yBAAyB,GAAA;AAChC,YAAA,KAAK,EAAC,CAAA;AACN,YAAA,eAAe,CAAC,KAAK,EAAE,KAAK,EAAC,CAAA;SAC/B;AAEA;;;;AAIE;QACF,SAAS,uBAAuB,CAAC,IAAkB,EAAA;AACjD,YAAA,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAA,CAAA;AAC9B,YAAA,yBAAyB,EAAC,CAAA;SAC5B;AAEA;;AAEE;AACF,QAAA,SAAS,iBAAiB,GAAA;AACxB,YAAA,IAAI,EAAC,CAAA;AACL,YAAA,oBAAoB,CAAC,KAAM,GAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAK,CAAA;SACnF;AAEA;;AAEE;AACF,QAAA,SAAS,qBAAqB,GAAA;AAC5B,YAAA,MAAM,YAAa,GAAE,oBAAoB,CAAC,KAAI,CAAA;AAC9C,YAAA,IAAI,EAAC,CAAA;YACL,oBAAoB,CAAC,QAAQ,YAAa,GAAE,CAAE,GAAE,YAAW,GAAI,CAAE,GAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAA,CAAA;SAC1F;AAEA;;AAEE;AACF,QAAA,SAAS,kBAAkB,GAAA;AACzB,YAAA,oBAAoB,CAAC,KAAI,GAAI,CAAA,CAAA;SAC/B;AAEA;;AAEE;AACF,QAAA,SAAS,iBAAiB,GAAA;YACxB,oBAAoB,CAAC,KAAI,GAAI,KAAK,CAAC,KAAK,CAAC,SAAS,CAAA,CAAA;SACpD;AAEA;;;;AAIE;QACF,SAAS,kBAAkB,CAAC,KAAoB,EAAA;YAC9C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;AAC1B,gBAAA,MAAM,GAAE,GAAI,KAAK,CAAC,GAAE,CAAA;AACpB,gBAAA,YAAY,CAAC,SAAS,GAAE,CAAA;AACxB,gBAAA,yBAAyB,EAAC,CAAA;aAC5B;SACF;AAEA;;AAEE;AACF,QAAA,SAAS,iBAAiB,GAAA;AACxB,YAAA,YAAY,CAAC,KAAI,GAAI,EAAC,CAAA;SACxB;AAEA;;;;AAIE;QACF,SAAS,2BAA2B,CAAC,KAA2C,EAAA;AAC9E,YAAA,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE;AACrD,gBAAA,KAAK,EAAC,CAAA;aACR;SACF;AAEA;;;AAGE;AACF,QAAA,SAAS,yBAAyB,GAAA;AAChC,YAAA,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,2BAA2B,CAAA,CAAA;AAClE,YAAA,QAAQ,CAAC,gBAAgB,CAAC,YAAY,EAAE,2BAA2B,CAAA,CAAA;AACnE,YAAA,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,2BAA2B,CAAA,CAAA;SAClE;AAEA;;;AAGE;AACF,QAAA,SAAS,4BAA4B,GAAA;AACnC,YAAA,QAAQ,CAAC,mBAAmB,CAAC,WAAW,EAAE,2BAA2B,CAAA,CAAA;AACrE,YAAA,QAAQ,CAAC,mBAAmB,CAAC,YAAY,EAAE,2BAA2B,CAAA,CAAA;AACtE,YAAA,QAAQ,CAAC,mBAAmB,CAAC,SAAS,EAAE,2BAA2B,CAAA,CAAA;SACrE;AAEA;;;;;;;;AAQE;AACF,QAAA,KAAK,CAAC,YAAY,EAAE,MAAO,IAAG;YAC5B,IAAI,MAAM,EAAE;AACV,gBAAA,MAAM,gBAAiB,GAAE,eAAe,CAAC,MAAM,CAAA,CAAA;AAC/C,gBAAA,MAAM,eAAc,GAAI,eAAe,EAAE,KAAK,EAAE,MAAM,CACpD,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,KAAK;AAClC,oBAAA,MAAM,wBAAyB,GAAE,MAAM,CAAC,WAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAA,CAAA;AACtE,oBAAA,MAAM,oBAAqB,GAAE,eAAe,CAAC,wBAAwB,CAAA,CAAA;AACrE,oBAAA,IAAI,oBAAoB,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;AACrD,wBAAA,eAAe,CAAC,IAAI,CAAC,KAAK,CAAA,CAAA;qBAC5B;AACA,oBAAA,OAAO,eAAc,CAAA;iBACtB,EACD,EAAE,CACJ,CAAA;AACA,gBAAA,oBAAoB,CAAC,KAAM;;AAEzB,oBAAA,eAAe,EAAE,IAAI,CAAC,KAAI,IAAK,KAAI,IAAK,oBAAoB,CAAC,KAAK;;wBAElE,eAAe,GAAG,CAAC;;AAEnB,wBAAA,CAAA,CAAA;aACJ;AACF,SAAC,CAAA,CAAA;AAED;;;;;AAKE;QACF,KAAK,CACH,MAAM,KAAK,CAAC,eAAe,EAC3B,eAAc,IAAK;AACjB,YAAA,yBAAwB,GAAIC,QAAgB,CAAC,iBAAiB,EAAE,eAAe,CAAA,CAAA;AACjF,SAAC,EACD,EAAE,SAAS,EAAE,MAAM,CACrB,CAAA;AAEA;;;;AAIE;AACF,QAAA,KAAK,CACH,oBAAoB,EACpB,oBAAmB,IAAK;AACtB,YAAA,QAAQ,CAAC,MAAM,eAAe,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,KAAK,EAAE,CAAA,CAAA;AACrE,SAAC,EACD,EAAE,SAAS,EAAE,MAAM,CACrB,CAAA;AAEA;;;;AAIE;AACF,QAAA,KAAK,CAAC,MAAM,EAAE,MAAK,IAAK;YACtB,oBAAoB,CAAC,KAAI,GAAI,MAAK;AAChC,kBAAE,KAAK,CAAC,UAAS,KAAM,IAAG;AACxB,sBAAE,CAAA;sBACA,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAA;kBACtC,CAAC,CAAA,CAAA;AACP,SAAC,CAAA,CAAA;AAED;;;;AAIE;AACF,QAAA,KAAK,CAAC,MAAM,EAAE,MAAK,IAAK;AACtB;;;;;AAKE;YACF,IAAI,MAAM,EAAE;AACV,gBAAA,yBAAyB,EAAC,CAAA;aAC1B;iBAAK;AACL,gBAAA,4BAA4B,EAAC,CAAA;aAC/B;AACF,SAAC,CAAA,CAAA;AAED;;;AAGE;QACF,eAAe,CAAC,MAAM;AACpB,YAAA,4BAA4B,EAAC,CAAA;AAC/B,SAAC,CAAA,CAAA;QAED,OAAO;AACL,YAAA,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM;YAC7B,yBAAyB;YACzB,kBAAkB;YAClB,uBAAuB;YACvB,kBAAkB;YAClB,iBAAiB;YACjB,iBAAiB;YACjB,qBAAqB;YACrB,oBAAoB;YACpB,MAAM;YACN,eAAe;YACf,eAAe;YACf,MAAM;YACN,IAAI;YACJ,OAAO;YACP,MAAM;YACN,eAAe;YACf,kBAAkB;SACpB,CAAA;KACD;AACF,CAAA,CAAA;;;;"}

package/js/components/base-event-button.vue.js

@@ -1,5 +1,5 @@
 import _sfc_main from './base-event-button.vue2.js';
-import { openBlock, createElementBlock, createCommentVNode, renderSlot } from 'vue';
+import { openBlock, createElementBlock, renderSlot } from 'vue';
 import _export_sfc from '../_virtual/_plugin-vue_export-helper.js';
 
 function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
@@ -7,11 +7,10 @@ function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
     "button",
     {
       ref: "rootRef",
-      onClick: _cache[0] || (_cache[0] = (...args) => _ctx.emitEvents && _ctx.emitEvents(...args)),
-      "data-test": "event-button"
+      "data-test": "event-button",
+      onClick: _cache[0] || (_cache[0] = (...args) => _ctx.emitEvents && _ctx.emitEvents(...args))
     },
     [
-      createCommentVNode(" @slot (Required) Button content with a text, an icon or both "),
       renderSlot(_ctx.$slots, "default")
     ],
     512

package/js/components/base-event-button.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-event-button.vue.js","sources":["../../../src/components/base-event-button.vue"],"sourcesContent":["<template>\n  <button ref=\"rootRef\" @click=\"emitEvents\" data-test=\"event-button\">\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent, PropType, ref } from 'vue';\n  import { use$x } from '../composables/use-$x';\n  import { XEvent, XEventsTypes } from '../wiring/events.types';\n  import { WireMetadata } from '../wiring/index';\n\n  /**\n   * Component to be reused that renders a `<button>` with the logic of emitting events to the bus\n   * on click. The events are passed as an object to prop {@link XEvent}.\n   * The keys are the event name and the values are the payload of each event. All events are\n   * emitted with its respective payload. If any event doesn't need payload a `undefined` must be\n   * passed as value.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseEventButton',\n    props: {\n      /** An object where the keys are the {@link XEvent} and the values are the payload. */\n      events: {\n        type: Object as PropType<Partial<XEventsTypes>>,\n        required: true\n      },\n      /**\n       * The metadata property for the request on each query preview.\n       *\n       * @public\n       */\n      metadata: {\n        type: Object as PropType<Omit<WireMetadata, 'moduleName'>>\n      }\n    },\n    setup(props) {\n      const $x = use$x();\n\n      const rootRef = ref<HTMLButtonElement>();\n\n      /**\n       * Emits `events` prop to the X bus with the payload given by it.\n       */\n      function emitEvents() {\n        Object.entries(props.events).forEach(([event, payload]) =>\n          $x.emit(event as XEvent, payload, { target: rootRef.value, ...props.metadata })\n        );\n      }\n\n      return {\n        emitEvents,\n        rootRef\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Examples\n\n### Basic example\n\nThe event prop is required. It will render a <button></button> that emits the event passed as prop\nwith the value as payload on click:\n\n```vue\n<BaseEventButton :events=\"{ myEvent: payload }\" />\n```\n\nIf the event doesn't need payload then `undefined` must be passed:\n\n```vue\n<BaseEventButton :events=\"{ myEvent: undefined }\" />\n```\n\nIt can emit multiple events at the same time:\n\n```vue\n<BaseEventButton :events=\"{ myFirstEvent: payload1, mySecondEvent: payload2 }\" />\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_createCommentVNode"],"mappings":";;;;SACc,WAAS,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;SAAEA,SAAK,EAAA,EAAAC,kBAAA;AAAA,IAAA,QAAA;AAAA,IAAE;AAAA,MAAY,GAAA,EAAA,SAAA;AAAA,MAAA,OAAA,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,UAAA,IAAA,IAAA,CAAA,UAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AACxC,MAAA,WAAA,EAAA,cAAA;AAAA,KAAA;AACA,IAAA;AAAA,MAAAC,kBAAA,CAAA,gEAAA,CAAA;;;;;;;;;;;"}
+{"version":3,"file":"base-event-button.vue.js","sources":["../../../src/components/base-event-button.vue"],"sourcesContent":["<template>\n  <button ref=\"rootRef\" data-test=\"event-button\" @click=\"emitEvents\">\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\nimport type { PropType } from 'vue'\nimport type { XEvent, XEventsTypes } from '../wiring/events.types'\nimport type { WireMetadata } from '../wiring/index'\nimport { defineComponent, ref } from 'vue'\nimport { use$x } from '../composables/use-$x'\n\n/**\n * Component to be reused that renders a `<button>` with the logic of emitting events to the bus\n * on click. The events are passed as an object to prop {@link XEvent}.\n * The keys are the event name and the values are the payload of each event. All events are\n * emitted with its respective payload. If any event doesn't need payload a `undefined` must be\n * passed as value.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseEventButton',\n  props: {\n    /** An object where the keys are the {@link XEvent} and the values are the payload. */\n    events: {\n      type: Object as PropType<Partial<XEventsTypes>>,\n      required: true,\n    },\n    /**\n     * The metadata property for the request on each query preview.\n     *\n     * @public\n     */\n    metadata: {\n      type: Object as PropType<Omit<WireMetadata, 'moduleName'>>,\n    },\n  },\n  setup(props) {\n    const $x = use$x()\n\n    const rootRef = ref<HTMLButtonElement>()\n\n    /**\n     * Emits `events` prop to the X bus with the payload given by it.\n     */\n    function emitEvents() {\n      Object.entries(props.events).forEach(([event, payload]) =>\n        $x.emit(event as XEvent, payload, { target: rootRef.value, ...props.metadata }),\n      )\n    }\n\n    return {\n      emitEvents,\n      rootRef,\n    }\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Examples\n\n### Basic example\n\nThe event prop is required. It will render a <button></button> that emits the event passed as prop\nwith the value as payload on click:\n\n```vue\n<BaseEventButton :events=\"{ myEvent: payload }\" />\n```\n\nIf the event doesn't need payload then `undefined` must be passed:\n\n```vue\n<BaseEventButton :events=\"{ myEvent: undefined }\" />\n```\n\nIt can emit multiple events at the same time:\n\n```vue\n<BaseEventButton :events=\"{ myFirstEvent: payload1, mySecondEvent: payload2 }\" />\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_renderSlot"],"mappings":";;;;;AACE,EAAA,OAAAA,SAAA,EAAA,EAAAC,kBAAA;AAAA,IAGS,QAAA;AAAA,IAAA;AAAA,MAHD,GAAI,EAAA,SAAA;AAAA,MAAU,WAAU,EAAA,cAAA;AAAA,MAAgB,SAAK,MAAE,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,UAAA,IAAA,IAAA,CAAA,UAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,KAAA;;MAErDC,UAAQ,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,CAAA;AAAA,KAAA;;;;;;;;;"}

package/js/components/base-event-button.vue2.js

@@ -1,46 +1,46 @@
 import { defineComponent, ref } from 'vue';
 import { use$x } from '../composables/use-_x.js';
 
-/**
- * Component to be reused that renders a `<button>` with the logic of emitting events to the bus
- * on click. The events are passed as an object to prop {@link XEvent}.
- * The keys are the event name and the values are the payload of each event. All events are
- * emitted with its respective payload. If any event doesn't need payload a `undefined` must be
- * passed as value.
- *
- * @public
- */
-var _sfc_main = defineComponent({
-    name: 'BaseEventButton',
-    props: {
-        /** An object where the keys are the {@link XEvent} and the values are the payload. */
-        events: {
-            type: Object,
-            required: true
-        },
-        /**
-         * The metadata property for the request on each query preview.
-         *
-         * @public
-         */
-        metadata: {
-            type: Object
-        }
-    },
-    setup(props) {
-        const $x = use$x();
-        const rootRef = ref();
-        /**
-         * Emits `events` prop to the X bus with the payload given by it.
-         */
-        function emitEvents() {
-            Object.entries(props.events).forEach(([event, payload]) => $x.emit(event, payload, { target: rootRef.value, ...props.metadata }));
-        }
-        return {
-            emitEvents,
-            rootRef
-        };
-    }
+/**
+ * Component to be reused that renders a `<button>` with the logic of emitting events to the bus
+ * on click. The events are passed as an object to prop {@link XEvent}.
+ * The keys are the event name and the values are the payload of each event. All events are
+ * emitted with its respective payload. If any event doesn't need payload a `undefined` must be
+ * passed as value.
+ *
+ * @public
+ */
+var _sfc_main = defineComponent({
+    name: 'BaseEventButton',
+    props: {
+        /** An object where the keys are the {@link XEvent} and the values are the payload. */
+        events: {
+            type: Object,
+            required: true,
+        },
+        /**
+         * The metadata property for the request on each query preview.
+         *
+         * @public
+         */
+        metadata: {
+            type: Object,
+        },
+    },
+    setup(props) {
+        const $x = use$x();
+        const rootRef = ref();
+        /**
+         * Emits `events` prop to the X bus with the payload given by it.
+         */
+        function emitEvents() {
+            Object.entries(props.events).forEach(([event, payload]) => $x.emit(event, payload, { target: rootRef.value, ...props.metadata }));
+        }
+        return {
+            emitEvents,
+            rootRef,
+        };
+    },
 });
 
 export { _sfc_main as default };

package/js/components/base-event-button.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-event-button.vue2.js","sources":["../../../src/components/base-event-button.vue"],"sourcesContent":["<template>\n  <button ref=\"rootRef\" @click=\"emitEvents\" data-test=\"event-button\">\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent, PropType, ref } from 'vue';\n  import { use$x } from '../composables/use-$x';\n  import { XEvent, XEventsTypes } from '../wiring/events.types';\n  import { WireMetadata } from '../wiring/index';\n\n  /**\n   * Component to be reused that renders a `<button>` with the logic of emitting events to the bus\n   * on click. The events are passed as an object to prop {@link XEvent}.\n   * The keys are the event name and the values are the payload of each event. All events are\n   * emitted with its respective payload. If any event doesn't need payload a `undefined` must be\n   * passed as value.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseEventButton',\n    props: {\n      /** An object where the keys are the {@link XEvent} and the values are the payload. */\n      events: {\n        type: Object as PropType<Partial<XEventsTypes>>,\n        required: true\n      },\n      /**\n       * The metadata property for the request on each query preview.\n       *\n       * @public\n       */\n      metadata: {\n        type: Object as PropType<Omit<WireMetadata, 'moduleName'>>\n      }\n    },\n    setup(props) {\n      const $x = use$x();\n\n      const rootRef = ref<HTMLButtonElement>();\n\n      /**\n       * Emits `events` prop to the X bus with the payload given by it.\n       */\n      function emitEvents() {\n        Object.entries(props.events).forEach(([event, payload]) =>\n          $x.emit(event as XEvent, payload, { target: rootRef.value, ...props.metadata })\n        );\n      }\n\n      return {\n        emitEvents,\n        rootRef\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Examples\n\n### Basic example\n\nThe event prop is required. It will render a <button></button> that emits the event passed as prop\nwith the value as payload on click:\n\n```vue\n<BaseEventButton :events=\"{ myEvent: payload }\" />\n```\n\nIf the event doesn't need payload then `undefined` must be passed:\n\n```vue\n<BaseEventButton :events=\"{ myEvent: undefined }\" />\n```\n\nIt can emit multiple events at the same time:\n\n```vue\n<BaseEventButton :events=\"{ myFirstEvent: payload1, mySecondEvent: payload2 }\" />\n```\n</docs>\n"],"names":[],"mappings":";;;AAaE;;;;;;;;AAQE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,KAAK,EAAE;;AAEL,QAAA,MAAM,EAAE;AACN,YAAA,IAAI,EAAE,MAAyC;AAC/C,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;AACD;;;;AAIE;AACF,QAAA,QAAQ,EAAE;AACR,YAAA,IAAI,EAAE,MAAmD;AAC3D,SAAA;AACD,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT,QAAA,MAAM,EAAC,GAAI,KAAK,EAAE,CAAA;AAElB,QAAA,MAAM,OAAQ,GAAE,GAAG,EAAqB,CAAA;AAExC;;AAEE;AACF,QAAA,SAAS,UAAU,GAAA;AACjB,YAAA,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,KACpD,EAAE,CAAC,IAAI,CAAC,KAAe,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,UAAU,CAAA,CAC/E,CAAA;SACH;QAEA,OAAO;YACL,UAAU;YACV,OAAM;SACP,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"base-event-button.vue2.js","sources":["../../../src/components/base-event-button.vue"],"sourcesContent":["<template>\n  <button ref=\"rootRef\" data-test=\"event-button\" @click=\"emitEvents\">\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\nimport type { PropType } from 'vue'\nimport type { XEvent, XEventsTypes } from '../wiring/events.types'\nimport type { WireMetadata } from '../wiring/index'\nimport { defineComponent, ref } from 'vue'\nimport { use$x } from '../composables/use-$x'\n\n/**\n * Component to be reused that renders a `<button>` with the logic of emitting events to the bus\n * on click. The events are passed as an object to prop {@link XEvent}.\n * The keys are the event name and the values are the payload of each event. All events are\n * emitted with its respective payload. If any event doesn't need payload a `undefined` must be\n * passed as value.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseEventButton',\n  props: {\n    /** An object where the keys are the {@link XEvent} and the values are the payload. */\n    events: {\n      type: Object as PropType<Partial<XEventsTypes>>,\n      required: true,\n    },\n    /**\n     * The metadata property for the request on each query preview.\n     *\n     * @public\n     */\n    metadata: {\n      type: Object as PropType<Omit<WireMetadata, 'moduleName'>>,\n    },\n  },\n  setup(props) {\n    const $x = use$x()\n\n    const rootRef = ref<HTMLButtonElement>()\n\n    /**\n     * Emits `events` prop to the X bus with the payload given by it.\n     */\n    function emitEvents() {\n      Object.entries(props.events).forEach(([event, payload]) =>\n        $x.emit(event as XEvent, payload, { target: rootRef.value, ...props.metadata }),\n      )\n    }\n\n    return {\n      emitEvents,\n      rootRef,\n    }\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Examples\n\n### Basic example\n\nThe event prop is required. It will render a <button></button> that emits the event passed as prop\nwith the value as payload on click:\n\n```vue\n<BaseEventButton :events=\"{ myEvent: payload }\" />\n```\n\nIf the event doesn't need payload then `undefined` must be passed:\n\n```vue\n<BaseEventButton :events=\"{ myEvent: undefined }\" />\n```\n\nIt can emit multiple events at the same time:\n\n```vue\n<BaseEventButton :events=\"{ myFirstEvent: payload1, mySecondEvent: payload2 }\" />\n```\n</docs>\n"],"names":[],"mappings":";;;AAcA;;;;;;;;AAQE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,KAAK,EAAE;;AAEL,QAAA,MAAM,EAAE;AACN,YAAA,IAAI,EAAE,MAAyC;AAC/C,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;AACD;;;;AAIE;AACF,QAAA,QAAQ,EAAE;AACR,YAAA,IAAI,EAAE,MAAoD;AAC3D,SAAA;AACF,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT,QAAA,MAAM,EAAC,GAAI,KAAK,EAAC,CAAA;AAEjB,QAAA,MAAM,OAAQ,GAAE,GAAG,EAAoB,CAAA;AAEvC;;AAEE;AACF,QAAA,SAAS,UAAU,GAAA;AACjB,YAAA,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,KACpD,EAAE,CAAC,IAAI,CAAC,KAAe,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,QAAO,EAAG,CAAC,CACjF,CAAA;SACF;QAEA,OAAO;YACL,UAAU;YACV,OAAO;SACT,CAAA;KACD;AACF,CAAA,CAAA;;;;"}

package/js/components/base-grid.vue.js

@@ -1,5 +1,5 @@
 import _sfc_main from './base-grid.vue2.js';
-import { openBlock, createBlock, resolveDynamicComponent, normalizeStyle, normalizeClass, withCtx, createElementBlock, Fragment, renderList, createCommentVNode, renderSlot, createTextVNode, toDisplayString } from 'vue';
+import { openBlock, createBlock, resolveDynamicComponent, normalizeStyle, normalizeClass, withCtx, createElementBlock, Fragment, renderList, renderSlot, createTextVNode, toDisplayString } from 'vue';
 import './base-grid.vue3.js';
 import _export_sfc from '../_virtual/_plugin-vue_export-helper.js';
 
@@ -23,26 +23,19 @@ function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
               class: normalizeClass([cssClass, "x-base-grid__item"])
             },
             [
-              createCommentVNode("\n        @slot Customized item rendering. Specifying a slot with the item's modelName will result in\n        the item using that slot composition to render.\n            @binding {item} item - Item to render\n      "),
               _ctx.slots[slotName] ? renderSlot(_ctx.$slots, slotName, {
                 key: 0,
                 item
-              }, void 0, true) : (openBlock(), createElementBlock(
-                Fragment,
-                { key: 1 },
-                [
-                  createCommentVNode("\n        @slot (required) Default item rendering. This slot will be used by default for rendering\n        the item without an specific slot implementation.\n            @binding {item} item - Item to render\n      "),
-                  renderSlot(_ctx.$slots, "default", { item }, () => [
-                    createTextVNode(
-                      toDisplayString(item.name || item.modelName || item.id || item),
-                      1
-                      /* TEXT */
-                    )
-                  ], true)
-                ],
-                2112
-                /* STABLE_FRAGMENT, DEV_ROOT_FRAGMENT */
-              ))
+              }, void 0, true) : renderSlot(_ctx.$slots, "default", {
+                key: 1,
+                item
+              }, () => [
+                createTextVNode(
+                  toDisplayString(item.name || item.modelName || item.id || item),
+                  1
+                  /* TEXT */
+                )
+              ], true)
             ],
             2
             /* CLASS */

package/js/components/base-grid.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-grid.vue.js","sources":["../../../src/components/base-grid.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    ref=\"gridEl\"\n    :style=\"style\"\n    class=\"x-base-grid\"\n    :class=\"cssClasses\"\n    tag=\"ul\"\n    data-test=\"grid\"\n  >\n    <li\n      v-for=\"{ item, cssClass, slotName } in gridItems\"\n      :key=\"item.id\"\n      :class=\"cssClass\"\n      class=\"x-base-grid__item\"\n    >\n      <!--\n        @slot Customized item rendering. Specifying a slot with the item's modelName will result in\n        the item using that slot composition to render.\n            @binding {item} item - Item to render\n      -->\n      <slot v-if=\"slots[slotName]\" :name=\"slotName\" :item=\"item\" />\n      <!--\n        @slot (required) Default item rendering. This slot will be used by default for rendering\n        the item without an specific slot implementation.\n            @binding {item} item - Item to render\n      -->\n      <slot v-else :item=\"item\">{{ item.name || item.modelName || item.id || item }}</slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import {\n    computed,\n    defineComponent,\n    inject,\n    onBeforeUnmount,\n    onMounted,\n    PropType,\n    Ref,\n    ref,\n    watch\n  } from 'vue';\n  import {\n    MaybeComputedElementRef,\n    useResizeObserver,\n    UseResizeObserverReturn\n  } from '@vueuse/core';\n  import { toKebabCase } from '../utils/string';\n  import { ListItem, VueCSSClasses } from '../utils/types';\n  import { AnimationProp } from '../types/animation-prop';\n  import { useXBus } from '../composables/use-x-bus';\n  import { LIST_ITEMS_KEY } from './decorators/injection.consts';\n\n  /**\n   * The type returned by the gridItems function. Basically it's a list of items with its CSS\n   * classes and a slotName.\n   */\n  interface GridItem {\n    slotName: string;\n    item: ListItem;\n    cssClass: VueCSSClasses;\n  }\n\n  /**\n   * Grid component that is able to render different items based on their modelName value. In order\n   * to achieve this, it exposes a scopedSlot for each different modelName. In case the items used\n   * do not have modelName property, the default slot is used instead. It has a required property:\n   * the `items` to render; and an optional one: the number `columns` the grid is divided in. If the\n   * number of columns is not specified, the grid automatically fills the rows with as many columns\n   * as it can fit.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseGrid',\n    props: {\n      /** Animation component that will be used to animate the base grid. */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      },\n      /**\n       * Number of columns the grid is divided into. By default, its value is 0, setting the grid\n       * columns mode to auto-fill.\n       */\n      columns: {\n        type: Number,\n        default: 0\n      },\n      /**\n       * The list of items to be rendered.\n       *\n       * @remarks The items must have an ID property.\n       */\n      items: {\n        type: Array as PropType<ListItem[]>\n      }\n    },\n    setup(props, { slots }) {\n      type ElementRef = {\n        $el: HTMLElement;\n      };\n\n      const xBus = useXBus();\n\n      /** It injects {@link ListItem} provided by an ancestor. */\n      const injectedListItems = inject<Ref<ListItem[]>>(LIST_ITEMS_KEY as string);\n      const gridEl = ref<ElementRef | HTMLElement>();\n      let renderedColumnsNumber = ref(0);\n\n      /**\n       * Emits the {@link XEventsTypes.RenderedColumnsNumberChanged}\n       * event whenever the number of columns rendered inside the grid changes.\n       */\n      watch(\n        renderedColumnsNumber,\n        () => xBus.emit('RenderedColumnsNumberChanged', renderedColumnsNumber.value),\n        { immediate: false }\n      );\n\n      /**\n       * It returns the items passed as props or the injected ones.\n       *\n       * @returns List of grid items.\n       */\n      const computedItems = computed<ListItem[] | void>(() => {\n        return (\n          props.items ??\n          injectedListItems?.value ??\n          //TODO: add here logger\n          //eslint-disable-next-line no-console\n          console.warn('It is necessary to pass a prop or inject the list of filters')\n        );\n      });\n\n      /**\n       * CSS class based on the column property value so items inside the grid can fill different\n       * amount of columns or rows based on how many columns the grid is divided into.\n       *\n       * @returns CSS class with the column property value.\n       */\n      const cssClasses = computed(() => `x-base-grid--cols-${props.columns || 'auto'}`);\n\n      /**\n       * CSSStyleDeclaration object specifying the number of columns the grid is divided into based on\n       * the column property value.\n       *\n       * @returns A CSSStyleDeclaration to use as the style attribute.\n       */\n      const style = computed<Partial<CSSStyleDeclaration>>(() => ({\n        gridTemplateColumns: props.columns\n          ? `repeat(${props.columns}, minmax(0, 1fr))`\n          : 'repeat(auto-fill, minmax(var(--x-size-min-width-grid-item, 150px), 1fr))'\n      }));\n\n      /**\n       * Maps the item to an object containing: the `item`, its `CSS class` and its slot name.\n       *\n       * @returns An array of objects containing the item and its CSS class.\n       */\n      const gridItems = computed<GridItem[]>(() =>\n        (computedItems.value as ListItem[]).map(item => {\n          const slotName = toKebabCase(item.modelName);\n          return {\n            slotName,\n            item,\n            cssClass: `x-base-grid__${slotName}`\n          };\n        })\n      );\n\n      /**\n       * Checks if a given value is an `ElementRef` object.\n       *\n       * @param value - The value to check.\n       * @returns `true` if the value is an `ElementRef` object, `false` otherwise.\n       */\n      const isElementRef = (value: any): value is ElementRef => {\n        return value && value.$el instanceof HTMLElement;\n      };\n\n      /** Updates the number of columns rendered inside the grid. */\n      function updateRenderedColumnsNumber() {\n        const { gridTemplateColumns } = getComputedStyle(\n          isElementRef(gridEl.value) ? gridEl.value.$el : (gridEl.value as Element)\n        );\n        renderedColumnsNumber.value = gridTemplateColumns.split(' ').length;\n      }\n\n      /** Initialises the rendered columns number and sets a ResizeObserver to keep it updated. */\n      let resizeObserver: UseResizeObserverReturn;\n      onMounted(() => {\n        resizeObserver = useResizeObserver(\n          gridEl as MaybeComputedElementRef,\n          updateRenderedColumnsNumber\n        );\n      });\n      onBeforeUnmount(() => resizeObserver?.stop());\n\n      return {\n        gridItems,\n        cssClasses,\n        style,\n        gridEl,\n        slots\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-base-grid {\n    display: grid;\n    grid-auto-flow: dense;\n    list-style: none;\n    align-items: stretch;\n  }\n\n  .x-base-grid__banner,\n  .x-base-grid__next-queries-group,\n  .x-base-grid__related-prompts-group {\n    grid-column-start: 1;\n    grid-column-end: -1;\n  }\n\n  .x-base-grid__item {\n    display: flex;\n    flex-flow: column nowrap;\n  }\n\n  .x-base-grid__item > * {\n    flex-grow: 1;\n  }\n\n  .x-base-grid--cols-auto .x-base-grid__item {\n    min-width: var(--x-size-min-width-grid-item);\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Examples\n\nThis component renders a list of elements in different slots depending on their modelName. In order\nto achieve this, it exposes a scopedSlot for each different modelName. In case the items used do not\nhave modelName property, the default slot is used instead. It has a required property, the `items`\nto render, and an optional one, the number of `columns` the grid is divided in. If the number of\ncolumns is not specified, the grid automatically fills the rows with as many columns as it can fit.\n\n### Basic example\n\nIt renders a list of items using the default slot:\n\n```vue\n<template>\n  <BaseGrid :items=\"items\">\n    <template #default=\"{ item }\">\n      {{ `Default slot content: ${item.id}` }}\n    </template>\n  </BaseGrid>\n</template>\n```\n\n### Configuring the number of columns\n\nIt renders a grid with 12 columns instead of 6, which is the default value:\n\n```vue\n<template>\n  <BaseGrid :items=\"items\" :columns=\"12\">\n    <template #default=\"{ item }\">\n      {{ `Default slot content: ${item.id}` }}\n    </template>\n  </BaseGrid>\n</template>\n```\n\n### Rendering usage\n\nConfiguring the number of columns.\n\nIt renders a list of items using the different scopedSlots created by the item's modelName. For\nexample, if you want to use this component as the search grid, you pass the search results (results,\nbanners, promoted, next queries...etc) as items. Each of these results have a different modelName\nand are rendered in different slots.\n\n```vue\n<template>\n  <BaseGrid :animation=\"animation\" :items=\"items\">\n    <template #banner=\"{ item }\">\n      <span class=\"banner\">\n        {{ `${item.title} banner` }}\n      </span>\n    </template>\n    <template #next-queries=\"{ item }\">\n      <span>\n        {{ `${item.totalResults} next queries` }}\n      </span>\n    </template>\n    <template #promoted=\"{ item }\">\n      <span class=\"promoted\">\n        {{ `${item.title} promoted` }}\n      </span>\n    </template>\n    <template #result=\"{ item }\">\n      <BaseResultLink :result=\"item\">\n        {{ item.name }}\n      </BaseResultLink>\n    </template>\n  </BaseGrid>\n</template>\n```\n\n### Customizing the items width\n\nThe `--x-size-min-width-grid-item` variable can be used to customize the min width of the grid\nitems.\n\n```vue\n<template>\n  <BaseGrid :items=\"items\" style=\"--x-size-min-width-grid-item: 150px\">\n    <template #default=\"{ item }\">\n      {{ `Default slot content: ${item.id}` }}\n    </template>\n  </BaseGrid>\n</template>\n```\n</docs>\n"],"names":["_openBlock","_createBlock","_resolveDynamicComponent","_normalizeStyle","_normalizeClass","_createElementBlock","_Fragment","_renderList","slots","_renderSlot","_createCommentVNode"],"mappings":";;;;;SAGQ,WAAQ,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;AACN,EAAA,OAAAA,SAAA,EAAO,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IACb,GAAK,EAAA,QAAA;AAAA,IAEL,OAAIC,cAAI,CAAA,IAAA,CAAA,KAAA,CAAA;AAAA,IACR,KAAgB,EAAAC,cAAA,CAAA,CAAA,aAAA,EAAA,IAAA,CAAA,UAAA,CAAA,CAAA;AAAA,IAAA,GAAA,EAAA,IAAA;AARpB,IAAA,WAAA,EAAA,MAAA;AAAA,GAAA,EAAA;;iBAYY,IAAO,CAAA,EAAAC,kBAAA;AAAA,QAAAC,QAAA;AAAA,QAAA,IAAA;AAAA,QAAAC,UAAA,CAAA,IAAA,CAAA,SAAA,EAAA,CAAA,EAAA,IAAA,EAAA,QAAA,EAAA,QAAA,EAAA,KAAA;iBACPP,SAbZ,EAAA,EAAAK,kBAAA;AAAA,YAcY,IAAA;AAAA,YAAA;AAAA,cAAA,GAAA,EAAA,IAAA,CAAA,EAAA;AAEN,cAAA,KAAA,EAAAD,cAAA,CAAA,CAAA,QAAA,EAAA,mBAAA,CAAA,CAAA;AAAA,aAAA;AAKYI,YAAAA;AAAAA,cAAAA,kBAAAA,CAAiD,2NAAjB,CAAA;AAAA,cAAA,IAAA,CArBlD,KAqB+D,CAAA,QAAA,CAAA,GAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,QAAA,EAAA;AAAA,gBAAA,GAAA,EAAA,CAAA;;AACzD,eAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA,IAAAT,SAAA,EAKqF,EAAAK,kBAAA;AAAA,gBAAAC,QAAA;AAAA,gBAAjE,OAAI,CAA6D,EAAA;AAAA,gBAAA;AAAA,kBAAAI,kBAAA,CA3B3F,0NA2BiF,CAAA;AAAA,kBAAAD,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,EAAA,EAAA,IAAA,EAAA,EAAA,MAAA;;;;;;;;;;;;;;;AA3BjF,SAAA,CAAA;AAAA,QAAA,GAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;;;;;;;;;"}
+{"version":3,"file":"base-grid.vue.js","sources":["../../../src/components/base-grid.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    ref=\"gridEl\"\n    :style=\"style\"\n    class=\"x-base-grid\"\n    :class=\"cssClasses\"\n    tag=\"ul\"\n    data-test=\"grid\"\n  >\n    <li\n      v-for=\"{ item, cssClass, slotName } in gridItems\"\n      :key=\"item.id\"\n      :class=\"cssClass\"\n      class=\"x-base-grid__item\"\n    >\n      <!--\n        @slot Customized item rendering. Specifying a slot with the item's modelName will result in\n        the item using that slot composition to render.\n            @binding {item} item - Item to render\n      -->\n      <slot v-if=\"slots[slotName]\" :name=\"slotName\" :item=\"item\" />\n      <!--\n        @slot (required) Default item rendering. This slot will be used by default for rendering\n        the item without an specific slot implementation.\n            @binding {item} item - Item to render\n      -->\n      <slot v-else :item=\"item\">{{ item.name || item.modelName || item.id || item }}</slot>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\nimport type { MaybeComputedElementRef, UseResizeObserverReturn } from '@vueuse/core'\nimport type { PropType, Ref } from 'vue'\nimport type { ListItem, VueCSSClasses } from '../utils/types'\nimport { useResizeObserver } from '@vueuse/core'\nimport { computed, defineComponent, inject, onBeforeUnmount, onMounted, ref, watch } from 'vue'\nimport { useXBus } from '../composables/use-x-bus'\nimport { AnimationProp } from '../types/animation-prop'\nimport { toKebabCase } from '../utils/string'\nimport { LIST_ITEMS_KEY } from './decorators/injection.consts'\n\n/**\n * The type returned by the gridItems function. Basically it's a list of items with its CSS\n * classes and a slotName.\n */\ninterface GridItem {\n  slotName: string\n  item: ListItem\n  cssClass: VueCSSClasses\n}\n\n/**\n * Grid component that is able to render different items based on their modelName value. In order\n * to achieve this, it exposes a scopedSlot for each different modelName. In case the items used\n * do not have modelName property, the default slot is used instead. It has a required property:\n * the `items` to render; and an optional one: the number `columns` the grid is divided in. If the\n * number of columns is not specified, the grid automatically fills the rows with as many columns\n * as it can fit.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseGrid',\n  props: {\n    /** Animation component that will be used to animate the base grid. */\n    animation: {\n      type: AnimationProp,\n      default: 'ul',\n    },\n    /**\n     * Number of columns the grid is divided into. By default, its value is 0, setting the grid\n     * columns mode to auto-fill.\n     */\n    columns: {\n      type: Number,\n      default: 0,\n    },\n    /**\n     * The list of items to be rendered.\n     *\n     * @remarks The items must have an ID property.\n     */\n    items: {\n      type: Array as PropType<ListItem[]>,\n    },\n  },\n  setup(props, { slots }) {\n    // eslint-disable-next-line ts/consistent-type-definitions\n    type ElementRef = {\n      $el: HTMLElement\n    }\n\n    const xBus = useXBus()\n\n    /** It injects {@link ListItem} provided by an ancestor. */\n    const injectedListItems = inject<Ref<ListItem[]>>(LIST_ITEMS_KEY as string)\n    const gridEl = ref<ElementRef | HTMLElement>()\n    const renderedColumnsNumber = ref(0)\n\n    /**\n     * Emits the {@link XEventsTypes.RenderedColumnsNumberChanged}\n     * event whenever the number of columns rendered inside the grid changes.\n     */\n    watch(\n      renderedColumnsNumber,\n      () => xBus.emit('RenderedColumnsNumberChanged', renderedColumnsNumber.value),\n      { immediate: false },\n    )\n\n    /**\n     * It returns the items passed as props or the injected ones.\n     *\n     * @returns List of grid items.\n     */\n    const computedItems = computed<ListItem[] | void>(() => {\n      return (\n        props.items ??\n        injectedListItems?.value ??\n        console.warn('It is necessary to pass a prop or inject the list of filters')\n      )\n    })\n\n    /**\n     * CSS class based on the column property value so items inside the grid can fill different\n     * amount of columns or rows based on how many columns the grid is divided into.\n     *\n     * @returns CSS class with the column property value.\n     */\n    const cssClasses = computed(() => `x-base-grid--cols-${props.columns || 'auto'}`)\n\n    /**\n     * CSSStyleDeclaration object specifying the number of columns the grid is divided into based on\n     * the column property value.\n     *\n     * @returns A CSSStyleDeclaration to use as the style attribute.\n     */\n    const style = computed<Partial<CSSStyleDeclaration>>(() => ({\n      gridTemplateColumns: props.columns\n        ? `repeat(${props.columns}, minmax(0, 1fr))`\n        : 'repeat(auto-fill, minmax(var(--x-size-min-width-grid-item, 150px), 1fr))',\n    }))\n\n    /**\n     * Maps the item to an object containing: the `item`, its `CSS class` and its slot name.\n     *\n     * @returns An array of objects containing the item and its CSS class.\n     */\n    const gridItems = computed<GridItem[]>(() =>\n      (computedItems.value as ListItem[]).map(item => {\n        const slotName = toKebabCase(item.modelName)\n        return {\n          slotName,\n          item,\n          cssClass: `x-base-grid__${slotName}`,\n        }\n      }),\n    )\n\n    /**\n     * Checks if a given value is an `ElementRef` object.\n     *\n     * @param value - The value to check.\n     * @returns `true` if the value is an `ElementRef` object, `false` otherwise.\n     */\n    const isElementRef = (value: any): value is ElementRef => {\n      return value && value.$el instanceof HTMLElement\n    }\n\n    /** Updates the number of columns rendered inside the grid. */\n    function updateRenderedColumnsNumber() {\n      const { gridTemplateColumns } = getComputedStyle(\n        isElementRef(gridEl.value) ? gridEl.value.$el : (gridEl.value as Element),\n      )\n      renderedColumnsNumber.value = gridTemplateColumns.split(' ').length\n    }\n\n    /** Initialises the rendered columns number and sets a ResizeObserver to keep it updated. */\n    let resizeObserver: UseResizeObserverReturn\n    onMounted(() => {\n      resizeObserver = useResizeObserver(\n        gridEl as MaybeComputedElementRef,\n        updateRenderedColumnsNumber,\n      )\n    })\n    onBeforeUnmount(() => resizeObserver?.stop())\n\n    return {\n      gridItems,\n      cssClasses,\n      style,\n      gridEl,\n      slots,\n    }\n  },\n})\n</script>\n\n<style lang=\"css\" scoped>\n.x-base-grid {\n  display: grid;\n  grid-auto-flow: dense;\n  list-style: none;\n  align-items: stretch;\n}\n\n.x-base-grid__banner,\n.x-base-grid__next-queries-group,\n.x-base-grid__related-prompts-group {\n  grid-column-start: 1;\n  grid-column-end: -1;\n}\n\n.x-base-grid__related-prompts-group.x-staggered-fade-and-slide-leave-active,\n.x-base-grid__related-prompts-group.x-staggered-fade-and-slide-enter-active {\n  transition: none;\n  position: relative;\n}\n\n.x-base-grid__item {\n  display: flex;\n  flex-flow: column nowrap;\n}\n\n.x-base-grid__item > * {\n  flex-grow: 1;\n}\n\n.x-base-grid--cols-auto .x-base-grid__item {\n  min-width: var(--x-size-min-width-grid-item);\n}\n</style>\n\n<docs lang=\"mdx\">\n## Examples\n\nThis component renders a list of elements in different slots depending on their modelName. In order\nto achieve this, it exposes a scopedSlot for each different modelName. In case the items used do not\nhave modelName property, the default slot is used instead. It has a required property, the `items`\nto render, and an optional one, the number of `columns` the grid is divided in. If the number of\ncolumns is not specified, the grid automatically fills the rows with as many columns as it can fit.\n\n### Basic example\n\nIt renders a list of items using the default slot:\n\n```vue\n<template>\n  <BaseGrid :items=\"items\">\n    <template #default=\"{ item }\">\n      {{ `Default slot content: ${item.id}` }}\n    </template>\n  </BaseGrid>\n</template>\n```\n\n### Configuring the number of columns\n\nIt renders a grid with 12 columns instead of 6, which is the default value:\n\n```vue\n<template>\n  <BaseGrid :items=\"items\" :columns=\"12\">\n    <template #default=\"{ item }\">\n      {{ `Default slot content: ${item.id}` }}\n    </template>\n  </BaseGrid>\n</template>\n```\n\n### Rendering usage\n\nConfiguring the number of columns.\n\nIt renders a list of items using the different scopedSlots created by the item's modelName. For\nexample, if you want to use this component as the search grid, you pass the search results (results,\nbanners, promoted, next queries...etc) as items. Each of these results have a different modelName\nand are rendered in different slots.\n\n```vue\n<template>\n  <BaseGrid :animation=\"animation\" :items=\"items\">\n    <template #banner=\"{ item }\">\n      <span class=\"banner\">\n        {{ `${item.title} banner` }}\n      </span>\n    </template>\n    <template #next-queries=\"{ item }\">\n      <span>\n        {{ `${item.totalResults} next queries` }}\n      </span>\n    </template>\n    <template #promoted=\"{ item }\">\n      <span class=\"promoted\">\n        {{ `${item.title} promoted` }}\n      </span>\n    </template>\n    <template #result=\"{ item }\">\n      <BaseResultLink :result=\"item\">\n        {{ item.name }}\n      </BaseResultLink>\n    </template>\n  </BaseGrid>\n</template>\n```\n\n### Customizing the items width\n\nThe `--x-size-min-width-grid-item` variable can be used to customize the min width of the grid\nitems.\n\n```vue\n<template>\n  <BaseGrid :items=\"items\" style=\"--x-size-min-width-grid-item: 150px\">\n    <template #default=\"{ item }\">\n      {{ `Default slot content: ${item.id}` }}\n    </template>\n  </BaseGrid>\n</template>\n```\n</docs>\n"],"names":["_openBlock","_createBlock","_resolveDynamicComponent","_normalizeStyle","_normalizeClass","_withCtx","_createElementBlock","_Fragment","_renderList","_renderSlot","_createTextVNode","_toDisplayString"],"mappings":";;;;;;AACE,EAAA,OAAAA,SAAA,EAAA,EAAAC,WAAA,CA4BYC,wBA3BL,IAAS,CAAA,SAAA,CAAA,EAAA;AAAA,IACd,GAAI,EAAA,QAAA;AAAA,IACH,KAAA,EAJLC,eAIY,IAAK,CAAA,KAAA,CAAA;AAAA,IACb,KAAA,EALJC,cAKU,CAAA,CAAA,aAAA,EACE,IAAU,CAAA,UAAA,CAAA,CAAA;AAAA,IAClB,GAAI,EAAA,IAAA;AAAA,IACJ,WAAU,EAAA,MAAA;AAAA,GAAA,EAAA;AARd,IAAA,OAAA,EAAAC,OAAA,CAWM,MAAiD;AAAA,OADnDL,SAAA,CAAA,IAAA,CAAA,EAAAM,kBAAA;AAAA,QAkBKC,QAAA;AAAA,QAAA,IAAA;AAAA,QA5BTC,UAW6C,CAAA,IAAA,CAAA,SAAA,EAX7C,CAWe,EAAA,IAAA,EAAM,UAAU,QAAQ,EAAA,KAAA;AADnC,UAAA,OAAAR,SAAA,EAAA,EAAAM,kBAAA;AAAA,YAkBK,IAAA;AAAA,YAAA;AAAA,cAhBF,KAAK,IAAK,CAAA,EAAA;AAAA,cACV,KAAA,EAbPF,cAac,CAAA,CAAA,QAAA,EACF,mBAAmB,CAAA,CAAA;AAAA,aAAA;;AAOb,cAAA,IAAA,CAAA,KAAA,CAAM,QAAQ,CAAA,GAA1BK,UAA6D,CAAA,IAAA,CAAA,MAAA,EAAzB,QAAQ,EAAA;AAAA,gBArBlD,GAAA,EAAA,CAAA;AAAA,gBAqBqD,IAAA;AAAA,eAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA,GAM/CA,UAAqF,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,EAAA;AAAA,gBA3B3F,GAAA,EAAA,CAAA;AAAA,gBA2BoB,IAAA;AAAA,eAAA,EAAd,MAAqF;AAAA,gBA3B3FC,eAAA;AAAA,kBAAAC,eAAA,CA2BmC,KAAK,IAAQ,IAAA,IAAA,CAAK,SAAa,IAAA,IAAA,CAAK,MAAM,IAAI,CAAA;AAAA,kBAAA,CAAA;AAAA;AAAA,iBAAA;AAAA,eAAA,EAAA,IAAA,CAAA;;;;;;;;;;AA3BjF,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,EAAA,CAAA,EAAA,CAAA,OAAA,EAAA,OAAA,CAAA,CAAA,CAAA;;;;;;"}

package/js/components/base-grid.vue2.js

@@ -1,127 +1,125 @@
-import { defineComponent, inject, ref, watch, computed, onMounted, onBeforeUnmount } from 'vue';
 import { useResizeObserver } from '@vueuse/core';
-import { toKebabCase } from '../utils/string.js';
-import { AnimationProp } from '../types/animation-prop.js';
+import { defineComponent, inject, ref, watch, computed, onMounted, onBeforeUnmount } from 'vue';
 import { useXBus } from '../composables/use-x-bus.js';
+import { AnimationProp } from '../types/animation-prop.js';
+import { toKebabCase } from '../utils/string.js';
 import { LIST_ITEMS_KEY } from './decorators/injection.consts.js';
 
-/**
- * Grid component that is able to render different items based on their modelName value. In order
- * to achieve this, it exposes a scopedSlot for each different modelName. In case the items used
- * do not have modelName property, the default slot is used instead. It has a required property:
- * the `items` to render; and an optional one: the number `columns` the grid is divided in. If the
- * number of columns is not specified, the grid automatically fills the rows with as many columns
- * as it can fit.
- *
- * @public
- */
-var _sfc_main = defineComponent({
-    name: 'BaseGrid',
-    props: {
-        /** Animation component that will be used to animate the base grid. */
-        animation: {
-            type: AnimationProp,
-            default: 'ul'
-        },
-        /**
-         * Number of columns the grid is divided into. By default, its value is 0, setting the grid
-         * columns mode to auto-fill.
-         */
-        columns: {
-            type: Number,
-            default: 0
-        },
-        /**
-         * The list of items to be rendered.
-         *
-         * @remarks The items must have an ID property.
-         */
-        items: {
-            type: Array
-        }
-    },
-    setup(props, { slots }) {
-        const xBus = useXBus();
-        /** It injects {@link ListItem} provided by an ancestor. */
-        const injectedListItems = inject(LIST_ITEMS_KEY);
-        const gridEl = ref();
-        let renderedColumnsNumber = ref(0);
-        /**
-         * Emits the {@link XEventsTypes.RenderedColumnsNumberChanged}
-         * event whenever the number of columns rendered inside the grid changes.
-         */
-        watch(renderedColumnsNumber, () => xBus.emit('RenderedColumnsNumberChanged', renderedColumnsNumber.value), { immediate: false });
-        /**
-         * It returns the items passed as props or the injected ones.
-         *
-         * @returns List of grid items.
-         */
-        const computedItems = computed(() => {
-            return (props.items ??
-                injectedListItems?.value ??
-                //TODO: add here logger
-                //eslint-disable-next-line no-console
-                console.warn('It is necessary to pass a prop or inject the list of filters'));
-        });
-        /**
-         * CSS class based on the column property value so items inside the grid can fill different
-         * amount of columns or rows based on how many columns the grid is divided into.
-         *
-         * @returns CSS class with the column property value.
-         */
-        const cssClasses = computed(() => `x-base-grid--cols-${props.columns || 'auto'}`);
-        /**
-         * CSSStyleDeclaration object specifying the number of columns the grid is divided into based on
-         * the column property value.
-         *
-         * @returns A CSSStyleDeclaration to use as the style attribute.
-         */
-        const style = computed(() => ({
-            gridTemplateColumns: props.columns
-                ? `repeat(${props.columns}, minmax(0, 1fr))`
-                : 'repeat(auto-fill, minmax(var(--x-size-min-width-grid-item, 150px), 1fr))'
-        }));
-        /**
-         * Maps the item to an object containing: the `item`, its `CSS class` and its slot name.
-         *
-         * @returns An array of objects containing the item and its CSS class.
-         */
-        const gridItems = computed(() => computedItems.value.map(item => {
-            const slotName = toKebabCase(item.modelName);
-            return {
-                slotName,
-                item,
-                cssClass: `x-base-grid__${slotName}`
-            };
-        }));
-        /**
-         * Checks if a given value is an `ElementRef` object.
-         *
-         * @param value - The value to check.
-         * @returns `true` if the value is an `ElementRef` object, `false` otherwise.
-         */
-        const isElementRef = (value) => {
-            return value && value.$el instanceof HTMLElement;
-        };
-        /** Updates the number of columns rendered inside the grid. */
-        function updateRenderedColumnsNumber() {
-            const { gridTemplateColumns } = getComputedStyle(isElementRef(gridEl.value) ? gridEl.value.$el : gridEl.value);
-            renderedColumnsNumber.value = gridTemplateColumns.split(' ').length;
-        }
-        /** Initialises the rendered columns number and sets a ResizeObserver to keep it updated. */
-        let resizeObserver;
-        onMounted(() => {
-            resizeObserver = useResizeObserver(gridEl, updateRenderedColumnsNumber);
-        });
-        onBeforeUnmount(() => resizeObserver?.stop());
-        return {
-            gridItems,
-            cssClasses,
-            style,
-            gridEl,
-            slots
-        };
-    }
+/**
+ * Grid component that is able to render different items based on their modelName value. In order
+ * to achieve this, it exposes a scopedSlot for each different modelName. In case the items used
+ * do not have modelName property, the default slot is used instead. It has a required property:
+ * the `items` to render; and an optional one: the number `columns` the grid is divided in. If the
+ * number of columns is not specified, the grid automatically fills the rows with as many columns
+ * as it can fit.
+ *
+ * @public
+ */
+var _sfc_main = defineComponent({
+    name: 'BaseGrid',
+    props: {
+        /** Animation component that will be used to animate the base grid. */
+        animation: {
+            type: AnimationProp,
+            default: 'ul',
+        },
+        /**
+         * Number of columns the grid is divided into. By default, its value is 0, setting the grid
+         * columns mode to auto-fill.
+         */
+        columns: {
+            type: Number,
+            default: 0,
+        },
+        /**
+         * The list of items to be rendered.
+         *
+         * @remarks The items must have an ID property.
+         */
+        items: {
+            type: Array,
+        },
+    },
+    setup(props, { slots }) {
+        const xBus = useXBus();
+        /** It injects {@link ListItem} provided by an ancestor. */
+        const injectedListItems = inject(LIST_ITEMS_KEY);
+        const gridEl = ref();
+        const renderedColumnsNumber = ref(0);
+        /**
+         * Emits the {@link XEventsTypes.RenderedColumnsNumberChanged}
+         * event whenever the number of columns rendered inside the grid changes.
+         */
+        watch(renderedColumnsNumber, () => xBus.emit('RenderedColumnsNumberChanged', renderedColumnsNumber.value), { immediate: false });
+        /**
+         * It returns the items passed as props or the injected ones.
+         *
+         * @returns List of grid items.
+         */
+        const computedItems = computed(() => {
+            return (props.items ??
+                injectedListItems?.value ??
+                console.warn('It is necessary to pass a prop or inject the list of filters'));
+        });
+        /**
+         * CSS class based on the column property value so items inside the grid can fill different
+         * amount of columns or rows based on how many columns the grid is divided into.
+         *
+         * @returns CSS class with the column property value.
+         */
+        const cssClasses = computed(() => `x-base-grid--cols-${props.columns || 'auto'}`);
+        /**
+         * CSSStyleDeclaration object specifying the number of columns the grid is divided into based on
+         * the column property value.
+         *
+         * @returns A CSSStyleDeclaration to use as the style attribute.
+         */
+        const style = computed(() => ({
+            gridTemplateColumns: props.columns
+                ? `repeat(${props.columns}, minmax(0, 1fr))`
+                : 'repeat(auto-fill, minmax(var(--x-size-min-width-grid-item, 150px), 1fr))',
+        }));
+        /**
+         * Maps the item to an object containing: the `item`, its `CSS class` and its slot name.
+         *
+         * @returns An array of objects containing the item and its CSS class.
+         */
+        const gridItems = computed(() => computedItems.value.map(item => {
+            const slotName = toKebabCase(item.modelName);
+            return {
+                slotName,
+                item,
+                cssClass: `x-base-grid__${slotName}`,
+            };
+        }));
+        /**
+         * Checks if a given value is an `ElementRef` object.
+         *
+         * @param value - The value to check.
+         * @returns `true` if the value is an `ElementRef` object, `false` otherwise.
+         */
+        const isElementRef = (value) => {
+            return value && value.$el instanceof HTMLElement;
+        };
+        /** Updates the number of columns rendered inside the grid. */
+        function updateRenderedColumnsNumber() {
+            const { gridTemplateColumns } = getComputedStyle(isElementRef(gridEl.value) ? gridEl.value.$el : gridEl.value);
+            renderedColumnsNumber.value = gridTemplateColumns.split(' ').length;
+        }
+        /** Initialises the rendered columns number and sets a ResizeObserver to keep it updated. */
+        let resizeObserver;
+        onMounted(() => {
+            resizeObserver = useResizeObserver(gridEl, updateRenderedColumnsNumber);
+        });
+        onBeforeUnmount(() => resizeObserver?.stop());
+        return {
+            gridItems,
+            cssClasses,
+            style,
+            gridEl,
+            slots,
+        };
+    },
 });
 
 export { _sfc_main as default };