@empathyco/x-components 6.0.0-alpha.9 → 6.0.0-alpha.90

package/js/x-modules/search-box/components/clear-search-input.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"clear-search-input.vue2.js","sources":["../../../../../src/x-modules/search-box/components/clear-search-input.vue"],"sourcesContent":["<template>\n  <BaseEventButton\n    class=\"x-clear-search-input x-button\"\n    :class=\"dynamicClasses\"\n    :events=\"clearSearchInputEvents\"\n    data-test=\"clear-search-input\"\n  >\n    <!-- @slot _Required_. Button content (text, icon, or both) -->\n    <slot>✕</slot>\n  </BaseEventButton>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent, computed, ref } from 'vue';\n  import BaseEventButton from '../../../components/base-event-button.vue';\n  import { VueCSSClasses } from '../../../utils/types';\n  import { useState } from '../../../composables/use-state';\n  import { searchBoxXModule } from '../x-module';\n\n  /**\n   * This component renders a button to delete the current query.\n   *\n   * @remarks\n   * A button that when pressed emits the {@link SearchBoxXEvents.UserPressedClearSearchBoxButton}\n   * and {@link SearchBoxXEvents.UserClearedQuery} events, expressing the user intention to clear\n   * the current query.\n   * It also adds `x-clear-search-input--has-empty-query` as class when there is no query.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'ClearSearchInput',\n    components: { BaseEventButton },\n    xModule: searchBoxXModule.name,\n    setup: function () {\n      const { query } = useState('searchBox', ['query']);\n\n      /**\n       * The events dictionary that are going to be emitted when the button is pressed.\n       *\n       * @internal\n       */\n      const clearSearchInputEvents = ref({\n        UserPressedClearSearchBoxButton: undefined\n      });\n\n      const isQueryEmpty = computed(() => query.value.length === 0);\n\n      const dynamicClasses = computed<VueCSSClasses>(() => ({\n        'x-clear-search-input--has-empty-query': isQueryEmpty.value\n      }));\n\n      return {\n        dynamicClasses,\n        clearSearchInputEvents\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`UserPressedClearSearchBoxButton`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserClearedQuery`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n## See it in action\n\nHere a basic example of how the clear button is rendered.\n\n_Type any term in the input field and then click the Clear button to try it out!_\n\n```vue live\n<template>\n  <div style=\"display: flex;\">\n    <SearchInput />\n    <ClearSearchInput />\n  </div>\n</template>\n\n<script>\n  import { ClearSearchInput, SearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'ClearSearchInputDemo',\n    components: {\n      ClearSearchInput,\n      SearchInput\n    }\n  };\n</script>\n```\n\n### Play with default slot\n\nIn this example, a custom text is passed in the default slot instead of the default text to\ncustomize the button content.\n\n_Click the icon button to try it out!_\n\n```vue live\n<template>\n  <ClearSearchInput>Clear</ClearSearchInput>\n</template>\n\n<script>\n  import { ClearSearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'ClearSearchInputDemo',\n    components: {\n      ClearSearchInput\n    }\n  };\n</script>\n```\n\n### Play with events\n\nIn this example, the `UserPressedClearSearchBoxButton` event is implemented, triggering the message\n“clear” when the clear search input button is clicked.\n\n_Click the Clear button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <ClearSearchInput @UserPressedClearSearchBoxButton=\"message = 'clear'\">Clear</ClearSearchInput>\n    {{ message }}\n  </div>\n</template>\n\n<script>\n  import { ClearSearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'ClearSearchInputDemo',\n    components: {\n      ClearSearchInput\n    },\n    data() {\n      return {\n        message: ''\n      };\n    }\n  };\n</script>\n```\n\n## Extending the component\n\nComponents can be combined and communicate with each other. Commonly, the `ClearSearchInput`\ncomponent communicates with the [`SearchInput`](./search-input.md), deleting the search term\nentered.\n\n_Type any term in the input field and then click the icon button to try it out!_\n\n```vue live\n<template>\n  <div style=\"display: flex;\">\n    <SearchInput />\n    <ClearSearchInput />\n  </div>\n</template>\n\n<script>\n  import { SearchInput, ClearSearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'ClearSearchInputDemo',\n    components: {\n      SearchInput,\n      ClearSearchInput\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;AAmBE;;;;;;;;;;AAUE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,kBAAkB;IACxB,UAAU,EAAE,EAAE,eAAc,EAAG;IAC/B,OAAO,EAAE,gBAAgB,CAAC,IAAI;AAC9B,IAAA,KAAK,EAAE,YAAA;AACL,QAAA,MAAM,EAAE,OAAQ,GAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC,CAAA;AAElD;;;;AAIE;QACF,MAAM,sBAAuB,GAAE,GAAG,CAAC;AACjC,YAAA,+BAA+B,EAAE,SAAQ;AAC1C,SAAA,CAAC,CAAA;AAEF,QAAA,MAAM,YAAa,GAAE,QAAQ,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAA;AAE7D,QAAA,MAAM,cAAe,GAAE,QAAQ,CAAgB,OAAO;YACpD,uCAAuC,EAAE,YAAY,CAAC,KAAI;AAC3D,SAAA,CAAC,CAAC,CAAA;QAEH,OAAO;YACL,cAAc;YACd,sBAAqB;SACtB,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"clear-search-input.vue2.js","sources":["../../../../../src/x-modules/search-box/components/clear-search-input.vue"],"sourcesContent":["<template>\n  <BaseEventButton\n    class=\"x-clear-search-input x-button\"\n    :class=\"dynamicClasses\"\n    :events=\"clearSearchInputEvents\"\n    data-test=\"clear-search-input\"\n  >\n    <!-- @slot _Required_. Button content (text, icon, or both) -->\n    <slot>✕</slot>\n  </BaseEventButton>\n</template>\n\n<script lang=\"ts\">\nimport type { VueCSSClasses } from '../../../utils/types'\nimport { computed, defineComponent, ref } from 'vue'\nimport BaseEventButton from '../../../components/base-event-button.vue'\nimport { useState } from '../../../composables/use-state'\nimport { searchBoxXModule } from '../x-module'\n\n/**\n * This component renders a button to delete the current query.\n *\n * @remarks\n * A button that when pressed emits the {@link SearchBoxXEvents.UserPressedClearSearchBoxButton}\n * and {@link SearchBoxXEvents.UserClearedQuery} events, expressing the user intention to clear\n * the current query.\n * It also adds `x-clear-search-input--has-empty-query` as class when there is no query.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'ClearSearchInput',\n  components: { BaseEventButton },\n  xModule: searchBoxXModule.name,\n  setup() {\n    const { query } = useState('searchBox')\n\n    /**\n     * The events dictionary that are going to be emitted when the button is pressed.\n     *\n     * @internal\n     */\n    const clearSearchInputEvents = ref({\n      UserPressedClearSearchBoxButton: undefined,\n    })\n\n    const isQueryEmpty = computed(() => query.value.length === 0)\n\n    const dynamicClasses = computed<VueCSSClasses>(() => ({\n      'x-clear-search-input--has-empty-query': isQueryEmpty.value,\n    }))\n\n    return {\n      dynamicClasses,\n      clearSearchInputEvents,\n    }\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`UserPressedClearSearchBoxButton`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserClearedQuery`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n## See it in action\n\nHere a basic example of how the clear button is rendered.\n\n_Type any term in the input field and then click the Clear button to try it out!_\n\n```vue live\n<template>\n  <div style=\"display: flex;\">\n    <SearchInput />\n    <ClearSearchInput />\n  </div>\n</template>\n\n<script>\nimport { ClearSearchInput, SearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'ClearSearchInputDemo',\n  components: {\n    ClearSearchInput,\n    SearchInput,\n  },\n}\n</script>\n```\n\n### Play with default slot\n\nIn this example, a custom text is passed in the default slot instead of the default text to\ncustomize the button content.\n\n_Click the icon button to try it out!_\n\n```vue live\n<template>\n  <ClearSearchInput>Clear</ClearSearchInput>\n</template>\n\n<script>\nimport { ClearSearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'ClearSearchInputDemo',\n  components: {\n    ClearSearchInput,\n  },\n}\n</script>\n```\n\n### Play with events\n\nIn this example, the `UserPressedClearSearchBoxButton` event is implemented, triggering the message\n“clear” when the clear search input button is clicked.\n\n_Click the Clear button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <ClearSearchInput @UserPressedClearSearchBoxButton=\"message = 'clear'\">Clear</ClearSearchInput>\n    {{ message }}\n  </div>\n</template>\n\n<script>\nimport { ClearSearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'ClearSearchInputDemo',\n  components: {\n    ClearSearchInput,\n  },\n  data() {\n    return {\n      message: '',\n    }\n  },\n}\n</script>\n```\n\n## Extending the component\n\nComponents can be combined and communicate with each other. Commonly, the `ClearSearchInput`\ncomponent communicates with the [`SearchInput`](./search-input.md), deleting the search term\nentered.\n\n_Type any term in the input field and then click the icon button to try it out!_\n\n```vue live\n<template>\n  <div style=\"display: flex;\">\n    <SearchInput />\n    <ClearSearchInput />\n  </div>\n</template>\n\n<script>\nimport { SearchInput, ClearSearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'ClearSearchInputDemo',\n  components: {\n    SearchInput,\n    ClearSearchInput,\n  },\n}\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;AAmBA;;;;;;;;;;AAUE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,kBAAkB;IACxB,UAAU,EAAE,EAAE,eAAc,EAAG;IAC/B,OAAO,EAAE,gBAAgB,CAAC,IAAI;IAC9B,KAAK,GAAA;QACH,MAAM,EAAE,KAAI,EAAI,GAAE,QAAQ,CAAC,WAAW,CAAA,CAAA;AAEtC;;;;AAIE;QACF,MAAM,sBAAuB,GAAE,GAAG,CAAC;AACjC,YAAA,+BAA+B,EAAE,SAAS;AAC3C,SAAA,CAAA,CAAA;AAED,QAAA,MAAM,YAAW,GAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,MAAO,KAAI,CAAC,CAAA,CAAA;AAE5D,QAAA,MAAM,cAAe,GAAE,QAAQ,CAAgB,OAAO;YACpD,uCAAuC,EAAE,YAAY,CAAC,KAAK;AAC5D,SAAA,CAAC,CAAA,CAAA;QAEF,OAAO;YACL,cAAc;YACd,sBAAsB;SACxB,CAAA;KACD;AACF,CAAA,CAAA;;;;"}

package/js/x-modules/search-box/components/search-button.vue.js

@@ -1,5 +1,5 @@
 import _sfc_main from './search-button.vue2.js';
-import { openBlock, createElementBlock, normalizeClass, createCommentVNode, renderSlot, createElementVNode } from 'vue';
+import { openBlock, createElementBlock, normalizeClass, renderSlot, createElementVNode } from 'vue';
 import _export_sfc from '../../../_virtual/_plugin-vue_export-helper.js';
 
 const _hoisted_1 = /* @__PURE__ */ createElementVNode(
@@ -14,12 +14,11 @@ function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
     "button",
     {
       ref: "buttonRef",
-      onClick: _cache[0] || (_cache[0] = (...args) => _ctx.emitEvents && _ctx.emitEvents(...args)),
       class: normalizeClass(["x-search-button x-button", _ctx.dynamicClasses]),
-      "data-test": "search-button"
+      "data-test": "search-button",
+      onClick: _cache[0] || (_cache[0] = (...args) => _ctx.emitEvents && _ctx.emitEvents(...args))
     },
     [
-      createCommentVNode(" @slot _Required_. Button content (text, icon, or both) "),
       renderSlot(_ctx.$slots, "default", {}, () => [
         _hoisted_1
       ])

package/js/x-modules/search-box/components/search-button.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-button.vue.js","sources":["../../../../../src/x-modules/search-box/components/search-button.vue"],"sourcesContent":["<template>\n  <button\n    ref=\"buttonRef\"\n    @click=\"emitEvents\"\n    class=\"x-search-button x-button\"\n    :class=\"dynamicClasses\"\n    data-test=\"search-button\"\n  >\n    <!-- @slot _Required_. Button content (text, icon, or both) -->\n    <slot><span class=\"x-icon\">⌕</span></slot>\n  </button>\n</template>\n\n<script lang=\"ts\">\n  import { computed, ComputedRef, defineComponent, ref } from 'vue';\n  import { VueCSSClasses } from '../../../utils/types';\n  import { WireMetadata } from '../../../wiring/wiring.types';\n  import { use$x } from '../../../composables/use-$x';\n  import { useState } from '../../../composables/use-state';\n  import { searchBoxXModule } from '../x-module';\n\n  /**\n   * This component renders a button to submit the query.\n   *\n   * @remarks\n   * If query is not empty, it emits {@link XEventsTypes.UserAcceptedAQuery} and\n   * {@link SearchBoxXEvents.UserPressedSearchButton} events with the query as payload.\n   * It also adds `x-search-button--has-empty-query` as class when there is no query.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SearchButton',\n    xModule: searchBoxXModule.name,\n    setup: function () {\n      const $x = use$x();\n\n      const buttonRef = ref<HTMLElement | null>(null);\n\n      const query: ComputedRef<string> = useState('searchBox', ['query']).query;\n\n      const isQueryEmpty = computed(() => query.value.length === 0);\n\n      const dynamicClasses = computed<VueCSSClasses>(() => ({\n        'x-search-button--has-empty-query': isQueryEmpty.value\n      }));\n\n      /**\n       * Generates the {@link WireMetadata} object omitting the moduleName.\n       *\n       * @returns The {@link WireMetadata} object omitting the moduleName.\n       * @internal\n       */\n      function createEventMetadata(): Omit<WireMetadata, 'moduleName'> {\n        return {\n          target: buttonRef.value,\n          feature: 'search_box'\n        };\n      }\n\n      /**\n       * Emits events when the button is clicked.\n       *\n       * @public\n       */\n      function emitEvents() {\n        if (!isQueryEmpty.value) {\n          $x.emit('UserAcceptedAQuery', query.value, createEventMetadata());\n          $x.emit('UserPressedSearchButton', query.value, createEventMetadata());\n        }\n      }\n\n      return {\n        dynamicClasses,\n        buttonRef,\n        emitEvents\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`UserAcceptedAQuery`]https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserPressedSearchButton`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n<!-- prettier-ignore-start -->\n:::warning\nNote that no events are emitted if the query is empty.\n:::\n<!-- prettier-ignore-end -->\n\n## Dynamic classes\n\n`SearchButton` uses the `x-search-button--has-empty-query` dynamic CSS class to modify the HTML\nbutton style when the query is empty.\n\n## See it in action\n\nIn this example, a clickable button is rendered.\n\n_Click the Search button to try it out!_\n\n```vue live\n<template>\n  <SearchButton />\n</template>\n\n<script>\n  import { SearchButton } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchButtonDemo',\n    components: {\n      SearchButton\n    }\n  };\n</script>\n```\n\n### Play with default slot\n\nHere text is passed in the default slot instead of an icon to customize the button content.\n\n_Click the icon button to try it out!_\n\n```vue live\n<template>\n  <SearchButton>Search</SearchButton>\n</template>\n\n<script>\n  import { SearchButton } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchButtonDemo',\n    components: {\n      SearchButton\n    }\n  };\n</script>\n```\n\n### Play with events\n\nIn this example, the `UserPressedSearchButton` event has been implemented so that when you enter a\nsearch term and click the Search button, the search term is displayed as a message.\n\n_Type any term in the input field and then click the Search button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex;\">\n      <SearchInput />\n      <SearchButton\n        @UserPressedSearchButton=\"\n          query => {\n            message = query;\n          }\n        \"\n      />\n    </div>\n    {{ message }}\n  </div>\n</template>\n\n<script>\n  import { SearchInput, SearchButton } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchButtonDemo',\n    components: {\n      SearchInput,\n      SearchButton\n    },\n    data() {\n      return {\n        message: ''\n      };\n    }\n  };\n</script>\n```\n\n## Extending the component\n\nComponents can be combined and communicate with each other. Commonly, the `SearchButton` component\ncommunicates with the [`SearchInput`](./search-input.md) to submit the query. In this example, when\nyou enter a search term and click the Search button, the “Looking for results” message is displayed.\n\n_Type any term in the input field and then click the Search button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex;\">\n      <SearchInput />\n      <SearchButton @UserAcceptedAQuery=\"message = 'looking for results'\">Search</SearchButton>\n    </div>\n    {{ message }}\n  </div>\n</template>\n\n<script>\n  import { SearchButton, SearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchButtonDemo',\n    components: {\n      SearchButton,\n      SearchInput\n    },\n    data() {\n      return {\n        message: ''\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_normalizeClass","_createCommentVNode","_renderSlot"],"mappings":";;;;;;;;;;;SAEQ,WAAW,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;SACdA,SAAK,EAAA,EAAAC,kBAAA;AAAA,IAAA,QAAA;AAAA,IAAE;AAAA,MACR,GAAK,EAAA,WAAA;AAAA,MAEL,gBAAU,CAAe,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,UAAA,IAAA,IAAA,CAAA,UAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,MAAA,KAAA,EAAAC,cAAA,CAAA,CAAA,0BAAA,EAAA,IAAA,CAAA,cAAA,CAAA,CAAA;AAEzB,MAAA,WAAA,EAAA,eAAA;AAAA,KAAA;AACA,IAAA;AAAA,MAAmCC,kBAAA,CAAA,0DAAA,CAAA;AAAA,MAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,EAAA,EAAA,EAAA,MAAA;;;;;;;;;;;;"}
+{"version":3,"file":"search-button.vue.js","sources":["../../../../../src/x-modules/search-box/components/search-button.vue"],"sourcesContent":["<template>\n  <button\n    ref=\"buttonRef\"\n    class=\"x-search-button x-button\"\n    :class=\"dynamicClasses\"\n    data-test=\"search-button\"\n    @click=\"emitEvents\"\n  >\n    <!-- @slot _Required_. Button content (text, icon, or both) -->\n    <slot><span class=\"x-icon\">⌕</span></slot>\n  </button>\n</template>\n\n<script lang=\"ts\">\nimport type { VueCSSClasses } from '../../../utils/types'\nimport type { WireMetadata } from '../../../wiring/wiring.types'\nimport { computed, defineComponent, ref } from 'vue'\nimport { use$x } from '../../../composables/use-$x'\nimport { useState } from '../../../composables/use-state'\nimport { searchBoxXModule } from '../x-module'\n\n/**\n * This component renders a button to submit the query.\n *\n * @remarks\n * If query is not empty, it emits {@link XEventsTypes.UserAcceptedAQuery} and\n * {@link SearchBoxXEvents.UserPressedSearchButton} events with the query as payload.\n * It also adds `x-search-button--has-empty-query` as class when there is no query.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'SearchButton',\n  xModule: searchBoxXModule.name,\n  setup() {\n    const $x = use$x()\n\n    const buttonRef = ref<HTMLElement | null>(null)\n\n    const { query } = useState('searchBox')\n\n    const isQueryEmpty = computed(() => query.value.length === 0)\n\n    const dynamicClasses = computed<VueCSSClasses>(() => ({\n      'x-search-button--has-empty-query': isQueryEmpty.value,\n    }))\n\n    /**\n     * Generates the {@link WireMetadata} object omitting the moduleName.\n     *\n     * @returns The {@link WireMetadata} object omitting the moduleName.\n     * @internal\n     */\n    function createEventMetadata(): Omit<WireMetadata, 'moduleName'> {\n      return {\n        target: buttonRef.value,\n        feature: 'search_box',\n      }\n    }\n\n    /**\n     * Emits events when the button is clicked.\n     *\n     * @public\n     */\n    function emitEvents() {\n      if (!isQueryEmpty.value) {\n        $x.emit('UserAcceptedAQuery', query.value, createEventMetadata())\n        $x.emit('UserPressedSearchButton', query.value, createEventMetadata())\n      }\n    }\n\n    return {\n      dynamicClasses,\n      buttonRef,\n      emitEvents,\n    }\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`UserAcceptedAQuery`]https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserPressedSearchButton`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n<!-- prettier-ignore-start -->\n:::warning\nNote that no events are emitted if the query is empty.\n:::\n<!-- prettier-ignore-end -->\n\n## Dynamic classes\n\n`SearchButton` uses the `x-search-button--has-empty-query` dynamic CSS class to modify the HTML\nbutton style when the query is empty.\n\n## See it in action\n\nIn this example, a clickable button is rendered.\n\n_Click the Search button to try it out!_\n\n```vue live\n<template>\n  <SearchButton />\n</template>\n\n<script>\nimport { SearchButton } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchButtonDemo',\n  components: {\n    SearchButton,\n  },\n}\n</script>\n```\n\n### Play with default slot\n\nHere text is passed in the default slot instead of an icon to customize the button content.\n\n_Click the icon button to try it out!_\n\n```vue live\n<template>\n  <SearchButton>Search</SearchButton>\n</template>\n\n<script>\nimport { SearchButton } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchButtonDemo',\n  components: {\n    SearchButton,\n  },\n}\n</script>\n```\n\n### Play with events\n\nIn this example, the `UserPressedSearchButton` event has been implemented so that when you enter a\nsearch term and click the Search button, the search term is displayed as a message.\n\n_Type any term in the input field and then click the Search button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex;\">\n      <SearchInput />\n      <SearchButton\n        @UserPressedSearchButton=\"\n          query => {\n            message = query\n          }\n        \"\n      />\n    </div>\n    {{ message }}\n  </div>\n</template>\n\n<script>\nimport { SearchInput, SearchButton } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchButtonDemo',\n  components: {\n    SearchInput,\n    SearchButton,\n  },\n  data() {\n    return {\n      message: '',\n    }\n  },\n}\n</script>\n```\n\n## Extending the component\n\nComponents can be combined and communicate with each other. Commonly, the `SearchButton` component\ncommunicates with the [`SearchInput`](./search-input.md) to submit the query. In this example, when\nyou enter a search term and click the Search button, the “Looking for results” message is displayed.\n\n_Type any term in the input field and then click the Search button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex;\">\n      <SearchInput />\n      <SearchButton @UserAcceptedAQuery=\"message = 'looking for results'\">Search</SearchButton>\n    </div>\n    {{ message }}\n  </div>\n</template>\n\n<script>\nimport { SearchButton, SearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchButtonDemo',\n  components: {\n    SearchButton,\n    SearchInput,\n  },\n  data() {\n    return {\n      message: '',\n    }\n  },\n}\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_normalizeClass"],"mappings":";;;;;;;;;;;SAEQ,WAAW,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;SACVA,SAHT,EAAA,EAAAC,kBAAA;AAAA,IAGU,QAAA;AAAA,IAA0B;AAAA,MAEhC,GAAA,EAAA,WAAA;AAAA,MACC,OAAKC,cAAE,CAAA,CAAA,0BAAA,EAAA,IAAA,CAAA,cAAA,CAAA,CAAA;AAAA,MAAA,WAAA,EAAA,eAAA;MAGR,OAA0C,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;AAAA,KAAA;;;;;;;;;;;;;;"}

package/js/x-modules/search-box/components/search-button.vue2.js

@@ -16,13 +16,13 @@ import { searchBoxXModule } from '../x-module.js';
 var _sfc_main = defineComponent({
     name: 'SearchButton',
     xModule: searchBoxXModule.name,
-    setup: function () {
+    setup() {
         const $x = use$x();
         const buttonRef = ref(null);
-        const query = useState('searchBox', ['query']).query;
+        const { query } = useState('searchBox');
         const isQueryEmpty = computed(() => query.value.length === 0);
         const dynamicClasses = computed(() => ({
-            'x-search-button--has-empty-query': isQueryEmpty.value
+            'x-search-button--has-empty-query': isQueryEmpty.value,
         }));
         /**
          * Generates the {@link WireMetadata} object omitting the moduleName.
@@ -33,7 +33,7 @@ var _sfc_main = defineComponent({
         function createEventMetadata() {
             return {
                 target: buttonRef.value,
-                feature: 'search_box'
+                feature: 'search_box',
             };
         }
         /**
@@ -50,9 +50,9 @@ var _sfc_main = defineComponent({
         return {
             dynamicClasses,
             buttonRef,
-            emitEvents
+            emitEvents,
         };
-    }
+    },
 });
 
 export { _sfc_main as default };

package/js/x-modules/search-box/components/search-button.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-button.vue2.js","sources":["../../../../../src/x-modules/search-box/components/search-button.vue"],"sourcesContent":["<template>\n  <button\n    ref=\"buttonRef\"\n    @click=\"emitEvents\"\n    class=\"x-search-button x-button\"\n    :class=\"dynamicClasses\"\n    data-test=\"search-button\"\n  >\n    <!-- @slot _Required_. Button content (text, icon, or both) -->\n    <slot><span class=\"x-icon\">⌕</span></slot>\n  </button>\n</template>\n\n<script lang=\"ts\">\n  import { computed, ComputedRef, defineComponent, ref } from 'vue';\n  import { VueCSSClasses } from '../../../utils/types';\n  import { WireMetadata } from '../../../wiring/wiring.types';\n  import { use$x } from '../../../composables/use-$x';\n  import { useState } from '../../../composables/use-state';\n  import { searchBoxXModule } from '../x-module';\n\n  /**\n   * This component renders a button to submit the query.\n   *\n   * @remarks\n   * If query is not empty, it emits {@link XEventsTypes.UserAcceptedAQuery} and\n   * {@link SearchBoxXEvents.UserPressedSearchButton} events with the query as payload.\n   * It also adds `x-search-button--has-empty-query` as class when there is no query.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SearchButton',\n    xModule: searchBoxXModule.name,\n    setup: function () {\n      const $x = use$x();\n\n      const buttonRef = ref<HTMLElement | null>(null);\n\n      const query: ComputedRef<string> = useState('searchBox', ['query']).query;\n\n      const isQueryEmpty = computed(() => query.value.length === 0);\n\n      const dynamicClasses = computed<VueCSSClasses>(() => ({\n        'x-search-button--has-empty-query': isQueryEmpty.value\n      }));\n\n      /**\n       * Generates the {@link WireMetadata} object omitting the moduleName.\n       *\n       * @returns The {@link WireMetadata} object omitting the moduleName.\n       * @internal\n       */\n      function createEventMetadata(): Omit<WireMetadata, 'moduleName'> {\n        return {\n          target: buttonRef.value,\n          feature: 'search_box'\n        };\n      }\n\n      /**\n       * Emits events when the button is clicked.\n       *\n       * @public\n       */\n      function emitEvents() {\n        if (!isQueryEmpty.value) {\n          $x.emit('UserAcceptedAQuery', query.value, createEventMetadata());\n          $x.emit('UserPressedSearchButton', query.value, createEventMetadata());\n        }\n      }\n\n      return {\n        dynamicClasses,\n        buttonRef,\n        emitEvents\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`UserAcceptedAQuery`]https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserPressedSearchButton`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n<!-- prettier-ignore-start -->\n:::warning\nNote that no events are emitted if the query is empty.\n:::\n<!-- prettier-ignore-end -->\n\n## Dynamic classes\n\n`SearchButton` uses the `x-search-button--has-empty-query` dynamic CSS class to modify the HTML\nbutton style when the query is empty.\n\n## See it in action\n\nIn this example, a clickable button is rendered.\n\n_Click the Search button to try it out!_\n\n```vue live\n<template>\n  <SearchButton />\n</template>\n\n<script>\n  import { SearchButton } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchButtonDemo',\n    components: {\n      SearchButton\n    }\n  };\n</script>\n```\n\n### Play with default slot\n\nHere text is passed in the default slot instead of an icon to customize the button content.\n\n_Click the icon button to try it out!_\n\n```vue live\n<template>\n  <SearchButton>Search</SearchButton>\n</template>\n\n<script>\n  import { SearchButton } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchButtonDemo',\n    components: {\n      SearchButton\n    }\n  };\n</script>\n```\n\n### Play with events\n\nIn this example, the `UserPressedSearchButton` event has been implemented so that when you enter a\nsearch term and click the Search button, the search term is displayed as a message.\n\n_Type any term in the input field and then click the Search button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex;\">\n      <SearchInput />\n      <SearchButton\n        @UserPressedSearchButton=\"\n          query => {\n            message = query;\n          }\n        \"\n      />\n    </div>\n    {{ message }}\n  </div>\n</template>\n\n<script>\n  import { SearchInput, SearchButton } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchButtonDemo',\n    components: {\n      SearchInput,\n      SearchButton\n    },\n    data() {\n      return {\n        message: ''\n      };\n    }\n  };\n</script>\n```\n\n## Extending the component\n\nComponents can be combined and communicate with each other. Commonly, the `SearchButton` component\ncommunicates with the [`SearchInput`](./search-input.md) to submit the query. In this example, when\nyou enter a search term and click the Search button, the “Looking for results” message is displayed.\n\n_Type any term in the input field and then click the Search button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex;\">\n      <SearchInput />\n      <SearchButton @UserAcceptedAQuery=\"message = 'looking for results'\">Search</SearchButton>\n    </div>\n    {{ message }}\n  </div>\n</template>\n\n<script>\n  import { SearchButton, SearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchButtonDemo',\n    components: {\n      SearchButton,\n      SearchInput\n    },\n    data() {\n      return {\n        message: ''\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;AAqBE;;;;;;;;;AASE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,gBAAgB,CAAC,IAAI;AAC9B,IAAA,KAAK,EAAE,YAAA;AACL,QAAA,MAAM,EAAC,GAAI,KAAK,EAAE,CAAA;AAElB,QAAA,MAAM,SAAU,GAAE,GAAG,CAAqB,IAAI,CAAC,CAAA;AAE/C,QAAA,MAAM,KAAK,GAAwB,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAA;AAEzE,QAAA,MAAM,YAAa,GAAE,QAAQ,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAA;AAE7D,QAAA,MAAM,cAAe,GAAE,QAAQ,CAAgB,OAAO;YACpD,kCAAkC,EAAE,YAAY,CAAC,KAAI;AACtD,SAAA,CAAC,CAAC,CAAA;AAEH;;;;;AAKE;AACF,QAAA,SAAS,mBAAmB,GAAA;YAC1B,OAAO;gBACL,MAAM,EAAE,SAAS,CAAC,KAAK;AACvB,gBAAA,OAAO,EAAE,YAAW;aACrB,CAAA;SACH;AAEA;;;;AAIE;AACF,QAAA,SAAS,UAAU,GAAA;AACjB,YAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACvB,gBAAA,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAA;AACjE,gBAAA,EAAE,CAAC,IAAI,CAAC,yBAAyB,EAAE,KAAK,CAAC,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAA;AACxE,aAAA;SACF;QAEA,OAAO;YACL,cAAc;YACd,SAAS;YACT,UAAS;SACV,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"search-button.vue2.js","sources":["../../../../../src/x-modules/search-box/components/search-button.vue"],"sourcesContent":["<template>\n  <button\n    ref=\"buttonRef\"\n    class=\"x-search-button x-button\"\n    :class=\"dynamicClasses\"\n    data-test=\"search-button\"\n    @click=\"emitEvents\"\n  >\n    <!-- @slot _Required_. Button content (text, icon, or both) -->\n    <slot><span class=\"x-icon\">⌕</span></slot>\n  </button>\n</template>\n\n<script lang=\"ts\">\nimport type { VueCSSClasses } from '../../../utils/types'\nimport type { WireMetadata } from '../../../wiring/wiring.types'\nimport { computed, defineComponent, ref } from 'vue'\nimport { use$x } from '../../../composables/use-$x'\nimport { useState } from '../../../composables/use-state'\nimport { searchBoxXModule } from '../x-module'\n\n/**\n * This component renders a button to submit the query.\n *\n * @remarks\n * If query is not empty, it emits {@link XEventsTypes.UserAcceptedAQuery} and\n * {@link SearchBoxXEvents.UserPressedSearchButton} events with the query as payload.\n * It also adds `x-search-button--has-empty-query` as class when there is no query.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'SearchButton',\n  xModule: searchBoxXModule.name,\n  setup() {\n    const $x = use$x()\n\n    const buttonRef = ref<HTMLElement | null>(null)\n\n    const { query } = useState('searchBox')\n\n    const isQueryEmpty = computed(() => query.value.length === 0)\n\n    const dynamicClasses = computed<VueCSSClasses>(() => ({\n      'x-search-button--has-empty-query': isQueryEmpty.value,\n    }))\n\n    /**\n     * Generates the {@link WireMetadata} object omitting the moduleName.\n     *\n     * @returns The {@link WireMetadata} object omitting the moduleName.\n     * @internal\n     */\n    function createEventMetadata(): Omit<WireMetadata, 'moduleName'> {\n      return {\n        target: buttonRef.value,\n        feature: 'search_box',\n      }\n    }\n\n    /**\n     * Emits events when the button is clicked.\n     *\n     * @public\n     */\n    function emitEvents() {\n      if (!isQueryEmpty.value) {\n        $x.emit('UserAcceptedAQuery', query.value, createEventMetadata())\n        $x.emit('UserPressedSearchButton', query.value, createEventMetadata())\n      }\n    }\n\n    return {\n      dynamicClasses,\n      buttonRef,\n      emitEvents,\n    }\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`UserAcceptedAQuery`]https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserPressedSearchButton`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n<!-- prettier-ignore-start -->\n:::warning\nNote that no events are emitted if the query is empty.\n:::\n<!-- prettier-ignore-end -->\n\n## Dynamic classes\n\n`SearchButton` uses the `x-search-button--has-empty-query` dynamic CSS class to modify the HTML\nbutton style when the query is empty.\n\n## See it in action\n\nIn this example, a clickable button is rendered.\n\n_Click the Search button to try it out!_\n\n```vue live\n<template>\n  <SearchButton />\n</template>\n\n<script>\nimport { SearchButton } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchButtonDemo',\n  components: {\n    SearchButton,\n  },\n}\n</script>\n```\n\n### Play with default slot\n\nHere text is passed in the default slot instead of an icon to customize the button content.\n\n_Click the icon button to try it out!_\n\n```vue live\n<template>\n  <SearchButton>Search</SearchButton>\n</template>\n\n<script>\nimport { SearchButton } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchButtonDemo',\n  components: {\n    SearchButton,\n  },\n}\n</script>\n```\n\n### Play with events\n\nIn this example, the `UserPressedSearchButton` event has been implemented so that when you enter a\nsearch term and click the Search button, the search term is displayed as a message.\n\n_Type any term in the input field and then click the Search button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex;\">\n      <SearchInput />\n      <SearchButton\n        @UserPressedSearchButton=\"\n          query => {\n            message = query\n          }\n        \"\n      />\n    </div>\n    {{ message }}\n  </div>\n</template>\n\n<script>\nimport { SearchInput, SearchButton } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchButtonDemo',\n  components: {\n    SearchInput,\n    SearchButton,\n  },\n  data() {\n    return {\n      message: '',\n    }\n  },\n}\n</script>\n```\n\n## Extending the component\n\nComponents can be combined and communicate with each other. Commonly, the `SearchButton` component\ncommunicates with the [`SearchInput`](./search-input.md) to submit the query. In this example, when\nyou enter a search term and click the Search button, the “Looking for results” message is displayed.\n\n_Type any term in the input field and then click the Search button to try it out!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex;\">\n      <SearchInput />\n      <SearchButton @UserAcceptedAQuery=\"message = 'looking for results'\">Search</SearchButton>\n    </div>\n    {{ message }}\n  </div>\n</template>\n\n<script>\nimport { SearchButton, SearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchButtonDemo',\n  components: {\n    SearchButton,\n    SearchInput,\n  },\n  data() {\n    return {\n      message: '',\n    }\n  },\n}\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;AAqBA;;;;;;;;;AASE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,gBAAgB,CAAC,IAAI;IAC9B,KAAK,GAAA;AACH,QAAA,MAAM,EAAC,GAAI,KAAK,EAAC,CAAA;AAEjB,QAAA,MAAM,SAAQ,GAAI,GAAG,CAAqB,IAAI,CAAA,CAAA;QAE9C,MAAM,EAAE,KAAI,EAAI,GAAE,QAAQ,CAAC,WAAW,CAAA,CAAA;AAEtC,QAAA,MAAM,YAAW,GAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,MAAO,KAAI,CAAC,CAAA,CAAA;AAE5D,QAAA,MAAM,cAAe,GAAE,QAAQ,CAAgB,OAAO;YACpD,kCAAkC,EAAE,YAAY,CAAC,KAAK;AACvD,SAAA,CAAC,CAAA,CAAA;AAEF;;;;;AAKE;AACF,QAAA,SAAS,mBAAmB,GAAA;YAC1B,OAAO;gBACL,MAAM,EAAE,SAAS,CAAC,KAAK;AACvB,gBAAA,OAAO,EAAE,YAAY;aACvB,CAAA;SACF;AAEA;;;;AAIE;AACF,QAAA,SAAS,UAAU,GAAA;AACjB,YAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACvB,gBAAA,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,KAAK,EAAE,mBAAmB,EAAE,CAAA,CAAA;AAChE,gBAAA,EAAE,CAAC,IAAI,CAAC,yBAAyB,EAAE,KAAK,CAAC,KAAK,EAAE,mBAAmB,EAAE,CAAA,CAAA;AACvE,aAAA;SACF;QAEA,OAAO;YACL,cAAc;YACd,SAAS;YACT,UAAU;SACZ,CAAA;KACD;AACF,CAAA,CAAA;;;;"}

package/js/x-modules/search-box/components/search-input-placeholder.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-input-placeholder.vue.js","sources":["../../../../../src/x-modules/search-box/components/search-input-placeholder.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    v-if=\"isVisible\"\n    class=\"x-input-placeholder x-search-input-placeholder\"\n    mode=\"out-in\"\n  >\n    <span :key=\"message\" data-test=\"search-input-placeholder\">\n      {{ message }}\n    </span>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { computed, defineComponent, onBeforeUnmount, PropType, ref, watch } from 'vue';\n  import { animateTranslate } from '../../../components/animations/animate-translate/animate-translate.factory';\n  import { use$x } from '../../../composables/use-$x';\n  import { useState } from '../../../composables/use-state';\n  import { searchBoxXModule } from '../x-module';\n  import { AnimationProp } from '../../../types';\n\n  /**.\n   * This component renders an animated placeholder for the search input in the shape of a list of\n   * iterating messages that can be configured to happen always or only when hovering the input\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SearchInputPlaceholder',\n    xModule: searchBoxXModule.name,\n    props: {\n      /**\n       * List of messages to animate.\n       *\n       * @public\n       */\n      messages: {\n        type: Array as PropType<string[]>,\n        required: true\n      },\n      /**\n       * Animation component used for the messages.\n       *\n       * @public\n       */\n      animation: {\n        type: AnimationProp,\n        default: () => animateTranslate('bottom-to-top')\n      },\n      /**\n       * Time in milliseconds during which each message is visible.\n       *\n       * @public\n       */\n      animationIntervalMs: {\n        type: Number,\n        default: 1500\n      },\n      /**\n       * Whether the messages animation is active only when hovering the search input or always.\n       *\n       * @public\n       */\n      animateOnlyOnHover: Boolean\n    },\n    setup: function (props) {\n      const $x = use$x();\n\n      /**.\n       * The search box written query\n       *\n       * @internal\n       */\n      const { query } = useState('searchBox', ['query']);\n\n      /**.\n       * The search box hover status\n       *\n       * @internal\n       */\n      const isSearchBoxHovered = ref(false);\n\n      /**.\n       * The search box focus status\n       *\n       * @internal\n       */\n      const isSearchBoxFocused = ref(false);\n\n      /**\n       * The index used to point to the current animation message in the list.\n       *\n       * @internal\n       */\n      const animationMessageIndex = ref(0);\n\n      /**\n       * The interval used for the animation.\n       *\n       * @internal\n       */\n      const animationInterval = ref<number | undefined>(undefined);\n\n      /**\n       * The visibility state of the component.\n       *\n       * @returns The visibility state based on the search input state (query & focus).\n       *\n       * @internal\n       */\n      const isVisible = computed((): boolean => !query.value && !isSearchBoxFocused.value);\n\n      /**\n       * The animation state of the component.\n       *\n       * @returns Whether the animation is active or not.\n       *\n       * @internal\n       */\n      const isBeingAnimated = computed(\n        (): boolean => isVisible.value && (!props.animateOnlyOnHover || isSearchBoxHovered.value)\n      );\n\n      /**\n       * The current placeholder message.\n       *\n       * @returns The message to display as placeholder at any moment.\n       *\n       * @internal\n       */\n      const message = computed((): string | undefined =>\n        isBeingAnimated.value ? props.messages[animationMessageIndex.value] : props.messages[0]\n      );\n\n      /**\n       * Clears the interval used for the animation.\n       *\n       * @internal\n       */\n      const stopAnimationInterval = (): void => {\n        if (animationInterval.value) {\n          clearInterval(animationInterval.value);\n          animationInterval.value = undefined;\n        }\n      };\n\n      /**\n       * Increments animation message index; if the new index exceeds the messages list length, it is\n       * reset to 0.\n       *\n       * @internal\n       */\n      const incrementAnimationMessageIndex = (): void => {\n        animationMessageIndex.value = (animationMessageIndex.value + 1) % props.messages.length;\n      };\n\n      $x.on('UserHoveredInSearchBox', false).subscribe(() => (isSearchBoxHovered.value = true));\n\n      $x.on('UserHoveredOutSearchBox', false).subscribe(() => (isSearchBoxHovered.value = false));\n\n      $x.on('UserFocusedSearchBox', false).subscribe(() => (isSearchBoxFocused.value = true));\n\n      $x.on('UserBlurredSearchBox', false).subscribe(() => (isSearchBoxFocused.value = false));\n\n      /**\n       * Starts or stops the animation depending on the current animation state.\n       *\n       * @internal\n       */\n      const resetAnimation = (): void => {\n        stopAnimationInterval();\n        if (isBeingAnimated.value) {\n          animationInterval.value = window.setInterval((): void => {\n            incrementAnimationMessageIndex();\n          }, props.animationIntervalMs);\n        }\n      };\n\n      watch(() => 'animationIntervalMs', resetAnimation);\n\n      /**\n       * Resets the animation message index to zero.\n       *\n       * @internal\n       */\n      const resetAnimationMessageIndex = (): void => {\n        animationMessageIndex.value = 0;\n      };\n\n      watch(\n        () => props.messages,\n        () => {\n          resetAnimationMessageIndex();\n          resetAnimation();\n        },\n        { deep: true }\n      );\n\n      /**\n       * Sets the animation message index with the right value for the next future iteration when the\n       * current one stops,assuring the user will see always a new message on each animation state\n       * change.\n       *\n       * @internal\n       */\n      watch(\n        isBeingAnimated,\n        () => {\n          if (!isBeingAnimated.value) {\n            if (props.animateOnlyOnHover) {\n              resetAnimationMessageIndex();\n            }\n            incrementAnimationMessageIndex();\n          }\n          resetAnimation();\n        },\n        { immediate: true }\n      );\n\n      onBeforeUnmount(() => {\n        stopAnimationInterval();\n      });\n\n      return {\n        isVisible,\n        message\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\">\n  .x-search-input-placeholder-container {\n    position: relative;\n  }\n</style>\n\n<style lang=\"css\" scoped>\n  .x-search-input-placeholder {\n    position: absolute;\n    inset: 0;\n    display: flex;\n    align-items: center;\n    pointer-events: none;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## See it in action\n\nHere a basic example of how the animated search input placeholder is rendered.\n\n```vue live\n<template>\n  <div style=\"position: relative; overflow: hidden;\">\n    <SearchInputPlaceholder\n      style=\"position: absolute; height: 100%; pointer-events: none;\"\n      :messages=\"placeholderMessages\"\n    />\n    <SearchInput />\n  </div>\n</template>\n\n<script>\n  import { SearchInput, SearchInputPlaceholder } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchInputPlaceholderDemo',\n    components: {\n      SearchInput,\n      SearchInputPlaceholder\n    },\n    data: function () {\n      return {\n        placeholderMessages: [\n          'Find shirts',\n          'Find shoes',\n          'Find watches',\n          'Find handbags',\n          'Find sunglasses'\n        ]\n      };\n    }\n  };\n</script>\n```\n\n### Animating only on hover\n\nIn this example, the placeholder is configured to animate only when the user hovers in the search\ninput, showing the first message of the array the rest of the time.\n\n```vue live\n<template>\n  <div style=\"position: relative; overflow: hidden;\">\n    <SearchInputPlaceholder\n      style=\"position: absolute; height: 100%; pointer-events: none;\"\n      :messages=\"placeholderMessages\"\n      :animate-only-on-hover=\"true\"\n    />\n    <SearchInput />\n  </div>\n</template>\n\n<script>\n  import { SearchInput, SearchInputPlaceholder } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchInputPlaceholderDemo',\n    components: {\n      SearchInput,\n      SearchInputPlaceholder\n    },\n    data: function () {\n      return {\n        placeholderMessages: [\n          'Find shirts',\n          'Find shoes',\n          'Find watches',\n          'Find handbags',\n          'Find sunglasses'\n        ]\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["animation","_openBlock","_createBlock","_resolveDynamicComponent","message","_createElementBlock","_toDisplayString","_createCommentVNode"],"mappings":";;;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EADF,MAESA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;AAFT,EAAA,OAAA,IAAA,CAAA,SAAA,IAAAC,SAAA,EAI0D,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IACtD,GAAI,EAAA,CAAA;AAAA,IAAA,KAAA,EAAA,gDAAA;AALR,IAAA,IAAA,EAAA,QAAA;AAAA,GAAA,EAAA;aAOgBC,OAAO,CAAA,MAAA;AAAA,OAAAH,SAAA,EAAY,EAAAI,kBAAA;AAAA,QAAA,MAAA;AAAA,QAA0B;AAAA,UAAA,GAAA,EAAA,IAAA,CAAA,OAAA;;AAP7D,SAAA;AAAA,QAAAC,eAAA,CAAA,IAAA,CAAA,OAAA,CAAA;AAAA,QAAA,CAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;AAAA,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,CAAA,IAAAC,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}
+{"version":3,"file":"search-input-placeholder.vue.js","sources":["../../../../../src/x-modules/search-box/components/search-input-placeholder.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    v-if=\"isVisible\"\n    class=\"x-input-placeholder x-search-input-placeholder\"\n    mode=\"out-in\"\n  >\n    <span :key=\"message\" data-test=\"search-input-placeholder\">\n      {{ message }}\n    </span>\n  </component>\n</template>\n\n<script lang=\"ts\">\nimport type { PropType } from 'vue'\nimport { computed, defineComponent, onBeforeUnmount, ref, watch } from 'vue'\nimport { animateTranslate } from '../../../components/animations/animate-translate/animate-translate.factory'\nimport { use$x } from '../../../composables/use-$x'\nimport { useState } from '../../../composables/use-state'\nimport { AnimationProp } from '../../../types'\nimport { searchBoxXModule } from '../x-module'\n\n/**.\n * This component renders an animated placeholder for the search input in the shape of a list of\n * iterating messages that can be configured to happen always or only when hovering the input\n *\n * @public\n */\nexport default defineComponent({\n  name: 'SearchInputPlaceholder',\n  xModule: searchBoxXModule.name,\n  props: {\n    /**\n     * List of messages to animate.\n     *\n     * @public\n     */\n    messages: {\n      type: Array as PropType<string[]>,\n      required: true,\n    },\n    /**\n     * Animation component used for the messages.\n     *\n     * @public\n     */\n    animation: {\n      type: AnimationProp,\n      default: () => animateTranslate('bottom-to-top'),\n    },\n    /**\n     * Time in milliseconds during which each message is visible.\n     *\n     * @public\n     */\n    animationIntervalMs: {\n      type: Number,\n      default: 1500,\n    },\n    /**\n     * Whether the messages animation is active only when hovering the search input or always.\n     *\n     * @public\n     */\n    animateOnlyOnHover: Boolean,\n  },\n  setup(props) {\n    const $x = use$x()\n\n    /**.\n     * The search box written query\n     *\n     * @internal\n     */\n    const { query } = useState('searchBox')\n\n    /**.\n     * The search box hover status\n     *\n     * @internal\n     */\n    const isSearchBoxHovered = ref(false)\n\n    /**.\n     * The search box focus status\n     *\n     * @internal\n     */\n    const isSearchBoxFocused = ref(false)\n\n    /**\n     * The index used to point to the current animation message in the list.\n     *\n     * @internal\n     */\n    const animationMessageIndex = ref(0)\n\n    /**\n     * The interval used for the animation.\n     *\n     * @internal\n     */\n    const animationInterval = ref<number | undefined>(undefined)\n\n    /**\n     * The visibility state of the component.\n     *\n     * @returns The visibility state based on the search input state (query & focus).\n     *\n     * @internal\n     */\n    const isVisible = computed((): boolean => !query.value && !isSearchBoxFocused.value)\n\n    /**\n     * The animation state of the component.\n     *\n     * @returns Whether the animation is active or not.\n     *\n     * @internal\n     */\n    const isBeingAnimated = computed(\n      (): boolean => isVisible.value && (!props.animateOnlyOnHover || isSearchBoxHovered.value),\n    )\n\n    /**\n     * The current placeholder message.\n     *\n     * @returns The message to display as placeholder at any moment.\n     *\n     * @internal\n     */\n    const message = computed((): string | undefined =>\n      isBeingAnimated.value ? props.messages[animationMessageIndex.value] : props.messages[0],\n    )\n\n    /**\n     * Clears the interval used for the animation.\n     *\n     * @internal\n     */\n    const stopAnimationInterval = (): void => {\n      if (animationInterval.value) {\n        clearInterval(animationInterval.value)\n        animationInterval.value = undefined\n      }\n    }\n\n    /**\n     * Increments animation message index; if the new index exceeds the messages list length, it is\n     * reset to 0.\n     *\n     * @internal\n     */\n    const incrementAnimationMessageIndex = (): void => {\n      animationMessageIndex.value = (animationMessageIndex.value + 1) % props.messages.length\n    }\n\n    $x.on('UserHoveredInSearchBox', false).subscribe(() => (isSearchBoxHovered.value = true))\n\n    $x.on('UserHoveredOutSearchBox', false).subscribe(() => (isSearchBoxHovered.value = false))\n\n    $x.on('UserFocusedSearchBox', false).subscribe(() => (isSearchBoxFocused.value = true))\n\n    $x.on('UserBlurredSearchBox', false).subscribe(() => (isSearchBoxFocused.value = false))\n\n    /**\n     * Starts or stops the animation depending on the current animation state.\n     *\n     * @internal\n     */\n    const resetAnimation = (): void => {\n      stopAnimationInterval()\n      if (isBeingAnimated.value) {\n        animationInterval.value = window.setInterval((): void => {\n          incrementAnimationMessageIndex()\n        }, props.animationIntervalMs)\n      }\n    }\n\n    watch(() => 'animationIntervalMs', resetAnimation)\n\n    /**\n     * Resets the animation message index to zero.\n     *\n     * @internal\n     */\n    const resetAnimationMessageIndex = (): void => {\n      animationMessageIndex.value = 0\n    }\n\n    watch(\n      () => props.messages,\n      () => {\n        resetAnimationMessageIndex()\n        resetAnimation()\n      },\n      { deep: true },\n    )\n\n    /**\n     * Sets the animation message index with the right value for the next future iteration when the\n     * current one stops,assuring the user will see always a new message on each animation state\n     * change.\n     *\n     * @internal\n     */\n    watch(\n      isBeingAnimated,\n      () => {\n        if (!isBeingAnimated.value) {\n          if (props.animateOnlyOnHover) {\n            resetAnimationMessageIndex()\n          }\n          incrementAnimationMessageIndex()\n        }\n        resetAnimation()\n      },\n      { immediate: true },\n    )\n\n    onBeforeUnmount(() => {\n      stopAnimationInterval()\n    })\n\n    return {\n      isVisible,\n      message,\n    }\n  },\n})\n</script>\n\n<style lang=\"css\">\n.x-search-input-placeholder-container {\n  position: relative;\n}\n</style>\n\n<style lang=\"css\" scoped>\n.x-search-input-placeholder {\n  position: absolute;\n  inset: 0;\n  display: flex;\n  align-items: center;\n  pointer-events: none;\n}\n</style>\n\n<docs lang=\"mdx\">\n## See it in action\n\nHere a basic example of how the animated search input placeholder is rendered.\n\n```vue live\n<template>\n  <div style=\"position: relative; overflow: hidden;\">\n    <SearchInputPlaceholder\n      style=\"position: absolute; height: 100%; pointer-events: none;\"\n      :messages=\"placeholderMessages\"\n    />\n    <SearchInput />\n  </div>\n</template>\n\n<script>\nimport { SearchInput, SearchInputPlaceholder } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchInputPlaceholderDemo',\n  components: {\n    SearchInput,\n    SearchInputPlaceholder,\n  },\n  data: function () {\n    return {\n      placeholderMessages: [\n        'Find shirts',\n        'Find shoes',\n        'Find watches',\n        'Find handbags',\n        'Find sunglasses',\n      ],\n    }\n  },\n}\n</script>\n```\n\n### Animating only on hover\n\nIn this example, the placeholder is configured to animate only when the user hovers in the search\ninput, showing the first message of the array the rest of the time.\n\n```vue live\n<template>\n  <div style=\"position: relative; overflow: hidden;\">\n    <SearchInputPlaceholder\n      style=\"position: absolute; height: 100%; pointer-events: none;\"\n      :messages=\"placeholderMessages\"\n      :animate-only-on-hover=\"true\"\n    />\n    <SearchInput />\n  </div>\n</template>\n\n<script>\nimport { SearchInput, SearchInputPlaceholder } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchInputPlaceholderDemo',\n  components: {\n    SearchInput,\n    SearchInputPlaceholder,\n  },\n  data: function () {\n    return {\n      placeholderMessages: [\n        'Find shirts',\n        'Find shoes',\n        'Find watches',\n        'Find handbags',\n        'Find sunglasses',\n      ],\n    }\n  },\n}\n</script>\n```\n</docs>\n"],"names":["animation","_openBlock","_createBlock","_resolveDynamicComponent","message","_createElementBlock","_toDisplayString","_createCommentVNode"],"mappings":";;;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EADF,MAESA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;AAFT,EAAA,OAAA,IAAA,CAAA,SAAA,IAAAC,SAAA,EAI0D,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IACtD,GAAI,EAAA,CAAA;AAAA,IAAA,KAAA,EAAA,gDAAA;AALR,IAAA,IAAA,EAAA,QAAA;AAAA,GAAA,EAAA;aAOgBC,OAAO,CAAA,MAAA;AAAA,OAAAH,SAAA,EAAY,EAAAI,kBAAA;AAAA,QAAA,MAAA;AAAA,QAA0B;AAAA,UAAA,GAAA,EAAA,IAAA,CAAA,OAAA;;AAP7D,SAAA;AAAA,QAAAC,eAAA,CAAA,IAAA,CAAA,OAAA,CAAA;AAAA,QAAA,CAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;AAAA,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,CAAA,IAAAC,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}

package/js/x-modules/search-box/components/search-input-placeholder.vue2.js

@@ -2,8 +2,8 @@ import { defineComponent, ref, computed, watch, onBeforeUnmount } from 'vue';
 import { animateTranslate } from '../../../components/animations/animate-translate/animate-translate.factory.js';
 import { use$x } from '../../../composables/use-_x.js';
 import { useState } from '../../../composables/use-state.js';
-import { searchBoxXModule } from '../x-module.js';
 import { AnimationProp } from '../../../types/animation-prop.js';
+import { searchBoxXModule } from '../x-module.js';
 
 /**.
  * This component renders an animated placeholder for the search input in the shape of a list of
@@ -22,7 +22,7 @@ var _sfc_main = defineComponent({
          */
         messages: {
             type: Array,
-            required: true
+            required: true,
         },
         /**
          * Animation component used for the messages.
@@ -31,7 +31,7 @@ var _sfc_main = defineComponent({
          */
         animation: {
             type: AnimationProp,
-            default: () => animateTranslate('bottom-to-top')
+            default: () => animateTranslate('bottom-to-top'),
         },
         /**
          * Time in milliseconds during which each message is visible.
@@ -40,23 +40,23 @@ var _sfc_main = defineComponent({
          */
         animationIntervalMs: {
             type: Number,
-            default: 1500
+            default: 1500,
         },
         /**
          * Whether the messages animation is active only when hovering the search input or always.
          *
          * @public
          */
-        animateOnlyOnHover: Boolean
+        animateOnlyOnHover: Boolean,
     },
-    setup: function (props) {
+    setup(props) {
         const $x = use$x();
         /**.
          * The search box written query
          *
          * @internal
          */
-        const { query } = useState('searchBox', ['query']);
+        const { query } = useState('searchBox');
         /**.
          * The search box hover status
          *
@@ -176,9 +176,9 @@ var _sfc_main = defineComponent({
         });
         return {
             isVisible,
-            message
+            message,
         };
-    }
+    },
 });
 
 export { _sfc_main as default };

package/js/x-modules/search-box/components/search-input-placeholder.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-input-placeholder.vue2.js","sources":["../../../../../src/x-modules/search-box/components/search-input-placeholder.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    v-if=\"isVisible\"\n    class=\"x-input-placeholder x-search-input-placeholder\"\n    mode=\"out-in\"\n  >\n    <span :key=\"message\" data-test=\"search-input-placeholder\">\n      {{ message }}\n    </span>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { computed, defineComponent, onBeforeUnmount, PropType, ref, watch } from 'vue';\n  import { animateTranslate } from '../../../components/animations/animate-translate/animate-translate.factory';\n  import { use$x } from '../../../composables/use-$x';\n  import { useState } from '../../../composables/use-state';\n  import { searchBoxXModule } from '../x-module';\n  import { AnimationProp } from '../../../types';\n\n  /**.\n   * This component renders an animated placeholder for the search input in the shape of a list of\n   * iterating messages that can be configured to happen always or only when hovering the input\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SearchInputPlaceholder',\n    xModule: searchBoxXModule.name,\n    props: {\n      /**\n       * List of messages to animate.\n       *\n       * @public\n       */\n      messages: {\n        type: Array as PropType<string[]>,\n        required: true\n      },\n      /**\n       * Animation component used for the messages.\n       *\n       * @public\n       */\n      animation: {\n        type: AnimationProp,\n        default: () => animateTranslate('bottom-to-top')\n      },\n      /**\n       * Time in milliseconds during which each message is visible.\n       *\n       * @public\n       */\n      animationIntervalMs: {\n        type: Number,\n        default: 1500\n      },\n      /**\n       * Whether the messages animation is active only when hovering the search input or always.\n       *\n       * @public\n       */\n      animateOnlyOnHover: Boolean\n    },\n    setup: function (props) {\n      const $x = use$x();\n\n      /**.\n       * The search box written query\n       *\n       * @internal\n       */\n      const { query } = useState('searchBox', ['query']);\n\n      /**.\n       * The search box hover status\n       *\n       * @internal\n       */\n      const isSearchBoxHovered = ref(false);\n\n      /**.\n       * The search box focus status\n       *\n       * @internal\n       */\n      const isSearchBoxFocused = ref(false);\n\n      /**\n       * The index used to point to the current animation message in the list.\n       *\n       * @internal\n       */\n      const animationMessageIndex = ref(0);\n\n      /**\n       * The interval used for the animation.\n       *\n       * @internal\n       */\n      const animationInterval = ref<number | undefined>(undefined);\n\n      /**\n       * The visibility state of the component.\n       *\n       * @returns The visibility state based on the search input state (query & focus).\n       *\n       * @internal\n       */\n      const isVisible = computed((): boolean => !query.value && !isSearchBoxFocused.value);\n\n      /**\n       * The animation state of the component.\n       *\n       * @returns Whether the animation is active or not.\n       *\n       * @internal\n       */\n      const isBeingAnimated = computed(\n        (): boolean => isVisible.value && (!props.animateOnlyOnHover || isSearchBoxHovered.value)\n      );\n\n      /**\n       * The current placeholder message.\n       *\n       * @returns The message to display as placeholder at any moment.\n       *\n       * @internal\n       */\n      const message = computed((): string | undefined =>\n        isBeingAnimated.value ? props.messages[animationMessageIndex.value] : props.messages[0]\n      );\n\n      /**\n       * Clears the interval used for the animation.\n       *\n       * @internal\n       */\n      const stopAnimationInterval = (): void => {\n        if (animationInterval.value) {\n          clearInterval(animationInterval.value);\n          animationInterval.value = undefined;\n        }\n      };\n\n      /**\n       * Increments animation message index; if the new index exceeds the messages list length, it is\n       * reset to 0.\n       *\n       * @internal\n       */\n      const incrementAnimationMessageIndex = (): void => {\n        animationMessageIndex.value = (animationMessageIndex.value + 1) % props.messages.length;\n      };\n\n      $x.on('UserHoveredInSearchBox', false).subscribe(() => (isSearchBoxHovered.value = true));\n\n      $x.on('UserHoveredOutSearchBox', false).subscribe(() => (isSearchBoxHovered.value = false));\n\n      $x.on('UserFocusedSearchBox', false).subscribe(() => (isSearchBoxFocused.value = true));\n\n      $x.on('UserBlurredSearchBox', false).subscribe(() => (isSearchBoxFocused.value = false));\n\n      /**\n       * Starts or stops the animation depending on the current animation state.\n       *\n       * @internal\n       */\n      const resetAnimation = (): void => {\n        stopAnimationInterval();\n        if (isBeingAnimated.value) {\n          animationInterval.value = window.setInterval((): void => {\n            incrementAnimationMessageIndex();\n          }, props.animationIntervalMs);\n        }\n      };\n\n      watch(() => 'animationIntervalMs', resetAnimation);\n\n      /**\n       * Resets the animation message index to zero.\n       *\n       * @internal\n       */\n      const resetAnimationMessageIndex = (): void => {\n        animationMessageIndex.value = 0;\n      };\n\n      watch(\n        () => props.messages,\n        () => {\n          resetAnimationMessageIndex();\n          resetAnimation();\n        },\n        { deep: true }\n      );\n\n      /**\n       * Sets the animation message index with the right value for the next future iteration when the\n       * current one stops,assuring the user will see always a new message on each animation state\n       * change.\n       *\n       * @internal\n       */\n      watch(\n        isBeingAnimated,\n        () => {\n          if (!isBeingAnimated.value) {\n            if (props.animateOnlyOnHover) {\n              resetAnimationMessageIndex();\n            }\n            incrementAnimationMessageIndex();\n          }\n          resetAnimation();\n        },\n        { immediate: true }\n      );\n\n      onBeforeUnmount(() => {\n        stopAnimationInterval();\n      });\n\n      return {\n        isVisible,\n        message\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\">\n  .x-search-input-placeholder-container {\n    position: relative;\n  }\n</style>\n\n<style lang=\"css\" scoped>\n  .x-search-input-placeholder {\n    position: absolute;\n    inset: 0;\n    display: flex;\n    align-items: center;\n    pointer-events: none;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## See it in action\n\nHere a basic example of how the animated search input placeholder is rendered.\n\n```vue live\n<template>\n  <div style=\"position: relative; overflow: hidden;\">\n    <SearchInputPlaceholder\n      style=\"position: absolute; height: 100%; pointer-events: none;\"\n      :messages=\"placeholderMessages\"\n    />\n    <SearchInput />\n  </div>\n</template>\n\n<script>\n  import { SearchInput, SearchInputPlaceholder } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchInputPlaceholderDemo',\n    components: {\n      SearchInput,\n      SearchInputPlaceholder\n    },\n    data: function () {\n      return {\n        placeholderMessages: [\n          'Find shirts',\n          'Find shoes',\n          'Find watches',\n          'Find handbags',\n          'Find sunglasses'\n        ]\n      };\n    }\n  };\n</script>\n```\n\n### Animating only on hover\n\nIn this example, the placeholder is configured to animate only when the user hovers in the search\ninput, showing the first message of the array the rest of the time.\n\n```vue live\n<template>\n  <div style=\"position: relative; overflow: hidden;\">\n    <SearchInputPlaceholder\n      style=\"position: absolute; height: 100%; pointer-events: none;\"\n      :messages=\"placeholderMessages\"\n      :animate-only-on-hover=\"true\"\n    />\n    <SearchInput />\n  </div>\n</template>\n\n<script>\n  import { SearchInput, SearchInputPlaceholder } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchInputPlaceholderDemo',\n    components: {\n      SearchInput,\n      SearchInputPlaceholder\n    },\n    data: function () {\n      return {\n        placeholderMessages: [\n          'Find shirts',\n          'Find shoes',\n          'Find watches',\n          'Find handbags',\n          'Find sunglasses'\n        ]\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;AAqBE;;;;;AAKE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,wBAAwB;IAC9B,OAAO,EAAE,gBAAgB,CAAC,IAAI;AAC9B,IAAA,KAAK,EAAE;AACL;;;;AAIE;AACF,QAAA,QAAQ,EAAE;AACR,YAAA,IAAI,EAAE,KAA2B;AACjC,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;AACD;;;;AAIE;AACF,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,MAAM,gBAAgB,CAAC,eAAe,CAAA;AAChD,SAAA;AACD;;;;AAIE;AACF,QAAA,mBAAmB,EAAE;AACnB,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,IAAG;AACb,SAAA;AACD;;;;AAIE;AACF,QAAA,kBAAkB,EAAE,OAAM;AAC3B,KAAA;IACD,KAAK,EAAE,UAAU,KAAK,EAAA;AACpB,QAAA,MAAM,EAAC,GAAI,KAAK,EAAE,CAAA;AAElB;;;;AAIE;AACF,QAAA,MAAM,EAAE,OAAQ,GAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC,CAAA;AAElD;;;;AAIE;AACF,QAAA,MAAM,kBAAiB,GAAI,GAAG,CAAC,KAAK,CAAC,CAAA;AAErC;;;;AAIE;AACF,QAAA,MAAM,kBAAiB,GAAI,GAAG,CAAC,KAAK,CAAC,CAAA;AAErC;;;;AAIE;AACF,QAAA,MAAM,qBAAsB,GAAE,GAAG,CAAC,CAAC,CAAC,CAAA;AAEpC;;;;AAIE;AACF,QAAA,MAAM,iBAAkB,GAAE,GAAG,CAAqB,SAAS,CAAC,CAAA;AAE5D;;;;;;AAME;AACF,QAAA,MAAM,SAAU,GAAE,QAAQ,CAAC,MAAe,CAAC,KAAK,CAAC,KAAM,IAAG,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;AAEpF;;;;;;AAME;QACF,MAAM,eAAc,GAAI,QAAQ,CAC9B,MAAe,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,kBAAiB,IAAK,kBAAkB,CAAC,KAAK,CAAA,CACzF,CAAA;AAED;;;;;;AAME;AACF,QAAA,MAAM,OAAM,GAAI,QAAQ,CAAC,MACvB,eAAe,CAAC,KAAM,GAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA,CACvF,CAAA;AAED;;;;AAIE;QACF,MAAM,qBAAsB,GAAE,MAAY;YACxC,IAAI,iBAAiB,CAAC,KAAK,EAAE;AAC3B,gBAAA,aAAa,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAA;AACtC,gBAAA,iBAAiB,CAAC,QAAQ,SAAS,CAAA;AACrC,aAAA;AACF,SAAC,CAAA;AAED;;;;;AAKE;QACF,MAAM,iCAAiC,MAAY;AACjD,YAAA,qBAAqB,CAAC,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAA;AACzF,SAAC,CAAA;QAED,EAAE,CAAC,EAAE,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,kBAAkB,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAA;QAEzF,EAAE,CAAC,EAAE,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,kBAAkB,CAAC,KAAI,GAAI,KAAK,CAAC,CAAC,CAAA;QAE3F,EAAE,CAAC,EAAE,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,kBAAkB,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAA;QAEvF,EAAE,CAAC,EAAE,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,kBAAkB,CAAC,KAAI,GAAI,KAAK,CAAC,CAAC,CAAA;AAExF;;;;AAIE;QACF,MAAM,cAAe,GAAE,MAAY;AACjC,YAAA,qBAAqB,EAAE,CAAA;YACvB,IAAI,eAAe,CAAC,KAAK,EAAE;gBACzB,iBAAiB,CAAC,KAAM,GAAE,MAAM,CAAC,WAAW,CAAC,MAAY;AACvD,oBAAA,8BAA8B,EAAE,CAAA;AAClC,iBAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;AAC/B,aAAA;AACF,SAAC,CAAA;QAED,KAAK,CAAC,MAAM,qBAAqB,EAAE,cAAc,CAAC,CAAA;AAElD;;;;AAIE;QACF,MAAM,0BAAyB,GAAI,MAAY;AAC7C,YAAA,qBAAqB,CAAC,KAAM,GAAE,CAAC,CAAA;AACjC,SAAC,CAAA;QAED,KAAK,CACH,MAAM,KAAK,CAAC,QAAQ,EACpB,MAAM;AACJ,YAAA,0BAA0B,EAAE,CAAA;AAC5B,YAAA,cAAc,EAAE,CAAA;AAClB,SAAC,EACD,EAAE,IAAI,EAAE,IAAK,EAAA,CACd,CAAA;AAED;;;;;;AAME;AACF,QAAA,KAAK,CACH,eAAe,EACf,MAAM;AACJ,YAAA,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE;gBAC1B,IAAI,KAAK,CAAC,kBAAkB,EAAE;AAC5B,oBAAA,0BAA0B,EAAE,CAAA;AAC9B,iBAAA;AACA,gBAAA,8BAA8B,EAAE,CAAA;AAClC,aAAA;AACA,YAAA,cAAc,EAAE,CAAA;AAClB,SAAC,EACD,EAAE,SAAS,EAAE,IAAK,EAAA,CACnB,CAAA;QAED,eAAe,CAAC,MAAM;AACpB,YAAA,qBAAqB,EAAE,CAAA;AACzB,SAAC,CAAC,CAAA;QAEF,OAAO;YACL,SAAS;YACT,OAAM;SACP,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"search-input-placeholder.vue2.js","sources":["../../../../../src/x-modules/search-box/components/search-input-placeholder.vue"],"sourcesContent":["<template>\n  <component\n    :is=\"animation\"\n    v-if=\"isVisible\"\n    class=\"x-input-placeholder x-search-input-placeholder\"\n    mode=\"out-in\"\n  >\n    <span :key=\"message\" data-test=\"search-input-placeholder\">\n      {{ message }}\n    </span>\n  </component>\n</template>\n\n<script lang=\"ts\">\nimport type { PropType } from 'vue'\nimport { computed, defineComponent, onBeforeUnmount, ref, watch } from 'vue'\nimport { animateTranslate } from '../../../components/animations/animate-translate/animate-translate.factory'\nimport { use$x } from '../../../composables/use-$x'\nimport { useState } from '../../../composables/use-state'\nimport { AnimationProp } from '../../../types'\nimport { searchBoxXModule } from '../x-module'\n\n/**.\n * This component renders an animated placeholder for the search input in the shape of a list of\n * iterating messages that can be configured to happen always or only when hovering the input\n *\n * @public\n */\nexport default defineComponent({\n  name: 'SearchInputPlaceholder',\n  xModule: searchBoxXModule.name,\n  props: {\n    /**\n     * List of messages to animate.\n     *\n     * @public\n     */\n    messages: {\n      type: Array as PropType<string[]>,\n      required: true,\n    },\n    /**\n     * Animation component used for the messages.\n     *\n     * @public\n     */\n    animation: {\n      type: AnimationProp,\n      default: () => animateTranslate('bottom-to-top'),\n    },\n    /**\n     * Time in milliseconds during which each message is visible.\n     *\n     * @public\n     */\n    animationIntervalMs: {\n      type: Number,\n      default: 1500,\n    },\n    /**\n     * Whether the messages animation is active only when hovering the search input or always.\n     *\n     * @public\n     */\n    animateOnlyOnHover: Boolean,\n  },\n  setup(props) {\n    const $x = use$x()\n\n    /**.\n     * The search box written query\n     *\n     * @internal\n     */\n    const { query } = useState('searchBox')\n\n    /**.\n     * The search box hover status\n     *\n     * @internal\n     */\n    const isSearchBoxHovered = ref(false)\n\n    /**.\n     * The search box focus status\n     *\n     * @internal\n     */\n    const isSearchBoxFocused = ref(false)\n\n    /**\n     * The index used to point to the current animation message in the list.\n     *\n     * @internal\n     */\n    const animationMessageIndex = ref(0)\n\n    /**\n     * The interval used for the animation.\n     *\n     * @internal\n     */\n    const animationInterval = ref<number | undefined>(undefined)\n\n    /**\n     * The visibility state of the component.\n     *\n     * @returns The visibility state based on the search input state (query & focus).\n     *\n     * @internal\n     */\n    const isVisible = computed((): boolean => !query.value && !isSearchBoxFocused.value)\n\n    /**\n     * The animation state of the component.\n     *\n     * @returns Whether the animation is active or not.\n     *\n     * @internal\n     */\n    const isBeingAnimated = computed(\n      (): boolean => isVisible.value && (!props.animateOnlyOnHover || isSearchBoxHovered.value),\n    )\n\n    /**\n     * The current placeholder message.\n     *\n     * @returns The message to display as placeholder at any moment.\n     *\n     * @internal\n     */\n    const message = computed((): string | undefined =>\n      isBeingAnimated.value ? props.messages[animationMessageIndex.value] : props.messages[0],\n    )\n\n    /**\n     * Clears the interval used for the animation.\n     *\n     * @internal\n     */\n    const stopAnimationInterval = (): void => {\n      if (animationInterval.value) {\n        clearInterval(animationInterval.value)\n        animationInterval.value = undefined\n      }\n    }\n\n    /**\n     * Increments animation message index; if the new index exceeds the messages list length, it is\n     * reset to 0.\n     *\n     * @internal\n     */\n    const incrementAnimationMessageIndex = (): void => {\n      animationMessageIndex.value = (animationMessageIndex.value + 1) % props.messages.length\n    }\n\n    $x.on('UserHoveredInSearchBox', false).subscribe(() => (isSearchBoxHovered.value = true))\n\n    $x.on('UserHoveredOutSearchBox', false).subscribe(() => (isSearchBoxHovered.value = false))\n\n    $x.on('UserFocusedSearchBox', false).subscribe(() => (isSearchBoxFocused.value = true))\n\n    $x.on('UserBlurredSearchBox', false).subscribe(() => (isSearchBoxFocused.value = false))\n\n    /**\n     * Starts or stops the animation depending on the current animation state.\n     *\n     * @internal\n     */\n    const resetAnimation = (): void => {\n      stopAnimationInterval()\n      if (isBeingAnimated.value) {\n        animationInterval.value = window.setInterval((): void => {\n          incrementAnimationMessageIndex()\n        }, props.animationIntervalMs)\n      }\n    }\n\n    watch(() => 'animationIntervalMs', resetAnimation)\n\n    /**\n     * Resets the animation message index to zero.\n     *\n     * @internal\n     */\n    const resetAnimationMessageIndex = (): void => {\n      animationMessageIndex.value = 0\n    }\n\n    watch(\n      () => props.messages,\n      () => {\n        resetAnimationMessageIndex()\n        resetAnimation()\n      },\n      { deep: true },\n    )\n\n    /**\n     * Sets the animation message index with the right value for the next future iteration when the\n     * current one stops,assuring the user will see always a new message on each animation state\n     * change.\n     *\n     * @internal\n     */\n    watch(\n      isBeingAnimated,\n      () => {\n        if (!isBeingAnimated.value) {\n          if (props.animateOnlyOnHover) {\n            resetAnimationMessageIndex()\n          }\n          incrementAnimationMessageIndex()\n        }\n        resetAnimation()\n      },\n      { immediate: true },\n    )\n\n    onBeforeUnmount(() => {\n      stopAnimationInterval()\n    })\n\n    return {\n      isVisible,\n      message,\n    }\n  },\n})\n</script>\n\n<style lang=\"css\">\n.x-search-input-placeholder-container {\n  position: relative;\n}\n</style>\n\n<style lang=\"css\" scoped>\n.x-search-input-placeholder {\n  position: absolute;\n  inset: 0;\n  display: flex;\n  align-items: center;\n  pointer-events: none;\n}\n</style>\n\n<docs lang=\"mdx\">\n## See it in action\n\nHere a basic example of how the animated search input placeholder is rendered.\n\n```vue live\n<template>\n  <div style=\"position: relative; overflow: hidden;\">\n    <SearchInputPlaceholder\n      style=\"position: absolute; height: 100%; pointer-events: none;\"\n      :messages=\"placeholderMessages\"\n    />\n    <SearchInput />\n  </div>\n</template>\n\n<script>\nimport { SearchInput, SearchInputPlaceholder } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchInputPlaceholderDemo',\n  components: {\n    SearchInput,\n    SearchInputPlaceholder,\n  },\n  data: function () {\n    return {\n      placeholderMessages: [\n        'Find shirts',\n        'Find shoes',\n        'Find watches',\n        'Find handbags',\n        'Find sunglasses',\n      ],\n    }\n  },\n}\n</script>\n```\n\n### Animating only on hover\n\nIn this example, the placeholder is configured to animate only when the user hovers in the search\ninput, showing the first message of the array the rest of the time.\n\n```vue live\n<template>\n  <div style=\"position: relative; overflow: hidden;\">\n    <SearchInputPlaceholder\n      style=\"position: absolute; height: 100%; pointer-events: none;\"\n      :messages=\"placeholderMessages\"\n      :animate-only-on-hover=\"true\"\n    />\n    <SearchInput />\n  </div>\n</template>\n\n<script>\nimport { SearchInput, SearchInputPlaceholder } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchInputPlaceholderDemo',\n  components: {\n    SearchInput,\n    SearchInputPlaceholder,\n  },\n  data: function () {\n    return {\n      placeholderMessages: [\n        'Find shirts',\n        'Find shoes',\n        'Find watches',\n        'Find handbags',\n        'Find sunglasses',\n      ],\n    }\n  },\n}\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;AAsBA;;;;;AAKE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,wBAAwB;IAC9B,OAAO,EAAE,gBAAgB,CAAC,IAAI;AAC9B,IAAA,KAAK,EAAE;AACL;;;;AAIE;AACF,QAAA,QAAQ,EAAE;AACR,YAAA,IAAI,EAAE,KAA2B;AACjC,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;AACD;;;;AAIE;AACF,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,MAAM,gBAAgB,CAAC,eAAe,CAAC;AACjD,SAAA;AACD;;;;AAIE;AACF,QAAA,mBAAmB,EAAE;AACnB,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;AACD;;;;AAIE;AACF,QAAA,kBAAkB,EAAE,OAAO;AAC5B,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT,QAAA,MAAM,EAAC,GAAI,KAAK,EAAC,CAAA;AAEjB;;;;AAIE;QACF,MAAM,EAAE,KAAI,EAAI,GAAE,QAAQ,CAAC,WAAW,CAAA,CAAA;AAEtC;;;;AAIE;AACF,QAAA,MAAM,qBAAqB,GAAG,CAAC,KAAK,CAAA,CAAA;AAEpC;;;;AAIE;AACF,QAAA,MAAM,qBAAqB,GAAG,CAAC,KAAK,CAAA,CAAA;AAEpC;;;;AAIE;AACF,QAAA,MAAM,qBAAoB,GAAI,GAAG,CAAC,CAAC,CAAA,CAAA;AAEnC;;;;AAIE;AACF,QAAA,MAAM,iBAAkB,GAAE,GAAG,CAAqB,SAAS,CAAA,CAAA;AAE3D;;;;;;AAME;AACF,QAAA,MAAM,SAAU,GAAE,QAAQ,CAAC,MAAe,CAAC,KAAK,CAAC,KAAI,IAAK,CAAC,kBAAkB,CAAC,KAAK,CAAA,CAAA;AAEnF;;;;;;AAME;QACF,MAAM,eAAc,GAAI,QAAQ,CAC9B,MAAe,SAAS,CAAC,KAAI,KAAM,CAAC,KAAK,CAAC,kBAAmB,IAAG,kBAAkB,CAAC,KAAK,CAAC,CAC3F,CAAA;AAEA;;;;;;AAME;AACF,QAAA,MAAM,OAAM,GAAI,QAAQ,CAAC,MACvB,eAAe,CAAC,KAAM,GAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CACzF,CAAA;AAEA;;;;AAIE;QACF,MAAM,qBAAsB,GAAE,MAAY;YACxC,IAAI,iBAAiB,CAAC,KAAK,EAAE;AAC3B,gBAAA,aAAa,CAAC,iBAAiB,CAAC,KAAK,CAAA,CAAA;AACrC,gBAAA,iBAAiB,CAAC,KAAM,GAAE,SAAQ,CAAA;AACpC,aAAA;AACF,SAAA,CAAA;AAEA;;;;;AAKE;QACF,MAAM,iCAAiC,MAAY;AACjD,YAAA,qBAAqB,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAM,GAAE,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAK,CAAA;AACxF,SAAA,CAAA;QAEA,EAAE,CAAC,EAAE,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,kBAAkB,CAAC,KAAM,GAAE,IAAI,CAAC,CAAA,CAAA;QAExF,EAAE,CAAC,EAAE,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,kBAAkB,CAAC,QAAQ,KAAK,CAAC,CAAA,CAAA;QAE1F,EAAE,CAAC,EAAE,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,kBAAkB,CAAC,KAAM,GAAE,IAAI,CAAC,CAAA,CAAA;QAEtF,EAAE,CAAC,EAAE,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,OAAO,kBAAkB,CAAC,QAAQ,KAAK,CAAC,CAAA,CAAA;AAEvF;;;;AAIE;QACF,MAAM,cAAe,GAAE,MAAY;AACjC,YAAA,qBAAqB,EAAC,CAAA;YACtB,IAAI,eAAe,CAAC,KAAK,EAAE;gBACzB,iBAAiB,CAAC,KAAM,GAAE,MAAM,CAAC,WAAW,CAAC,MAAY;AACvD,oBAAA,8BAA8B,EAAC,CAAA;AACjC,iBAAC,EAAE,KAAK,CAAC,mBAAmB,CAAA,CAAA;AAC9B,aAAA;AACF,SAAA,CAAA;QAEA,KAAK,CAAC,MAAM,qBAAqB,EAAE,cAAc,CAAA,CAAA;AAEjD;;;;AAIE;QACF,MAAM,0BAAyB,GAAI,MAAY;AAC7C,YAAA,qBAAqB,CAAC,KAAI,GAAI,CAAA,CAAA;AAChC,SAAA,CAAA;QAEA,KAAK,CACH,MAAM,KAAK,CAAC,QAAQ,EACpB,MAAM;AACJ,YAAA,0BAA0B,EAAC,CAAA;AAC3B,YAAA,cAAc,EAAC,CAAA;AACjB,SAAC,EACD,EAAE,IAAI,EAAE,IAAG,EAAG,CAChB,CAAA;AAEA;;;;;;AAME;AACF,QAAA,KAAK,CACH,eAAe,EACf,MAAM;AACJ,YAAA,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE;gBAC1B,IAAI,KAAK,CAAC,kBAAkB,EAAE;AAC5B,oBAAA,0BAA0B,EAAC,CAAA;AAC7B,iBAAA;AACA,gBAAA,8BAA8B,EAAC,CAAA;AACjC,aAAA;AACA,YAAA,cAAc,EAAC,CAAA;AACjB,SAAC,EACD,EAAE,SAAS,EAAE,MAAM,CACrB,CAAA;QAEA,eAAe,CAAC,MAAM;AACpB,YAAA,qBAAqB,EAAC,CAAA;AACxB,SAAC,CAAA,CAAA;QAED,OAAO;YACL,SAAS;YACT,OAAO;SACT,CAAA;KACD;AACF,CAAA,CAAA;;;;"}

package/js/x-modules/search-box/components/search-input.vue.js

@@ -7,6 +7,15 @@ const _hoisted_1 = ["maxlength", "value"];
 function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
   return openBlock(), createElementBlock("input", {
     ref: "inputElement",
+    maxlength: _ctx.maxLength,
+    value: _ctx.query,
+    autocomplete: "off",
+    class: "x-search-input x-input",
+    enterkeyhint: "search",
+    inputmode: "search",
+    type: "search",
+    "data-test": "search-input",
+    "aria-label": "type your query here",
     onMouseenter: _cache[0] || (_cache[0] = (...args) => _ctx.emitUserHoveredInSearchBox && _ctx.emitUserHoveredInSearchBox(...args)),
     onMouseleave: _cache[1] || (_cache[1] = (...args) => _ctx.emitUserHoveredOutSearchBox && _ctx.emitUserHoveredOutSearchBox(...args)),
     onBlur: _cache[2] || (_cache[2] = (...args) => _ctx.emitUserBlurredSearchBox && _ctx.emitUserBlurredSearchBox(...args)),
@@ -17,16 +26,7 @@ function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
       _cache[6] || (_cache[6] = withKeys((...args) => _ctx.emitUserPressedEnterKey && _ctx.emitUserPressedEnterKey(...args), ["enter"])),
       _cache[7] || (_cache[7] = withKeys(withModifiers((...args) => _ctx.emitUserPressedArrowKey && _ctx.emitUserPressedArrowKey(...args), ["prevent"]), ["up", "down"]))
     ],
-    onBeforeinput: _cache[8] || (_cache[8] = (...args) => _ctx.preventSpecialKey && _ctx.preventSpecialKey(...args)),
-    maxlength: _ctx.maxLength,
-    value: _ctx.query,
-    autocomplete: "off",
-    class: "x-search-input x-input",
-    enterkeyhint: "search",
-    inputmode: "search",
-    type: "search",
-    "data-test": "search-input",
-    "aria-label": "type your query here"
+    onBeforeinput: _cache[8] || (_cache[8] = (...args) => _ctx.preventSpecialKey && _ctx.preventSpecialKey(...args))
   }, null, 40, _hoisted_1);
 }
 var searchInput = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render], ["__scopeId", "data-v-ae31d02d"]]);

package/js/x-modules/search-box/components/search-input.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-input.vue.js","sources":["../../../../../src/x-modules/search-box/components/search-input.vue"],"sourcesContent":["<template>\n  <input\n    ref=\"inputElement\"\n    @mouseenter=\"emitUserHoveredInSearchBox\"\n    @mouseleave=\"emitUserHoveredOutSearchBox\"\n    @blur=\"emitUserBlurredSearchBox\"\n    @click=\"emitUserClickedSearchBox\"\n    @focus=\"emitUserFocusedSearchBox\"\n    @input=\"emitUserIsTypingAQueryEvents\"\n    @keydown.enter=\"emitUserPressedEnterKey\"\n    @keydown.up.down.prevent=\"emitUserPressedArrowKey\"\n    @beforeinput=\"preventSpecialKey\"\n    :maxlength=\"maxLength\"\n    :value=\"query\"\n    autocomplete=\"off\"\n    class=\"x-search-input x-input\"\n    enterkeyhint=\"search\"\n    inputmode=\"search\"\n    type=\"search\"\n    data-test=\"search-input\"\n    aria-label=\"type your query here\"\n  />\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent, onMounted, ref } from 'vue';\n  import { ArrowKey } from '../../../utils';\n  import { debounce } from '../../../utils/debounce';\n  import { DebouncedFunction } from '../../../utils/types';\n  import { XEvent } from '../../../wiring/events.types';\n  import { WireMetadata } from '../../../wiring/wiring.types';\n  import { use$x } from '../../../composables/use-$x';\n  import { useState } from '../../../composables/use-state';\n  import { searchBoxXModule } from '../x-module';\n\n  /**\n   * This component renders an input field that allows the user to type a query. It also reacts to\n   * query changes through event listening.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'SearchInput',\n    xModule: searchBoxXModule.name,\n    props: {\n      /**\n       * Maximum characters allowed in the input search.\n       */\n      maxLength: {\n        type: Number,\n        default: 64\n      },\n      /**\n       * Allows input autofocus when the search field is rendered.\n       */\n      autofocus: {\n        type: Boolean,\n        default: true\n      },\n      /**\n       * Enables the auto-accept query after debounce.\n       */\n      instant: {\n        type: Boolean,\n        default: true\n      },\n      /**\n       * Debounce time for the instant.\n       */\n      instantDebounceInMs: {\n        type: Number,\n        default: 500\n      }\n    },\n    setup: function (props) {\n      const $x = use$x();\n\n      const { query } = useState('searchBox', ['query']);\n\n      const inputElement = ref<HTMLInputElement>();\n\n      let debouncedUserAcceptedAQuery: DebouncedFunction<[string]>;\n\n      /**\n       * Generates the {@link WireMetadata} object omitting the moduleName.\n       *\n       * @returns The {@link WireMetadata} object omitting the moduleName.\n       * @internal\n       */\n      const createEventMetadata = (): Omit<WireMetadata, 'moduleName'> => {\n        return {\n          target: inputElement.value,\n          feature: 'search_box'\n        };\n      };\n\n      /**\n       * Emits {@link XEventsTypes.UserAcceptedAQuery} event.\n       *\n       * @remarks It is necessary in a separated method to use it as the parameter of debounce in\n       * emitDebouncedUserAcceptedAQuery method.\n       * @internal\n       * @param query - The query that will be emitted.\n       */\n      const emitUserAcceptedAQuery = (query: string): void => {\n        $x.emit('UserAcceptedAQuery', query, createEventMetadata());\n      };\n\n      /**\n       * Emits {@link XEventsTypes.UserAcceptedAQuery} event with a debounce configured in\n       * `instantDebounceInMs` prop.\n       *\n       * @internal\n       * @param query - The query that will be emitted.\n       */\n      const emitDebouncedUserAcceptedAQuery = (query: string): void => {\n        if (props.instant) {\n          if (!debouncedUserAcceptedAQuery) {\n            debouncedUserAcceptedAQuery = debounce(\n              emitUserAcceptedAQuery,\n              props.instantDebounceInMs\n            );\n          }\n          debouncedUserAcceptedAQuery(query);\n        }\n      };\n\n      /**\n       * Emits event {@link SearchBoxXEvents.UserHoveredInSearchBox} when search box is hovered in.\n       *\n       * @internal\n       */\n      const emitUserHoveredInSearchBox = (): void => {\n        $x.emit('UserHoveredInSearchBox', undefined, { target: inputElement.value });\n      };\n\n      /**\n       * Emits event {@link SearchBoxXEvents.UserHoveredOutSearchBox} when search box is hovered out.\n       *\n       * @internal\n       */\n      const emitUserHoveredOutSearchBox = (): void => {\n        $x.emit('UserHoveredOutSearchBox', undefined, { target: inputElement.value });\n      };\n\n      /**\n       * Emits event {@link SearchBoxXEvents.UserBlurredSearchBox} when search box loses focus.\n       *\n       * @internal\n       */\n      const emitUserBlurredSearchBox = (): void => {\n        $x.emit('UserBlurredSearchBox', undefined, { target: inputElement.value });\n      };\n\n      /**\n       * Emits event {@link SearchBoxXEvents.UserClickedSearchBox} when user clicks  the search input.\n       *\n       * @internal\n       */\n      const emitUserClickedSearchBox = (): void => {\n        $x.emit('UserClickedSearchBox', undefined, { target: inputElement.value });\n      };\n\n      /**\n       * Emits event {@link SearchBoxXEvents.UserFocusedSearchBox} when search box gains focus.\n       *\n       * @internal\n       */\n      const emitUserFocusedSearchBox = (): void => {\n        $x.emit('UserFocusedSearchBox', undefined, { target: inputElement.value });\n      };\n\n      /**\n       * Emits event {@link SearchBoxXEvents.UserIsTypingAQuery} when the user typed/pasted something\n       * into the search-box. Also emits event {@link SearchBoxXEvents.UserClearedQuery} when the user\n       * removes all characters in the search-box.\n       *\n       * @internal\n       */\n      const emitUserIsTypingAQueryEvents = (): void => {\n        const query = inputElement.value?.value ?? '';\n\n        $x.emit('UserIsTypingAQuery', query, { target: inputElement.value });\n        if (query.trim()) {\n          emitDebouncedUserAcceptedAQuery(query);\n        } else {\n          cancelDebouncedUserAcceptedAQuery();\n        }\n      };\n\n      /**\n       * Emits event {@link XEventsTypes.UserPressedArrowKey} when the user pressed an arrow key.\n       *\n       * @param event - The keyboard event with the arrow key pressed.\n       * @internal\n       */\n      const emitUserPressedArrowKey = (event: KeyboardEvent): void => {\n        $x.emit('UserPressedArrowKey', event.key as ArrowKey, createEventMetadata());\n      };\n\n      /**\n       * Emits multiple events when the user pressed the enter key.\n       *\n       * @remarks\n       * Emitted events are:\n       * {@link SearchBoxXEvents.UserPressedEnterKey}\n       * {@link XEventsTypes.UserAcceptedAQuery}\n       *\n       * @internal\n       */\n      const emitUserPressedEnterKey = (): void => {\n        const query = inputElement.value?.value.trim();\n        if (!!query && query.length > 0) {\n          $x.emit('UserPressedEnterKey', query, createEventMetadata());\n          emitUserAcceptedAQuery(query);\n        }\n        inputElement.value?.blur();\n      };\n\n      /**\n       * Prevents the user from either typing or pasting special characters in the input field.\n       *\n       * @internal\n       * @param event - The event that will be checked for special characters.\n       */\n      const preventSpecialKey = (event: InputEvent): void => {\n        if (/[<>]/.test(event.data ?? '')) {\n          event.preventDefault();\n        }\n      };\n\n      /**\n       * When event {@link XEventsTypes.UserReachedEmpathizeTop} or\n       * {@link SearchBoxXEvents.UserPressedClearSearchBoxButton}\n       * are emitted the search input is focused.\n       *\n       * @internal\n       */\n      function focusInput(): void {\n        inputElement.value?.focus();\n      }\n      ['UserReachedEmpathizeTop', 'UserPressedClearSearchBoxButton'].forEach(event =>\n        $x.on(event as XEvent, false).subscribe(focusInput)\n      );\n\n      /**\n       * When event {@link XEventsTypes.UserAcceptedAQuery} or\n       * {@link SearchBoxXEvents.UserClearedQuery} are emitted the pending debounced emit\n       * {@link XEvent} `UserAcceptedAQuery` is canceled.\n       *\n       * @internal\n       */\n      function cancelDebouncedUserAcceptedAQuery(): void {\n        debouncedUserAcceptedAQuery?.cancel();\n      }\n      ['UserAcceptedAQuery', 'UserClearedQuery'].forEach(event =>\n        $x.on(event as XEvent, false).subscribe(cancelDebouncedUserAcceptedAQuery)\n      );\n\n      onMounted(() => {\n        if (props.autofocus) {\n          focusInput();\n        }\n      });\n\n      return {\n        query,\n        inputElement,\n        emitUserHoveredInSearchBox,\n        emitUserHoveredOutSearchBox,\n        emitUserBlurredSearchBox,\n        emitUserClickedSearchBox,\n        emitUserFocusedSearchBox,\n        emitUserIsTypingAQueryEvents,\n        emitUserPressedEnterKey,\n        emitUserPressedArrowKey,\n        preventSpecialKey\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-search-input::-webkit-search-decoration,\n  .x-search-input::-webkit-search-cancel-button,\n  .x-search-input::-webkit-search-results-button,\n  .x-search-input::-webkit-search-results-decoration {\n    -webkit-appearance: none;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`UserClickedSearchBox`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserBlurredSearchBox`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserFocusedSearchBox`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserIsTypingAQuery`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserPressedEnterKey`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserPressedArrowKey`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserAcceptedAQuery`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n## See it in action\n\n<!-- prettier-ignore-start -->\n:::warning Backend service required\nTo use this component, the Search service must be implemented.\n:::\n<!-- prettier-ignore-end -->\n\nHere you have a basic example of how the search input is rendered.\n\n_Type any term in the input field to try it out!_\n\n```vue live\n<template>\n  <SearchInput />\n</template>\n\n<script>\n  import { SearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchInputDemo',\n    components: {\n      SearchInput\n    }\n  };\n</script>\n```\n\n### Play with props\n\nIn this example, the search input has been limited to accept a maximum of 5 characters, including\nspaces, it won't take the focus when it is rendered, and it will emit the `UserAcceptedAQuery` event\nafter 1000 milliseconds without typing.\n\n_Type a term with more than 5 characters to try it out!_\n\n```vue live\n<template>\n  <SearchInput :maxLength=\"5\" :autofocus=\"false\" :instant=\"true\" :instantDebounceInMs=\"1000\" />\n</template>\n\n<script>\n  import { SearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchInputDemo',\n    components: {\n      SearchInput\n    }\n  };\n</script>\n```\n\n### Play with events\n\nIn this example, a message has been added below the search input to illustrate the action performed.\nFor example, if you select the search input box, the message “focus” appears. When you start to\nenter a search term, the message “typing” appears. If you press Enter after typing a search term,\nthe message “enter” appears.\n\n<!-- prettier-ignore-start -->\n:::warning X Events are only emitted from the root X Component.\nAt the moment, X Events are only emitted from the root X Component. This means that if you wrap\nthe `SearchInput` with another component of another module like the `MainScroll`, you should add\nthe listeners to the `MainScroll` instead of the `SearchInput`. If you need to subscribe to these\nevents, it is recommended to use the [`GlobalXBus`](../common/x-components.global-x-bus.md)\ncomponent instead.\n:::\n<!-- prettier-ignore-end -->\n\n_Type any term in the input field to try it out!_\n\n```vue live\n<template>\n  <div>\n    <SearchInput\n      @UserPressedEnterKey=\"value = 'enter'\"\n      @UserFocusedSearchBox=\"hasFocus = true\"\n      @UserBlurredSearchBox=\"hasFocus = false\"\n      @UserIsTypingAQuery=\"value = 'typing'\"\n    />\n    <strong>{{ value }}</strong>\n    <span>{{ hasFocus ? 'focused' : 'unfocused' }}</span>\n  </div>\n</template>\n\n<script>\n  import { SearchInput } from '@empathyco/x-components/search-box';\n\n  export default {\n    name: 'SearchInputDemo',\n    components: {\n      SearchInput\n    },\n    data() {\n      return {\n        value: '',\n        hasFocus: false\n      };\n    }\n  };\n</script>\n```\n\n## Extending the component\n\nComponents can be combined and communicate with each other. Commonly, the `SearchInput` component\ncommunicates with the [`SearchButton`](x-components.search-button.md) and the\n[`ClearSearchInput`](x-components.clear-search-input.md) to offer a full query entry experience.\nFurthermore, you can use it together with the [`QuerySuggestions`](query-suggestions.md) component\nto autocomplete the typed search term.\n\n_Type “trousers” or another fashion term in the input field and then click the clear icon to try it\nout!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex; flex-flow: row nowrap;\">\n      <SearchInput />\n      <ClearSearchInput>\n        <img src=\"/assets/icons/cross.svg\" />\n      </ClearSearchInput>\n      <SearchButton>Search</SearchButton>\n    </div>\n    <QuerySuggestions />\n  </div>\n</template>\n\n<script>\n  import { SearchInput, ClearSearchInput, SearchButton } from '@empathyco/x-components/search-box';\n  import { QuerySuggestions } from '@empathyco/x-components/query-suggestions';\n\n  export default {\n    name: 'SearchInputDemo',\n    components: {\n      SearchInput,\n      ClearSearchInput,\n      SearchButton,\n      QuerySuggestions\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","query"],"mappings":";;;;;;SAEQ,WAAc,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;SACjBA,SAAU,EAAA,EAAAC,kBAAA,CAAA,OAAA,EAAA;AAAA,IACV,GAAA,EAAA,cAAA;AAAA,IACA,YAAA,EAAI,uCAAE,IAAwB,CAAA,0BAAA,IAAA,IAAA,CAAA,0BAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAC9B,YAAA,EAAK,uCAAE,IAAwB,CAAA,2BAAA,IAAA,IAAA,CAAA,2BAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAC/B,QAAK,MAAE,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,wBAAA,IAAA,IAAA,CAAA,wBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IACP,SAAK,MAAE,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,wBAAA,IAAA,IAAA,CAAA,wBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IACP,OAAO,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,wBAAA,IAAA,IAAA,CAAA,wBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAAA,OAAA,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CATZ,uBASoB,4BAAuB,IAAA,IAAA,CAAA,4BAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAAA,SAAA,EAAA;;AAEtC,MAAA,MAAA,CAAA,CAAA,CAAA,KAAW,uCAAE,IAAiB,KAAA,IAAA,CAAA,uBAAA,IAAA,IAAA,CAAA,uBAAA,CAAA,GAAA,IAAA,CAAA,EAAA,CAAA,SAAA,CAAA,CAAA,EAAA,CAAA,IAAA,EAAA,MAAA,CAAA,CAAA,CAAA;AAAA,KAC9B;AAAA,IACA,eAAOC,MAAK,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,iBAAA,IAAA,IAAA,CAAA,iBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IACb,SAAa,EAAA,IAAA,CAAA,SAAA;AAAA,IACb,KAAM,EAAA,IAAA,CAAA,KAAA;AAAA,IACN,YAAa,EAAA,KAAA;AAAA,IACb,KAAA,EAAA,wBAAA;AAAA,IACA,YAAa,EAAA,QAAA;AAAA,IACb,SAAS,EAAA,QAAA;AAAA,IACT,IAAA,EAAA,QAAA;AAAA,IAAA,WAAA,EAAA,cAAA;;;;;;;;"}
+{"version":3,"file":"search-input.vue.js","sources":["../../../../../src/x-modules/search-box/components/search-input.vue"],"sourcesContent":["<template>\n  <input\n    ref=\"inputElement\"\n    :maxlength=\"maxLength\"\n    :value=\"query\"\n    autocomplete=\"off\"\n    class=\"x-search-input x-input\"\n    enterkeyhint=\"search\"\n    inputmode=\"search\"\n    type=\"search\"\n    data-test=\"search-input\"\n    aria-label=\"type your query here\"\n    @mouseenter=\"emitUserHoveredInSearchBox\"\n    @mouseleave=\"emitUserHoveredOutSearchBox\"\n    @blur=\"emitUserBlurredSearchBox\"\n    @click=\"emitUserClickedSearchBox\"\n    @focus=\"emitUserFocusedSearchBox\"\n    @input=\"emitUserIsTypingAQueryEvents\"\n    @keydown.enter=\"emitUserPressedEnterKey\"\n    @keydown.up.down.prevent=\"emitUserPressedArrowKey\"\n    @beforeinput=\"preventSpecialKey\"\n  />\n</template>\n\n<script lang=\"ts\">\nimport type { ArrowKey } from '../../../utils'\nimport type { DebouncedFunction } from '../../../utils/types'\nimport type { XEvent } from '../../../wiring/events.types'\nimport type { WireMetadata } from '../../../wiring/wiring.types'\nimport { defineComponent, onMounted, ref } from 'vue'\nimport { use$x } from '../../../composables/use-$x'\nimport { useState } from '../../../composables/use-state'\nimport { debounce } from '../../../utils/debounce'\nimport { searchBoxXModule } from '../x-module'\n\n/**\n * This component renders an input field that allows the user to type a query. It also reacts to\n * query changes through event listening.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'SearchInput',\n  xModule: searchBoxXModule.name,\n  props: {\n    /**\n     * Maximum characters allowed in the input search.\n     */\n    maxLength: {\n      type: Number,\n      default: 64,\n    },\n    /**\n     * Allows input autofocus when the search field is rendered.\n     */\n    autofocus: {\n      type: Boolean,\n      default: true,\n    },\n    /**\n     * Enables the auto-accept query after debounce.\n     */\n    instant: {\n      type: Boolean,\n      default: true,\n    },\n    /**\n     * Debounce time for the instant.\n     */\n    instantDebounceInMs: {\n      type: Number,\n      default: 500,\n    },\n  },\n  setup(props) {\n    const $x = use$x()\n\n    const { query } = useState('searchBox')\n\n    const inputElement = ref<HTMLInputElement>()\n\n    let debouncedUserAcceptedAQuery: DebouncedFunction<[string]>\n\n    /**\n     * Generates the {@link WireMetadata} object omitting the moduleName.\n     *\n     * @returns The {@link WireMetadata} object omitting the moduleName.\n     * @internal\n     */\n    const createEventMetadata = (): Omit<WireMetadata, 'moduleName'> => {\n      return {\n        target: inputElement.value,\n        feature: 'search_box',\n      }\n    }\n\n    /**\n     * Emits {@link XEventsTypes.UserAcceptedAQuery} event.\n     *\n     * @remarks It is necessary in a separated method to use it as the parameter of debounce in\n     * emitDebouncedUserAcceptedAQuery method.\n     * @internal\n     * @param query - The query that will be emitted.\n     */\n    const emitUserAcceptedAQuery = (query: string): void => {\n      $x.emit('UserAcceptedAQuery', query, createEventMetadata())\n    }\n\n    /**\n     * Emits {@link XEventsTypes.UserAcceptedAQuery} event with a debounce configured in\n     * `instantDebounceInMs` prop.\n     *\n     * @internal\n     * @param query - The query that will be emitted.\n     */\n    const emitDebouncedUserAcceptedAQuery = (query: string): void => {\n      if (props.instant) {\n        if (!debouncedUserAcceptedAQuery) {\n          debouncedUserAcceptedAQuery = debounce(emitUserAcceptedAQuery, props.instantDebounceInMs)\n        }\n        debouncedUserAcceptedAQuery(query)\n      }\n    }\n\n    /**\n     * Emits event {@link SearchBoxXEvents.UserHoveredInSearchBox} when search box is hovered in.\n     *\n     * @internal\n     */\n    const emitUserHoveredInSearchBox = (): void => {\n      $x.emit('UserHoveredInSearchBox', undefined, { target: inputElement.value })\n    }\n\n    /**\n     * Emits event {@link SearchBoxXEvents.UserHoveredOutSearchBox} when search box is hovered out.\n     *\n     * @internal\n     */\n    const emitUserHoveredOutSearchBox = (): void => {\n      $x.emit('UserHoveredOutSearchBox', undefined, { target: inputElement.value })\n    }\n\n    /**\n     * Emits event {@link SearchBoxXEvents.UserBlurredSearchBox} when search box loses focus.\n     *\n     * @internal\n     */\n    const emitUserBlurredSearchBox = (): void => {\n      $x.emit('UserBlurredSearchBox', undefined, { target: inputElement.value })\n    }\n\n    /**\n     * Emits event {@link SearchBoxXEvents.UserClickedSearchBox} when user clicks  the search input.\n     *\n     * @internal\n     */\n    const emitUserClickedSearchBox = (): void => {\n      $x.emit('UserClickedSearchBox', undefined, { target: inputElement.value })\n    }\n\n    /**\n     * Emits event {@link SearchBoxXEvents.UserFocusedSearchBox} when search box gains focus.\n     *\n     * @internal\n     */\n    const emitUserFocusedSearchBox = (): void => {\n      $x.emit('UserFocusedSearchBox', undefined, { target: inputElement.value })\n    }\n\n    /**\n     * Emits event {@link SearchBoxXEvents.UserIsTypingAQuery} when the user typed/pasted something\n     * into the search-box. Also emits event {@link SearchBoxXEvents.UserClearedQuery} when the user\n     * removes all characters in the search-box.\n     *\n     * @internal\n     */\n    const emitUserIsTypingAQueryEvents = (): void => {\n      const query = inputElement.value?.value ?? ''\n\n      $x.emit('UserIsTypingAQuery', query, { target: inputElement.value })\n      if (query.trim()) {\n        emitDebouncedUserAcceptedAQuery(query)\n      } else {\n        cancelDebouncedUserAcceptedAQuery()\n      }\n    }\n\n    /**\n     * Emits event {@link XEventsTypes.UserPressedArrowKey} when the user pressed an arrow key.\n     *\n     * @param event - The keyboard event with the arrow key pressed.\n     * @internal\n     */\n    const emitUserPressedArrowKey = (event: KeyboardEvent): void => {\n      $x.emit('UserPressedArrowKey', event.key as ArrowKey, createEventMetadata())\n    }\n\n    /**\n     * Emits multiple events when the user pressed the enter key.\n     *\n     * @remarks\n     * Emitted events are:\n     * {@link SearchBoxXEvents.UserPressedEnterKey}\n     * {@link XEventsTypes.UserAcceptedAQuery}\n     *\n     * @internal\n     */\n    const emitUserPressedEnterKey = (): void => {\n      const query = inputElement.value?.value.trim()\n      if (!!query && query.length > 0) {\n        $x.emit('UserPressedEnterKey', query, createEventMetadata())\n        emitUserAcceptedAQuery(query)\n      }\n      inputElement.value?.blur()\n    }\n\n    /**\n     * Prevents the user from either typing or pasting special characters in the input field.\n     *\n     * @internal\n     * @param event - The event that will be checked for special characters.\n     */\n    const preventSpecialKey = (event: InputEvent): void => {\n      if (/[<>]/.test(event.data ?? '')) {\n        event.preventDefault()\n      }\n    }\n\n    /**\n     * When event {@link XEventsTypes.UserReachedEmpathizeTop} or\n     * {@link SearchBoxXEvents.UserPressedClearSearchBoxButton}\n     * are emitted the search input is focused.\n     *\n     * @internal\n     */\n    function focusInput(): void {\n      inputElement.value?.focus()\n    }\n    ;['UserReachedEmpathizeTop', 'UserPressedClearSearchBoxButton'].forEach(event =>\n      $x.on(event as XEvent, false).subscribe(focusInput),\n    )\n\n    /**\n     * When event {@link XEventsTypes.UserAcceptedAQuery} or\n     * {@link SearchBoxXEvents.UserClearedQuery} are emitted the pending debounced emit\n     * {@link XEvent} `UserAcceptedAQuery` is canceled.\n     *\n     * @internal\n     */\n    function cancelDebouncedUserAcceptedAQuery(): void {\n      debouncedUserAcceptedAQuery?.cancel()\n    }\n    ;['UserAcceptedAQuery', 'UserClearedQuery'].forEach(event =>\n      $x.on(event as XEvent, false).subscribe(cancelDebouncedUserAcceptedAQuery),\n    )\n\n    onMounted(() => {\n      if (props.autofocus) {\n        focusInput()\n      }\n    })\n\n    return {\n      query,\n      inputElement,\n      emitUserHoveredInSearchBox,\n      emitUserHoveredOutSearchBox,\n      emitUserBlurredSearchBox,\n      emitUserClickedSearchBox,\n      emitUserFocusedSearchBox,\n      emitUserIsTypingAQueryEvents,\n      emitUserPressedEnterKey,\n      emitUserPressedArrowKey,\n      preventSpecialKey,\n    }\n  },\n})\n</script>\n\n<style lang=\"css\" scoped>\n.x-search-input::-webkit-search-decoration,\n.x-search-input::-webkit-search-cancel-button,\n.x-search-input::-webkit-search-results-button,\n.x-search-input::-webkit-search-results-decoration {\n  -webkit-appearance: none;\n}\n</style>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`UserClickedSearchBox`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserBlurredSearchBox`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserFocusedSearchBox`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserIsTypingAQuery`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserPressedEnterKey`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserPressedArrowKey`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserAcceptedAQuery`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n## See it in action\n\n<!-- prettier-ignore-start -->\n:::warning Backend service required\nTo use this component, the Search service must be implemented.\n:::\n<!-- prettier-ignore-end -->\n\nHere you have a basic example of how the search input is rendered.\n\n_Type any term in the input field to try it out!_\n\n```vue live\n<template>\n  <SearchInput />\n</template>\n\n<script>\nimport { SearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchInputDemo',\n  components: {\n    SearchInput,\n  },\n}\n</script>\n```\n\n### Play with props\n\nIn this example, the search input has been limited to accept a maximum of 5 characters, including\nspaces, it won't take the focus when it is rendered, and it will emit the `UserAcceptedAQuery` event\nafter 1000 milliseconds without typing.\n\n_Type a term with more than 5 characters to try it out!_\n\n```vue live\n<template>\n  <SearchInput :maxLength=\"5\" :autofocus=\"false\" :instant=\"true\" :instantDebounceInMs=\"1000\" />\n</template>\n\n<script>\nimport { SearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchInputDemo',\n  components: {\n    SearchInput,\n  },\n}\n</script>\n```\n\n### Play with events\n\nIn this example, a message has been added below the search input to illustrate the action performed.\nFor example, if you select the search input box, the message “focus” appears. When you start to\nenter a search term, the message “typing” appears. If you press Enter after typing a search term,\nthe message “enter” appears.\n\n<!-- prettier-ignore-start -->\n:::warning X Events are only emitted from the root X Component.\nAt the moment, X Events are only emitted from the root X Component. This means that if you wrap\nthe `SearchInput` with another component of another module like the `MainScroll`, you should add\nthe listeners to the `MainScroll` instead of the `SearchInput`. If you need to subscribe to these\nevents, it is recommended to use the [`GlobalXBus`](../common/x-components.global-x-bus.md)\ncomponent instead.\n:::\n<!-- prettier-ignore-end -->\n\n_Type any term in the input field to try it out!_\n\n```vue live\n<template>\n  <div>\n    <SearchInput\n      @UserPressedEnterKey=\"value = 'enter'\"\n      @UserFocusedSearchBox=\"hasFocus = true\"\n      @UserBlurredSearchBox=\"hasFocus = false\"\n      @UserIsTypingAQuery=\"value = 'typing'\"\n    />\n    <strong>{{ value }}</strong>\n    <span>{{ hasFocus ? 'focused' : 'unfocused' }}</span>\n  </div>\n</template>\n\n<script>\nimport { SearchInput } from '@empathyco/x-components/search-box'\n\nexport default {\n  name: 'SearchInputDemo',\n  components: {\n    SearchInput,\n  },\n  data() {\n    return {\n      value: '',\n      hasFocus: false,\n    }\n  },\n}\n</script>\n```\n\n## Extending the component\n\nComponents can be combined and communicate with each other. Commonly, the `SearchInput` component\ncommunicates with the [`SearchButton`](x-components.search-button.md) and the\n[`ClearSearchInput`](x-components.clear-search-input.md) to offer a full query entry experience.\nFurthermore, you can use it together with the [`QuerySuggestions`](query-suggestions.md) component\nto autocomplete the typed search term.\n\n_Type “trousers” or another fashion term in the input field and then click the clear icon to try it\nout!_\n\n```vue live\n<template>\n  <div>\n    <div style=\"display: flex; flex-flow: row nowrap;\">\n      <SearchInput />\n      <ClearSearchInput>\n        <img src=\"/assets/icons/cross.svg\" />\n      </ClearSearchInput>\n      <SearchButton>Search</SearchButton>\n    </div>\n    <QuerySuggestions />\n  </div>\n</template>\n\n<script>\nimport { SearchInput, ClearSearchInput, SearchButton } from '@empathyco/x-components/search-box'\nimport { QuerySuggestions } from '@empathyco/x-components/query-suggestions'\n\nexport default {\n  name: 'SearchInputDemo',\n  components: {\n    SearchInput,\n    ClearSearchInput,\n    SearchButton,\n    QuerySuggestions,\n  },\n}\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock"],"mappings":";;;;;;SAEQ,WAAc,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;AACjB,EAAA,OAAAA,SAAA,EAAoB,EAAAC,kBAAA,CAAA,OAAA,EAAA;AAAA,IACpB,GAAK,EAAA,cAAA;AAAA,IACN,SAAa,EAAA,IAAA,CAAA,SAAA;AAAA,IACb,KAAM,EAAA,IAAA,CAAA,KAAA;AAAA,IACN,YAAa,EAAA,KAAA;AAAA,IACb,KAAA,EAAA,wBAAA;AAAA,IACA,YAAa,EAAA,QAAA;AAAA,IACb,SAAS,EAAA,QAAA;AAAA,IACT,IAAA,EAAA,QAAA;AAAA,IACC,WAAU,EAAA,cAAA;AAAA,IACV,YAAU,EAAA,sBAAA;AAAA,IACV,YAAA,EAAI,uCAAE,IAAwB,CAAA,0BAAA,IAAA,IAAA,CAAA,0BAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAC9B,YAAA,EAAK,uCAAE,IAAwB,CAAA,2BAAA,IAAA,IAAA,CAAA,2BAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAC/B,QAAK,MAAE,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,wBAAA,IAAA,IAAA,CAAA,wBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IACP,SAAK,MAAE,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,wBAAA,IAAA,IAAA,CAAA,wBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IACP,OAAO,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,wBAAA,IAAA,IAAA,CAAA,wBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAAA,OAAA,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAlBZ,uBAkBoB,4BAAuB,IAAA,IAAA,CAAA,4BAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAAA,SAAA,EAAA;;AAEtC,MAAA,MAAA,CAAA,CAAA,CAAA,KAAW,uCAAE,IAAiB,KAAA,IAAA,CAAA,uBAAA,IAAA,IAAA,CAAA,uBAAA,CAAA,GAAA,IAAA,CAAA,EAAA,CAAA,SAAA,CAAA,CAAA,EAAA,CAAA,IAAA,EAAA,MAAA,CAAA,CAAA,CAAA;AAAA,KAAA;;;;;;;;"}

package/js/x-modules/search-box/components/search-input.vue2.js

@@ -1,7 +1,7 @@
 import { defineComponent, ref, onMounted } from 'vue';
-import { debounce } from '../../../utils/debounce.js';
 import { use$x } from '../../../composables/use-_x.js';
 import { useState } from '../../../composables/use-state.js';
+import { debounce } from '../../../utils/debounce.js';
 import { searchBoxXModule } from '../x-module.js';
 
 /**
@@ -19,33 +19,33 @@ var _sfc_main = defineComponent({
          */
         maxLength: {
             type: Number,
-            default: 64
+            default: 64,
         },
         /**
          * Allows input autofocus when the search field is rendered.
          */
         autofocus: {
             type: Boolean,
-            default: true
+            default: true,
         },
         /**
          * Enables the auto-accept query after debounce.
          */
         instant: {
             type: Boolean,
-            default: true
+            default: true,
         },
         /**
          * Debounce time for the instant.
          */
         instantDebounceInMs: {
             type: Number,
-            default: 500
-        }
+            default: 500,
+        },
     },
-    setup: function (props) {
+    setup(props) {
         const $x = use$x();
-        const { query } = useState('searchBox', ['query']);
+        const { query } = useState('searchBox');
         const inputElement = ref();
         let debouncedUserAcceptedAQuery;
         /**
@@ -57,7 +57,7 @@ var _sfc_main = defineComponent({
         const createEventMetadata = () => {
             return {
                 target: inputElement.value,
-                feature: 'search_box'
+                feature: 'search_box',
             };
         };
         /**
@@ -219,9 +219,9 @@ var _sfc_main = defineComponent({
             emitUserIsTypingAQueryEvents,
             emitUserPressedEnterKey,
             emitUserPressedArrowKey,
-            preventSpecialKey
+            preventSpecialKey,
         };
-    }
+    },
 });
 
 export { _sfc_main as default };