@empathyco/x-components 6.0.0-alpha.60 → 6.0.0-alpha.62

package/js/components/modals/base-events-modal.vue2.js

@@ -1,7 +1,7 @@
 import { defineComponent, ref } from 'vue';
-import { isElementEqualOrContained, getTargetElement } from '../../utils/html.js';
-import { AnimationProp } from '../../types/animation-prop.js';
 import { use$x } from '../../composables/use-_x.js';
+import { AnimationProp } from '../../types/animation-prop.js';
+import { isElementEqualOrContained, getTargetElement } from '../../utils/html.js';
 import BaseModal from './base-modal.vue.js';
 
 /**
@@ -18,26 +18,26 @@ import BaseModal from './base-modal.vue.js';
 var _sfc_main = defineComponent({
     name: 'BaseEventsModal',
     components: {
-        BaseModal
+        BaseModal,
     },
     props: {
         /** Array of {@link XEvent} to listen to open the modal. */
         eventsToOpenModal: {
             type: Array,
-            default: () => ['UserClickedOpenEventsModal']
+            default: () => ['UserClickedOpenEventsModal'],
         },
         /** Array of {@link XEvent} to listen to close the modal. */
         eventsToCloseModal: {
             type: Array,
-            default: () => ['UserClickedCloseEventsModal', 'UserClickedOutOfEventsModal']
+            default: () => ['UserClickedCloseEventsModal', 'UserClickedOutOfEventsModal'],
         },
         /** Event to emit when any part of the website out of the modal has been clicked. */
         bodyClickEvent: {
             type: String,
-            default: 'UserClickedOutOfEventsModal'
+            default: 'UserClickedOutOfEventsModal',
         },
         /** Animation to use for opening/closing the modal. */
-        animation: AnimationProp
+        animation: AnimationProp,
     },
     setup(props) {
         const $x = use$x();
@@ -81,9 +81,9 @@ var _sfc_main = defineComponent({
             isOpen,
             openerElement,
             baseModalEl,
-            emitBodyClickEvent
+            emitBodyClickEvent,
         };
-    }
+    },
 });
 
 export { _sfc_main as default };

package/js/components/modals/base-events-modal.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-events-modal.vue2.js","sources":["../../../../src/components/modals/base-events-modal.vue"],"sourcesContent":["<template>\n  <BaseModal\n    ref=\"baseModalEl\"\n    @click:overlay=\"emitBodyClickEvent\"\n    @focusin:body=\"emitBodyClickEvent\"\n    :animation=\"animation\"\n    :open=\"isOpen\"\n  >\n    <slot />\n  </BaseModal>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent, PropType, ref } from 'vue';\n  import { XEvent } from '../../wiring/events.types';\n  import { getTargetElement, isElementEqualOrContained } from '../../utils/html';\n  import { AnimationProp } from '../../types/animation-prop';\n  import { use$x } from '../../composables/use-$x';\n  import BaseModal from './base-modal.vue';\n\n  /**\n   * Component containing a modal that emits a {@link XEventsTypes.UserClickedCloseEventsModal} when\n   * clicking outside the content rendered in the default slot and can receive, through the\n   * eventsToCloseModal prop, a list of {@link XEvent} to listen to in order to close\n   * also the modal, eventsToOpenModal prop,  another list of {@link XEvent} to customize\n   * the events to listen to open the modal and a prop, displayOverlay, to display an\n   * overlay over the rest of the html. The default slot offers the possibility to customize the\n   * modal content.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseEventsModal',\n    components: {\n      BaseModal\n    },\n    props: {\n      /** Array of {@link XEvent} to listen to open the modal. */\n      eventsToOpenModal: {\n        type: Array as PropType<XEvent[]>,\n        default: (): XEvent[] => ['UserClickedOpenEventsModal']\n      },\n      /** Array of {@link XEvent} to listen to close the modal. */\n      eventsToCloseModal: {\n        type: Array as PropType<XEvent[]>,\n        default: (): XEvent[] => ['UserClickedCloseEventsModal', 'UserClickedOutOfEventsModal']\n      },\n      /** Event to emit when any part of the website out of the modal has been clicked. */\n      bodyClickEvent: {\n        type: String as PropType<XEvent>,\n        default: 'UserClickedOutOfEventsModal'\n      },\n      /** Animation to use for opening/closing the modal. */\n      animation: AnimationProp\n    },\n    setup(props) {\n      const $x = use$x();\n\n      /** Whether the modal is open or not. */\n      const isOpen = ref(false);\n\n      /** The element that opened the modal. */\n      const openerElement = ref<HTMLElement>();\n      const baseModalEl = ref<HTMLElement>();\n\n      /**\n       * Opens the modal.\n       *\n       * @param _payload - The payload of the event that opened the modal.\n       * @param metadata - The metadata of the event that opened the modal.\n       */\n      props.eventsToOpenModal?.forEach(event =>\n        $x.on(event, true).subscribe(({ metadata }) => {\n          if (!isOpen.value) {\n            openerElement.value = metadata.target;\n            isOpen.value = true;\n          }\n        })\n      );\n\n      /** Closes the modal. */\n      props.eventsToCloseModal?.forEach(event =>\n        $x.on(event, false).subscribe(() => {\n          if (isOpen.value) {\n            isOpen.value = false;\n          }\n        })\n      );\n\n      /**\n       * Emits the event defined in the {@link BaseEventsModal.bodyClickEvent} event unless the passed\n       * event target is the button that opened the modal.\n       *\n       * @param event - The event that triggered the close attempt.\n       */\n      const emitBodyClickEvent = (event: MouseEvent | FocusEvent) => {\n        // Prevents clicking the open button when the panel is already open to close the panel.\n        if (\n          !openerElement.value ||\n          !isElementEqualOrContained(openerElement.value, getTargetElement(event))\n        ) {\n          $x.emit(props.bodyClickEvent, undefined, { target: baseModalEl.value as HTMLElement });\n        }\n      };\n\n      return {\n        isOpen,\n        openerElement,\n        baseModalEl,\n        emitBodyClickEvent\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedCloseEventsModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after clicking outside the content rendered in the default slot.\n- [`UserClickedOutOfEventsModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after clicking outside the modal.\n- Custom events to open or close the modal.\n\n## Examples\n\nThe `BaseEventsModal` component handles the modal open/close state via the events passed via props.\nIts configured by default to work as a modal for a whole search application, but if the events are\nchanged, it can work as a modal that is opened/closed when the events it is listening are emitted.\n\n### Basic usage\n\nThe component interacts with the open and close components, which are preconfigured by default to\nemit the same events that the `BaseEventsModal` component is listening to:\n\n```vue\n<template>\n  <div>\n    <BaseEventsModalOpen>Open</BaseEventsModalOpen>\n    <BaseEventsModal>\n      <BaseEventsModalClose>Close</BaseEventsModalClose>\n      <img src=\"success.png\" />\n    </BaseEventsModal>\n  </div>\n</template>\n\n<script>\n  import { BaseEventsModalOpen, BaseEventsModal } from '@empathyco/x-components';\n\n  export default {\n    name: 'ModalTest',\n    components: {\n      BaseEventsModalOpen,\n      BaseEventsModal\n    }\n  };\n</script>\n```\n\n### Customizing the events\n\nIf needed, the events to open/close the modal can be changed. The modal can listen one or more\nevents. To do so, the `eventsToCloseModal` and `eventsToOpenModal` props can be used. Below you can\nsee a full example on how this would work with custom events.\n\n```vue\n<template>\n  <div>\n    <BaseEventsModalOpen openingEvent=\"UserClickedOpenMyCustomModal\">Open</BaseEventsModalOpen>\n    <BaseEventsModal\n      :eventsToCloseModal=\"eventsToCloseModal\"\n      :eventsToOpenModal=\"eventsToOpenModal\"\n    >\n      <BaseEventsModalClose closingEvent=\"UserClickedCloseMyCustomModalFromHeader\">\n        Close from header\n      </BaseEventsModalClose>\n      <img src=\"success.png\" />\n      <BaseEventsModalClose closingEvent=\"UserClickedCloseMyCustomModalFromFooter\">\n        Close from footer\n      </BaseEventsModalClose>\n    </BaseEventsModal>\n  </div>\n</template>\n\n<script>\n  import {\n    BaseEventsModalOpen,\n    BaseEventsModal,\n    BaseEventsModalClose\n  } from '@empathyco/x-components';\n\n  export default {\n    name: 'ModalTest',\n    components: {\n      BaseEventsModalOpen,\n      BaseEventsModal,\n      BaseEventsModalClose\n    }\n  };\n</script>\n```\n\n### Customizing the content with classes\n\nThe `contentClass` prop can be used to add classes to the modal content.\n\n```vue\n<template>\n  <div>\n    <BaseEventsModalOpen>Open</BaseEventsModalOpen>\n    <BaseEventsModal contentClass=\"x-bg-neutral-75\">\n      <BaseEventsModalClose>Close</BaseEventsModalClose>\n      <img src=\"success.png\" />\n    </BaseEventsModal>\n  </div>\n</template>\n\n<script>\n  import { BaseEventsModalOpen, BaseEventsModal } from '@empathyco/x-components';\n\n  export default {\n    name: 'ModalTest',\n    components: {\n      BaseEventsModalOpen,\n      BaseEventsModal\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;AAoBE;;;;;;;;;;AAUE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,UAAU,EAAE;QACV,SAAQ;AACT,KAAA;AACD,IAAA,KAAK,EAAE;;AAEL,QAAA,iBAAiB,EAAE;AACjB,YAAA,IAAI,EAAE,KAA2B;AACjC,YAAA,OAAO,EAAE,MAAgB,CAAC,4BAA4B,CAAA;AACvD,SAAA;;AAED,QAAA,kBAAkB,EAAE;AAClB,YAAA,IAAI,EAAE,KAA2B;YACjC,OAAO,EAAE,MAAgB,CAAC,6BAA6B,EAAE,6BAA6B,CAAA;AACvF,SAAA;;AAED,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,MAA0B;AAChC,YAAA,OAAO,EAAE,6BAA4B;AACtC,SAAA;;AAED,QAAA,SAAS,EAAE,aAAY;AACxB,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT,QAAA,MAAM,EAAC,GAAI,KAAK,EAAE,CAAA;;AAGlB,QAAA,MAAM,MAAK,GAAI,GAAG,CAAC,KAAK,CAAC,CAAA;;AAGzB,QAAA,MAAM,aAAY,GAAI,GAAG,EAAe,CAAA;AACxC,QAAA,MAAM,WAAY,GAAE,GAAG,EAAe,CAAA;AAEtC;;;;;AAKE;QACF,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,SAC/B,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,KAAK;AAC7C,YAAA,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;AACjB,gBAAA,aAAa,CAAC,KAAI,GAAI,QAAQ,CAAC,MAAM,CAAA;AACrC,gBAAA,MAAM,CAAC,KAAM,GAAE,IAAI,CAAA;AACrB,aAAA;SACD,CAAA,CACF,CAAA;;QAGD,KAAK,CAAC,kBAAkB,EAAE,OAAO,CAAC,SAChC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM;YAClC,IAAI,MAAM,CAAC,KAAK,EAAE;AAChB,gBAAA,MAAM,CAAC,QAAQ,KAAK,CAAA;AACtB,aAAA;SACD,CAAA,CACF,CAAA;AAED;;;;;AAKE;AACF,QAAA,MAAM,kBAAiB,GAAI,CAAC,KAA8B,KAAK;;YAE7D,IACE,CAAC,aAAa,CAAC;gBACf,CAAC,yBAAyB,CAAC,aAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAA,EACvE;AACA,gBAAA,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,KAAmB,EAAG,CAAC,CAAA;AACxF,aAAA;AACF,SAAC,CAAA;QAED,OAAO;YACL,MAAM;YACN,aAAa;YACb,WAAW;YACX,kBAAiB;SAClB,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"base-events-modal.vue2.js","sources":["../../../../src/components/modals/base-events-modal.vue"],"sourcesContent":["<template>\n  <BaseModal\n    ref=\"baseModalEl\"\n    :animation=\"animation\"\n    :open=\"isOpen\"\n    @click:overlay=\"emitBodyClickEvent\"\n    @focusin:body=\"emitBodyClickEvent\"\n  >\n    <slot />\n  </BaseModal>\n</template>\n\n<script lang=\"ts\">\nimport type { PropType } from 'vue'\nimport type { XEvent } from '../../wiring/events.types'\nimport { defineComponent, ref } from 'vue'\nimport { use$x } from '../../composables/use-$x'\nimport { AnimationProp } from '../../types/animation-prop'\nimport { getTargetElement, isElementEqualOrContained } from '../../utils/html'\nimport BaseModal from './base-modal.vue'\n\n/**\n * Component containing a modal that emits a {@link XEventsTypes.UserClickedCloseEventsModal} when\n * clicking outside the content rendered in the default slot and can receive, through the\n * eventsToCloseModal prop, a list of {@link XEvent} to listen to in order to close\n * also the modal, eventsToOpenModal prop,  another list of {@link XEvent} to customize\n * the events to listen to open the modal and a prop, displayOverlay, to display an\n * overlay over the rest of the html. The default slot offers the possibility to customize the\n * modal content.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseEventsModal',\n  components: {\n    BaseModal,\n  },\n  props: {\n    /** Array of {@link XEvent} to listen to open the modal. */\n    eventsToOpenModal: {\n      type: Array as PropType<XEvent[]>,\n      default: (): XEvent[] => ['UserClickedOpenEventsModal'],\n    },\n    /** Array of {@link XEvent} to listen to close the modal. */\n    eventsToCloseModal: {\n      type: Array as PropType<XEvent[]>,\n      default: (): XEvent[] => ['UserClickedCloseEventsModal', 'UserClickedOutOfEventsModal'],\n    },\n    /** Event to emit when any part of the website out of the modal has been clicked. */\n    bodyClickEvent: {\n      type: String as PropType<XEvent>,\n      default: 'UserClickedOutOfEventsModal',\n    },\n    /** Animation to use for opening/closing the modal. */\n    animation: AnimationProp,\n  },\n  setup(props) {\n    const $x = use$x()\n\n    /** Whether the modal is open or not. */\n    const isOpen = ref(false)\n\n    /** The element that opened the modal. */\n    const openerElement = ref<HTMLElement>()\n    const baseModalEl = ref<HTMLElement>()\n\n    /**\n     * Opens the modal.\n     *\n     * @param _payload - The payload of the event that opened the modal.\n     * @param metadata - The metadata of the event that opened the modal.\n     */\n    props.eventsToOpenModal?.forEach(event =>\n      $x.on(event, true).subscribe(({ metadata }) => {\n        if (!isOpen.value) {\n          openerElement.value = metadata.target\n          isOpen.value = true\n        }\n      }),\n    )\n\n    /** Closes the modal. */\n    props.eventsToCloseModal?.forEach(event =>\n      $x.on(event, false).subscribe(() => {\n        if (isOpen.value) {\n          isOpen.value = false\n        }\n      }),\n    )\n\n    /**\n     * Emits the event defined in the {@link BaseEventsModal.bodyClickEvent} event unless the passed\n     * event target is the button that opened the modal.\n     *\n     * @param event - The event that triggered the close attempt.\n     */\n    const emitBodyClickEvent = (event: MouseEvent | FocusEvent) => {\n      // Prevents clicking the open button when the panel is already open to close the panel.\n      if (\n        !openerElement.value ||\n        !isElementEqualOrContained(openerElement.value, getTargetElement(event))\n      ) {\n        $x.emit(props.bodyClickEvent, undefined, { target: baseModalEl.value as HTMLElement })\n      }\n    }\n\n    return {\n      isOpen,\n      openerElement,\n      baseModalEl,\n      emitBodyClickEvent,\n    }\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedCloseEventsModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after clicking outside the content rendered in the default slot.\n- [`UserClickedOutOfEventsModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after clicking outside the modal.\n- Custom events to open or close the modal.\n\n## Examples\n\nThe `BaseEventsModal` component handles the modal open/close state via the events passed via props.\nIts configured by default to work as a modal for a whole search application, but if the events are\nchanged, it can work as a modal that is opened/closed when the events it is listening are emitted.\n\n### Basic usage\n\nThe component interacts with the open and close components, which are preconfigured by default to\nemit the same events that the `BaseEventsModal` component is listening to:\n\n```vue\n<template>\n  <div>\n    <BaseEventsModalOpen>Open</BaseEventsModalOpen>\n    <BaseEventsModal>\n      <BaseEventsModalClose>Close</BaseEventsModalClose>\n      <img src=\"success.png\" />\n    </BaseEventsModal>\n  </div>\n</template>\n\n<script>\nimport { BaseEventsModalOpen, BaseEventsModal } from '@empathyco/x-components'\n\nexport default {\n  name: 'ModalTest',\n  components: {\n    BaseEventsModalOpen,\n    BaseEventsModal,\n  },\n}\n</script>\n```\n\n### Customizing the events\n\nIf needed, the events to open/close the modal can be changed. The modal can listen one or more\nevents. To do so, the `eventsToCloseModal` and `eventsToOpenModal` props can be used. Below you can\nsee a full example on how this would work with custom events.\n\n```vue\n<template>\n  <div>\n    <BaseEventsModalOpen openingEvent=\"UserClickedOpenMyCustomModal\">Open</BaseEventsModalOpen>\n    <BaseEventsModal\n      :eventsToCloseModal=\"eventsToCloseModal\"\n      :eventsToOpenModal=\"eventsToOpenModal\"\n    >\n      <BaseEventsModalClose closingEvent=\"UserClickedCloseMyCustomModalFromHeader\">\n        Close from header\n      </BaseEventsModalClose>\n      <img src=\"success.png\" />\n      <BaseEventsModalClose closingEvent=\"UserClickedCloseMyCustomModalFromFooter\">\n        Close from footer\n      </BaseEventsModalClose>\n    </BaseEventsModal>\n  </div>\n</template>\n\n<script>\nimport { BaseEventsModalOpen, BaseEventsModal, BaseEventsModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'ModalTest',\n  components: {\n    BaseEventsModalOpen,\n    BaseEventsModal,\n    BaseEventsModalClose,\n  },\n}\n</script>\n```\n\n### Customizing the content with classes\n\nThe `contentClass` prop can be used to add classes to the modal content.\n\n```vue\n<template>\n  <div>\n    <BaseEventsModalOpen>Open</BaseEventsModalOpen>\n    <BaseEventsModal contentClass=\"x-bg-neutral-75\">\n      <BaseEventsModalClose>Close</BaseEventsModalClose>\n      <img src=\"success.png\" />\n    </BaseEventsModal>\n  </div>\n</template>\n\n<script>\nimport { BaseEventsModalOpen, BaseEventsModal } from '@empathyco/x-components'\n\nexport default {\n  name: 'ModalTest',\n  components: {\n    BaseEventsModalOpen,\n    BaseEventsModal,\n  },\n}\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;AAqBA;;;;;;;;;;AAUE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,UAAU,EAAE;QACV,SAAS;AACV,KAAA;AACD,IAAA,KAAK,EAAE;;AAEL,QAAA,iBAAiB,EAAE;AACjB,YAAA,IAAI,EAAE,KAA2B;AACjC,YAAA,OAAO,EAAE,MAAgB,CAAC,4BAA4B,CAAC;AACxD,SAAA;;AAED,QAAA,kBAAkB,EAAE;AAClB,YAAA,IAAI,EAAE,KAA2B;YACjC,OAAO,EAAE,MAAgB,CAAC,6BAA6B,EAAE,6BAA6B,CAAC;AACxF,SAAA;;AAED,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,MAA0B;AAChC,YAAA,OAAO,EAAE,6BAA6B;AACvC,SAAA;;AAED,QAAA,SAAS,EAAE,aAAa;AACzB,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT,QAAA,MAAM,EAAC,GAAI,KAAK,EAAC,CAAA;;AAGjB,QAAA,MAAM,SAAS,GAAG,CAAC,KAAK,CAAA,CAAA;;AAGxB,QAAA,MAAM,aAAY,GAAI,GAAG,EAAc,CAAA;AACvC,QAAA,MAAM,WAAY,GAAE,GAAG,EAAc,CAAA;AAErC;;;;;AAKE;QACF,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,SAC/B,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,KAAK;AAC7C,YAAA,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;AACjB,gBAAA,aAAa,CAAC,KAAI,GAAI,QAAQ,CAAC,MAAK,CAAA;AACpC,gBAAA,MAAM,CAAC,KAAI,GAAI,IAAG,CAAA;AACpB,aAAA;SACD,CAAC,CACJ,CAAA;;QAGA,KAAK,CAAC,kBAAkB,EAAE,OAAO,CAAC,SAChC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM;YAClC,IAAI,MAAM,CAAC,KAAK,EAAE;AAChB,gBAAA,MAAM,CAAC,KAAM,GAAE,KAAI,CAAA;AACrB,aAAA;SACD,CAAC,CACJ,CAAA;AAEA;;;;;AAKE;AACF,QAAA,MAAM,kBAAiB,GAAI,CAAC,KAA8B,KAAK;;YAE7D,IACE,CAAC,aAAa,CAAC;gBACf,CAAC,yBAAyB,CAAC,aAAa,CAAC,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAA,EACvE;AACA,gBAAA,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,OAAsB,CAAA,CAAA;AACvF,aAAA;AACF,SAAA,CAAA;QAEA,OAAO;YACL,MAAM;YACN,aAAa;YACb,WAAW;YACX,kBAAkB;SACpB,CAAA;KACD;AACF,CAAA,CAAA;;;;"}

package/js/components/modals/base-id-modal-close.vue.js

@@ -4,9 +4,9 @@ import _export_sfc from '../../_virtual/_plugin-vue_export-helper.js';
 
 function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
   return openBlock(), createElementBlock("button", {
-    onClick: _cache[0] || (_cache[0] = (...args) => _ctx.closeModal && _ctx.closeModal(...args)),
     class: "x-events-modal-id-close-button x-button",
-    "data-test": "close-modal-id"
+    "data-test": "close-modal-id",
+    onClick: _cache[0] || (_cache[0] = (...args) => _ctx.closeModal && _ctx.closeModal(...args))
   }, [
     renderSlot(_ctx.$slots, "default")
   ]);

package/js/components/modals/base-id-modal-close.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-id-modal-close.vue.js","sources":["../../../../src/components/modals/base-id-modal-close.vue"],"sourcesContent":["<template>\n  <button\n    @click=\"closeModal\"\n    class=\"x-events-modal-id-close-button x-button\"\n    data-test=\"close-modal-id\"\n  >\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent } from 'vue';\n  import { use$x } from '../../composables';\n\n  /**\n   * Component that allows to close a modal by emitting\n   * {@link XEventsTypes.UserClickedCloseModal}.\n   * It allows full customization with the 'closing-element' slot and exposes the 'closeModal'\n   * function.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseIdModalClose',\n    props: {\n      /** The modalId of the modal that will be closed. */\n      modalId: {\n        type: String,\n        required: true\n      }\n    },\n    setup(props, { slots }) {\n      const $x = use$x();\n\n      /**\n       * Emits the {@link XEventsTypes.UserClickedCloseModal} event with the modalId as payload.\n       *\n       * @param event - The event triggering the function.\n       */\n      function closeModal({ target }: Event) {\n        $x.emit('UserClickedCloseModal', props.modalId, { target: target as HTMLElement });\n      }\n\n      /* Hack to render through a render-function, the `closing-element` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n      const innerProps = { closeModal };\n      return (\n        slots['closing-element'] ? () => slots['closing-element']?.(innerProps)[0] : innerProps\n      ) as typeof innerProps;\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedCloseModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks the button. The event payload is the id of the modal\n  that is going to be closed.\n\n## Examples\n\nComponent containing an event button that emits `UserClickedCloseModal` when clicked with the\nmodalId as payload. It has a default slot to customize its contents and can also be fully\ncustomized, replacing the default button with any other element.\n\n### Basic example\n\nThe component renders whatever is passed to it in the default slot inside the button and closes the\nmodal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalClose modalId=\"my-modal\">\n    <img src=\"./close-button-icon.svg\" />\n  </BaseIdModalClose>\n</template>\n\n<script>\n  import { BaseIdModalClose } from '@empathyco/x-components';\n\n  export default {\n    name: 'BaseIdModalCloseTest',\n    components: {\n      BaseIdModalClose\n    }\n  };\n</script>\n```\n\n### Replacing the default button\n\nThe component renders whatever element is passed, replacing the default button and exposing the\nfunction to close the modal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalClose modalId=\"my-modal\">\n    <template #closing-element=\"{ closeModal }\">\n      <ul>\n        <li @click=\"closeModal\">Close here</li>\n        <li>Not here</li>\n      </ul>\n    </template>\n  </BaseIdModalClose>\n</template>\n\n<script>\n  import { BaseIdModalClose } from '@empathyco/x-components';\n\n  export default {\n    name: 'BaseIdModalCloseTest',\n    components: {\n      BaseIdModalClose\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock"],"mappings":";;;;AAEK,SAAA,WAAA,CAAK,IAAE,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;AACH,EAAA,OAAAA,SAAA,EAA0C,EAAAC,kBAAA,CAAA,QAAA,EAAA;AAAA,IAC/C,gBAAU,CAAgB,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,UAAA,IAAA,IAAA,CAAA,UAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAAA,KAAA,EAAA,yCAAA;IAG1B,WAAQ,EAAA,gBAAA;AAAA,GAAA,EAAA;;;;;;;;"}
+{"version":3,"file":"base-id-modal-close.vue.js","sources":["../../../../src/components/modals/base-id-modal-close.vue"],"sourcesContent":["<template>\n  <button\n    class=\"x-events-modal-id-close-button x-button\"\n    data-test=\"close-modal-id\"\n    @click=\"closeModal\"\n  >\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\nimport { defineComponent } from 'vue'\nimport { use$x } from '../../composables'\n\n/**\n * Component that allows to close a modal by emitting\n * {@link XEventsTypes.UserClickedCloseModal}.\n * It allows full customization with the 'closing-element' slot and exposes the 'closeModal'\n * function.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseIdModalClose',\n  props: {\n    /** The modalId of the modal that will be closed. */\n    modalId: {\n      type: String,\n      required: true,\n    },\n  },\n  setup(props, { slots }) {\n    const $x = use$x()\n\n    /**\n     * Emits the {@link XEventsTypes.UserClickedCloseModal} event with the modalId as payload.\n     *\n     * @param event - The event triggering the function.\n     * @param event.target - Event target.\n     */\n    function closeModal({ target }: Event) {\n      $x.emit('UserClickedCloseModal', props.modalId, { target: target as HTMLElement })\n    }\n\n    /* Hack to render through a render-function, the `closing-element` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n    const innerProps = { closeModal }\n    return (\n      slots['closing-element'] ? () => slots['closing-element']?.(innerProps)[0] : innerProps\n    ) as typeof innerProps\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedCloseModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks the button. The event payload is the id of the modal\n  that is going to be closed.\n\n## Examples\n\nComponent containing an event button that emits `UserClickedCloseModal` when clicked with the\nmodalId as payload. It has a default slot to customize its contents and can also be fully\ncustomized, replacing the default button with any other element.\n\n### Basic example\n\nThe component renders whatever is passed to it in the default slot inside the button and closes the\nmodal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalClose modalId=\"my-modal\">\n    <img src=\"./close-button-icon.svg\" />\n  </BaseIdModalClose>\n</template>\n\n<script>\nimport { BaseIdModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'BaseIdModalCloseTest',\n  components: {\n    BaseIdModalClose,\n  },\n}\n</script>\n```\n\n### Replacing the default button\n\nThe component renders whatever element is passed, replacing the default button and exposing the\nfunction to close the modal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalClose modalId=\"my-modal\">\n    <template #closing-element=\"{ closeModal }\">\n      <ul>\n        <li @click=\"closeModal\">Close here</li>\n        <li>Not here</li>\n      </ul>\n    </template>\n  </BaseIdModalClose>\n</template>\n\n<script>\nimport { BaseIdModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'BaseIdModalCloseTest',\n  components: {\n    BaseIdModalClose,\n  },\n}\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock"],"mappings":";;;;AAES,SAAA,WAAA,CAAC,IAAyC,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;AAC/C,EAAA,OAAAA,SAAA,EAA0B,EAAAC,kBAAA,CAAA,QAAA,EAAA;AAAA,IACzB,KAAK,EAAA,yCAAA;AAAA,IAAA,WAAA,EAAA,gBAAA;IAGN,OAAQ,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,GAAA,EAAA;;;;;;;;"}

package/js/components/modals/base-id-modal-close.vue2.js

@@ -26,8 +26,8 @@ var _sfc_main = defineComponent({
         /** The modalId of the modal that will be closed. */
         modalId: {
             type: String,
-            required: true
-        }
+            required: true,
+        },
     },
     setup(props, { slots }) {
         const $x = use$x();
@@ -35,15 +35,16 @@ var _sfc_main = defineComponent({
          * Emits the {@link XEventsTypes.UserClickedCloseModal} event with the modalId as payload.
          *
          * @param event - The event triggering the function.
+         * @param event.target - Event target.
          */
         function closeModal({ target }) {
             $x.emit('UserClickedCloseModal', props.modalId, { target: target });
         }
         /* Hack to render through a render-function, the `closing-element` slot or, in its absence,
-         the component itself. It is the alternative for the NoElement antipattern. */
+           the component itself. It is the alternative for the NoElement antipattern. */
         const innerProps = { closeModal };
         return (slots['closing-element'] ? () => slots['closing-element']?.(innerProps)[0] : innerProps);
-    }
+    },
 });
 
 export { _sfc_main as default };

package/js/components/modals/base-id-modal-close.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-id-modal-close.vue2.js","sources":["../../../../src/components/modals/base-id-modal-close.vue"],"sourcesContent":["<template>\n  <button\n    @click=\"closeModal\"\n    class=\"x-events-modal-id-close-button x-button\"\n    data-test=\"close-modal-id\"\n  >\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent } from 'vue';\n  import { use$x } from '../../composables';\n\n  /**\n   * Component that allows to close a modal by emitting\n   * {@link XEventsTypes.UserClickedCloseModal}.\n   * It allows full customization with the 'closing-element' slot and exposes the 'closeModal'\n   * function.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseIdModalClose',\n    props: {\n      /** The modalId of the modal that will be closed. */\n      modalId: {\n        type: String,\n        required: true\n      }\n    },\n    setup(props, { slots }) {\n      const $x = use$x();\n\n      /**\n       * Emits the {@link XEventsTypes.UserClickedCloseModal} event with the modalId as payload.\n       *\n       * @param event - The event triggering the function.\n       */\n      function closeModal({ target }: Event) {\n        $x.emit('UserClickedCloseModal', props.modalId, { target: target as HTMLElement });\n      }\n\n      /* Hack to render through a render-function, the `closing-element` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n      const innerProps = { closeModal };\n      return (\n        slots['closing-element'] ? () => slots['closing-element']?.(innerProps)[0] : innerProps\n      ) as typeof innerProps;\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedCloseModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks the button. The event payload is the id of the modal\n  that is going to be closed.\n\n## Examples\n\nComponent containing an event button that emits `UserClickedCloseModal` when clicked with the\nmodalId as payload. It has a default slot to customize its contents and can also be fully\ncustomized, replacing the default button with any other element.\n\n### Basic example\n\nThe component renders whatever is passed to it in the default slot inside the button and closes the\nmodal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalClose modalId=\"my-modal\">\n    <img src=\"./close-button-icon.svg\" />\n  </BaseIdModalClose>\n</template>\n\n<script>\n  import { BaseIdModalClose } from '@empathyco/x-components';\n\n  export default {\n    name: 'BaseIdModalCloseTest',\n    components: {\n      BaseIdModalClose\n    }\n  };\n</script>\n```\n\n### Replacing the default button\n\nThe component renders whatever element is passed, replacing the default button and exposing the\nfunction to close the modal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalClose modalId=\"my-modal\">\n    <template #closing-element=\"{ closeModal }\">\n      <ul>\n        <li @click=\"closeModal\">Close here</li>\n        <li>Not here</li>\n      </ul>\n    </template>\n  </BaseIdModalClose>\n</template>\n\n<script>\n  import { BaseIdModalClose } from '@empathyco/x-components';\n\n  export default {\n    name: 'BaseIdModalCloseTest',\n    components: {\n      BaseIdModalClose\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;;;;;;;;AAeE;;;;;;;AAOE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,kBAAkB;AACxB,IAAA,KAAK,EAAE;;AAEL,QAAA,OAAO,EAAE;AACP,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,QAAQ,EAAE,IAAG;AACf,SAAA;AACD,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,KAAI,EAAG,EAAA;AACpB,QAAA,MAAM,EAAC,GAAI,KAAK,EAAE,CAAA;AAElB;;;;AAIE;AACF,QAAA,SAAS,UAAU,CAAC,EAAE,MAAK,EAAU,EAAA;AACnC,YAAA,EAAE,CAAC,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,MAAoB,EAAG,CAAC,CAAA;SACpF;AAEA;AAC6E;AAC7E,QAAA,MAAM,aAAa,EAAE,UAAS,EAAG,CAAA;QACjC,QACE,KAAK,CAAC,iBAAiB,CAAA,GAAI,MAAM,KAAK,CAAC,iBAAiB,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA,GAAI,UAAS,EAClE;KACxB;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"base-id-modal-close.vue2.js","sources":["../../../../src/components/modals/base-id-modal-close.vue"],"sourcesContent":["<template>\n  <button\n    class=\"x-events-modal-id-close-button x-button\"\n    data-test=\"close-modal-id\"\n    @click=\"closeModal\"\n  >\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\nimport { defineComponent } from 'vue'\nimport { use$x } from '../../composables'\n\n/**\n * Component that allows to close a modal by emitting\n * {@link XEventsTypes.UserClickedCloseModal}.\n * It allows full customization with the 'closing-element' slot and exposes the 'closeModal'\n * function.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseIdModalClose',\n  props: {\n    /** The modalId of the modal that will be closed. */\n    modalId: {\n      type: String,\n      required: true,\n    },\n  },\n  setup(props, { slots }) {\n    const $x = use$x()\n\n    /**\n     * Emits the {@link XEventsTypes.UserClickedCloseModal} event with the modalId as payload.\n     *\n     * @param event - The event triggering the function.\n     * @param event.target - Event target.\n     */\n    function closeModal({ target }: Event) {\n      $x.emit('UserClickedCloseModal', props.modalId, { target: target as HTMLElement })\n    }\n\n    /* Hack to render through a render-function, the `closing-element` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n    const innerProps = { closeModal }\n    return (\n      slots['closing-element'] ? () => slots['closing-element']?.(innerProps)[0] : innerProps\n    ) as typeof innerProps\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedCloseModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks the button. The event payload is the id of the modal\n  that is going to be closed.\n\n## Examples\n\nComponent containing an event button that emits `UserClickedCloseModal` when clicked with the\nmodalId as payload. It has a default slot to customize its contents and can also be fully\ncustomized, replacing the default button with any other element.\n\n### Basic example\n\nThe component renders whatever is passed to it in the default slot inside the button and closes the\nmodal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalClose modalId=\"my-modal\">\n    <img src=\"./close-button-icon.svg\" />\n  </BaseIdModalClose>\n</template>\n\n<script>\nimport { BaseIdModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'BaseIdModalCloseTest',\n  components: {\n    BaseIdModalClose,\n  },\n}\n</script>\n```\n\n### Replacing the default button\n\nThe component renders whatever element is passed, replacing the default button and exposing the\nfunction to close the modal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalClose modalId=\"my-modal\">\n    <template #closing-element=\"{ closeModal }\">\n      <ul>\n        <li @click=\"closeModal\">Close here</li>\n        <li>Not here</li>\n      </ul>\n    </template>\n  </BaseIdModalClose>\n</template>\n\n<script>\nimport { BaseIdModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'BaseIdModalCloseTest',\n  components: {\n    BaseIdModalClose,\n  },\n}\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;;;;;;;;AAeA;;;;;;;AAOE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,kBAAkB;AACxB,IAAA,KAAK,EAAE;;AAEL,QAAA,OAAO,EAAE;AACP,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;AACF,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,KAAI,EAAG,EAAA;AACpB,QAAA,MAAM,EAAC,GAAI,KAAK,EAAC,CAAA;AAEjB;;;;;AAKE;AACF,QAAA,SAAS,UAAU,CAAC,EAAE,MAAK,EAAU,EAAA;AACnC,YAAA,EAAE,CAAC,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,QAAuB,CAAA,CAAA;SACnF;AAEA;AAC+E;AAC/E,QAAA,MAAM,UAAW,GAAE,EAAE,UAAW,EAAA,CAAA;QAChC,QACE,KAAK,CAAC,iBAAiB,CAAA,GAAI,MAAM,KAAK,CAAC,iBAAiB,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA,GAAI,UAAS,EACnE;KACtB;AACF,CAAA,CAAA;;;;"}

package/js/components/modals/base-id-modal-open.vue.js

@@ -4,9 +4,9 @@ import _export_sfc from '../../_virtual/_plugin-vue_export-helper.js';
 
 function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
   return openBlock(), createElementBlock("button", {
-    onClick: _cache[0] || (_cache[0] = (...args) => _ctx.openModal && _ctx.openModal(...args)),
     class: "x-events-modal-id-open-button x-button",
-    "data-test": "open-modal-id"
+    "data-test": "open-modal-id",
+    onClick: _cache[0] || (_cache[0] = (...args) => _ctx.openModal && _ctx.openModal(...args))
   }, [
     renderSlot(_ctx.$slots, "default")
   ]);

package/js/components/modals/base-id-modal-open.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-id-modal-open.vue.js","sources":["../../../../src/components/modals/base-id-modal-open.vue"],"sourcesContent":["<template>\n  <button\n    @click=\"openModal\"\n    class=\"x-events-modal-id-open-button x-button\"\n    data-test=\"open-modal-id\"\n  >\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent } from 'vue';\n  import { use$x } from '../../composables';\n\n  /**\n   * Component that allows to open a modal by emitting {@link XEventsTypes.UserClickedOpenModal}\n   * with the modalId as payload. It allows full customization with the 'opening-element' slot and\n   * exposes the 'openModal' function.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseIdModalOpen',\n    props: {\n      /** The modalId of the modal that will be opened. */\n      modalId: {\n        type: String,\n        required: true\n      }\n    },\n    setup(props, { slots }) {\n      const $x = use$x();\n\n      /**\n       * Emits the {@link XEventsTypes.UserClickedOpenModal} event with the modalId as payload.\n       *\n       * @param event - The event triggering the function.\n       */\n      function openModal({ target }: Event) {\n        $x.emit('UserClickedOpenModal', props.modalId, { target: target as HTMLElement });\n      }\n\n      /* Hack to render through a render-function, the `opening-element` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n      const innerProps = { openModal };\n      return (\n        slots['opening-element'] ? () => slots['opening-element']?.(innerProps)[0] : innerProps\n      ) as typeof innerProps;\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedOpenModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks the button. The event payload is the id of the modal\n  that is going to be opened.\n\n## Examples\n\nComponent containing an event button that emits `UserClickedOpenModal` when it is clicked with the\nmodalId as payload. It has a default slot to customize its contents and can also be fully\ncustomized, replacing the default button with any other element.\n\n### Basic example\n\nThe component rendering content passed to the default slot inside the button and opening the modal\nwith modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalOpen modalId=\"my-modal\">\n    <img src=\"./open-button-icon.svg\" />\n    <span>Open</span>\n  </BaseIdModalOpen>\n</template>\n\n<script>\n  import { BaseIdModalOpen } from '@empathyco/x-components';\n\n  export default {\n    name: 'BaseIdModalOpenTest',\n    components: {\n      BaseIdModalOpen\n    }\n  };\n</script>\n```\n\n### Replacing the default button\n\nThe component renders whatever element is passed, replacing the default button and exposing the\nfunction to open the modal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalOpen modalId=\"my-modal\">\n    <template #opening-element=\"{ openModal }\">\n      <ul>\n        <li @click=\"openModal\">Open here</li>\n        <li>Not here</li>\n      </ul>\n    </template>\n  </BaseIdModalOpen>\n</template>\n\n<script>\n  import { BaseIdModalOpen } from '@empathyco/x-components';\n\n  export default {\n    name: 'BaseIdModalOpenTest',\n    components: {\n      BaseIdModalOpen\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock"],"mappings":";;;;AAEK,SAAA,WAAA,CAAK,IAAE,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;AACH,EAAA,OAAAA,SAAA,EAAyC,EAAAC,kBAAA,CAAA,QAAA,EAAA;AAAA,IAC9C,gBAAU,CAAe,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,SAAA,IAAA,IAAA,CAAA,SAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,IAAA,KAAA,EAAA,wCAAA;IAGzB,WAAQ,EAAA,eAAA;AAAA,GAAA,EAAA;;;;;;;;"}
+{"version":3,"file":"base-id-modal-open.vue.js","sources":["../../../../src/components/modals/base-id-modal-open.vue"],"sourcesContent":["<template>\n  <button\n    class=\"x-events-modal-id-open-button x-button\"\n    data-test=\"open-modal-id\"\n    @click=\"openModal\"\n  >\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\nimport { defineComponent } from 'vue'\nimport { use$x } from '../../composables'\n\n/**\n * Component that allows to open a modal by emitting {@link XEventsTypes.UserClickedOpenModal}\n * with the modalId as payload. It allows full customization with the 'opening-element' slot and\n * exposes the 'openModal' function.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseIdModalOpen',\n  props: {\n    /** The modalId of the modal that will be opened. */\n    modalId: {\n      type: String,\n      required: true,\n    },\n  },\n  setup(props, { slots }) {\n    const $x = use$x()\n\n    /**\n     * Emits the {@link XEventsTypes.UserClickedOpenModal} event with the modalId as payload.\n     *\n     * @param event - The event triggering the function.\n     * @param event.target - Event target.\n     */\n    function openModal({ target }: Event) {\n      $x.emit('UserClickedOpenModal', props.modalId, { target: target as HTMLElement })\n    }\n\n    /* Hack to render through a render-function, the `opening-element` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n    const innerProps = { openModal }\n    return (\n      slots['opening-element'] ? () => slots['opening-element']?.(innerProps)[0] : innerProps\n    ) as typeof innerProps\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedOpenModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks the button. The event payload is the id of the modal\n  that is going to be opened.\n\n## Examples\n\nComponent containing an event button that emits `UserClickedOpenModal` when it is clicked with the\nmodalId as payload. It has a default slot to customize its contents and can also be fully\ncustomized, replacing the default button with any other element.\n\n### Basic example\n\nThe component rendering content passed to the default slot inside the button and opening the modal\nwith modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalOpen modalId=\"my-modal\">\n    <img src=\"./open-button-icon.svg\" />\n    <span>Open</span>\n  </BaseIdModalOpen>\n</template>\n\n<script>\nimport { BaseIdModalOpen } from '@empathyco/x-components'\n\nexport default {\n  name: 'BaseIdModalOpenTest',\n  components: {\n    BaseIdModalOpen,\n  },\n}\n</script>\n```\n\n### Replacing the default button\n\nThe component renders whatever element is passed, replacing the default button and exposing the\nfunction to open the modal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalOpen modalId=\"my-modal\">\n    <template #opening-element=\"{ openModal }\">\n      <ul>\n        <li @click=\"openModal\">Open here</li>\n        <li>Not here</li>\n      </ul>\n    </template>\n  </BaseIdModalOpen>\n</template>\n\n<script>\nimport { BaseIdModalOpen } from '@empathyco/x-components'\n\nexport default {\n  name: 'BaseIdModalOpenTest',\n  components: {\n    BaseIdModalOpen,\n  },\n}\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock"],"mappings":";;;;AAES,SAAA,WAAA,CAAC,IAAwC,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAAA,QAAA,EAAA;AAC9C,EAAA,OAAAA,SAAA,EAAyB,EAAAC,kBAAA,CAAA,QAAA,EAAA;AAAA,IACxB,KAAK,EAAA,wCAAA;AAAA,IAAA,WAAA,EAAA,eAAA;IAGN,OAAQ,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,SAAA,IAAA,IAAA,CAAA,SAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,GAAA,EAAA;;;;;;;;"}

package/js/components/modals/base-id-modal-open.vue2.js

@@ -25,8 +25,8 @@ var _sfc_main = defineComponent({
         /** The modalId of the modal that will be opened. */
         modalId: {
             type: String,
-            required: true
-        }
+            required: true,
+        },
     },
     setup(props, { slots }) {
         const $x = use$x();
@@ -34,15 +34,16 @@ var _sfc_main = defineComponent({
          * Emits the {@link XEventsTypes.UserClickedOpenModal} event with the modalId as payload.
          *
          * @param event - The event triggering the function.
+         * @param event.target - Event target.
          */
         function openModal({ target }) {
             $x.emit('UserClickedOpenModal', props.modalId, { target: target });
         }
         /* Hack to render through a render-function, the `opening-element` slot or, in its absence,
-         the component itself. It is the alternative for the NoElement antipattern. */
+           the component itself. It is the alternative for the NoElement antipattern. */
         const innerProps = { openModal };
         return (slots['opening-element'] ? () => slots['opening-element']?.(innerProps)[0] : innerProps);
-    }
+    },
 });
 
 export { _sfc_main as default };

package/js/components/modals/base-id-modal-open.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-id-modal-open.vue2.js","sources":["../../../../src/components/modals/base-id-modal-open.vue"],"sourcesContent":["<template>\n  <button\n    @click=\"openModal\"\n    class=\"x-events-modal-id-open-button x-button\"\n    data-test=\"open-modal-id\"\n  >\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent } from 'vue';\n  import { use$x } from '../../composables';\n\n  /**\n   * Component that allows to open a modal by emitting {@link XEventsTypes.UserClickedOpenModal}\n   * with the modalId as payload. It allows full customization with the 'opening-element' slot and\n   * exposes the 'openModal' function.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseIdModalOpen',\n    props: {\n      /** The modalId of the modal that will be opened. */\n      modalId: {\n        type: String,\n        required: true\n      }\n    },\n    setup(props, { slots }) {\n      const $x = use$x();\n\n      /**\n       * Emits the {@link XEventsTypes.UserClickedOpenModal} event with the modalId as payload.\n       *\n       * @param event - The event triggering the function.\n       */\n      function openModal({ target }: Event) {\n        $x.emit('UserClickedOpenModal', props.modalId, { target: target as HTMLElement });\n      }\n\n      /* Hack to render through a render-function, the `opening-element` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n      const innerProps = { openModal };\n      return (\n        slots['opening-element'] ? () => slots['opening-element']?.(innerProps)[0] : innerProps\n      ) as typeof innerProps;\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedOpenModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks the button. The event payload is the id of the modal\n  that is going to be opened.\n\n## Examples\n\nComponent containing an event button that emits `UserClickedOpenModal` when it is clicked with the\nmodalId as payload. It has a default slot to customize its contents and can also be fully\ncustomized, replacing the default button with any other element.\n\n### Basic example\n\nThe component rendering content passed to the default slot inside the button and opening the modal\nwith modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalOpen modalId=\"my-modal\">\n    <img src=\"./open-button-icon.svg\" />\n    <span>Open</span>\n  </BaseIdModalOpen>\n</template>\n\n<script>\n  import { BaseIdModalOpen } from '@empathyco/x-components';\n\n  export default {\n    name: 'BaseIdModalOpenTest',\n    components: {\n      BaseIdModalOpen\n    }\n  };\n</script>\n```\n\n### Replacing the default button\n\nThe component renders whatever element is passed, replacing the default button and exposing the\nfunction to open the modal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalOpen modalId=\"my-modal\">\n    <template #opening-element=\"{ openModal }\">\n      <ul>\n        <li @click=\"openModal\">Open here</li>\n        <li>Not here</li>\n      </ul>\n    </template>\n  </BaseIdModalOpen>\n</template>\n\n<script>\n  import { BaseIdModalOpen } from '@empathyco/x-components';\n\n  export default {\n    name: 'BaseIdModalOpenTest',\n    components: {\n      BaseIdModalOpen\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;;;;;;;;AAeE;;;;;;AAME;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,KAAK,EAAE;;AAEL,QAAA,OAAO,EAAE;AACP,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,QAAQ,EAAE,IAAG;AACf,SAAA;AACD,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,KAAI,EAAG,EAAA;AACpB,QAAA,MAAM,EAAC,GAAI,KAAK,EAAE,CAAA;AAElB;;;;AAIE;AACF,QAAA,SAAS,SAAS,CAAC,EAAE,MAAK,EAAU,EAAA;AAClC,YAAA,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,MAAoB,EAAG,CAAC,CAAA;SACnF;AAEA;AAC6E;AAC7E,QAAA,MAAM,UAAW,GAAE,EAAE,SAAQ,EAAG,CAAA;QAChC,QACE,KAAK,CAAC,iBAAiB,CAAA,GAAI,MAAM,KAAK,CAAC,iBAAiB,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA,GAAI,UAAS,EAClE;KACxB;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"base-id-modal-open.vue2.js","sources":["../../../../src/components/modals/base-id-modal-open.vue"],"sourcesContent":["<template>\n  <button\n    class=\"x-events-modal-id-open-button x-button\"\n    data-test=\"open-modal-id\"\n    @click=\"openModal\"\n  >\n    <!-- @slot (Required) Button content with a text, an icon or both -->\n    <slot />\n  </button>\n</template>\n\n<script lang=\"ts\">\nimport { defineComponent } from 'vue'\nimport { use$x } from '../../composables'\n\n/**\n * Component that allows to open a modal by emitting {@link XEventsTypes.UserClickedOpenModal}\n * with the modalId as payload. It allows full customization with the 'opening-element' slot and\n * exposes the 'openModal' function.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseIdModalOpen',\n  props: {\n    /** The modalId of the modal that will be opened. */\n    modalId: {\n      type: String,\n      required: true,\n    },\n  },\n  setup(props, { slots }) {\n    const $x = use$x()\n\n    /**\n     * Emits the {@link XEventsTypes.UserClickedOpenModal} event with the modalId as payload.\n     *\n     * @param event - The event triggering the function.\n     * @param event.target - Event target.\n     */\n    function openModal({ target }: Event) {\n      $x.emit('UserClickedOpenModal', props.modalId, { target: target as HTMLElement })\n    }\n\n    /* Hack to render through a render-function, the `opening-element` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n    const innerProps = { openModal }\n    return (\n      slots['opening-element'] ? () => slots['opening-element']?.(innerProps)[0] : innerProps\n    ) as typeof innerProps\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedOpenModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks the button. The event payload is the id of the modal\n  that is going to be opened.\n\n## Examples\n\nComponent containing an event button that emits `UserClickedOpenModal` when it is clicked with the\nmodalId as payload. It has a default slot to customize its contents and can also be fully\ncustomized, replacing the default button with any other element.\n\n### Basic example\n\nThe component rendering content passed to the default slot inside the button and opening the modal\nwith modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalOpen modalId=\"my-modal\">\n    <img src=\"./open-button-icon.svg\" />\n    <span>Open</span>\n  </BaseIdModalOpen>\n</template>\n\n<script>\nimport { BaseIdModalOpen } from '@empathyco/x-components'\n\nexport default {\n  name: 'BaseIdModalOpenTest',\n  components: {\n    BaseIdModalOpen,\n  },\n}\n</script>\n```\n\n### Replacing the default button\n\nThe component renders whatever element is passed, replacing the default button and exposing the\nfunction to open the modal with modalId `my-modal`.\n\n```vue\n<template>\n  <BaseIdModalOpen modalId=\"my-modal\">\n    <template #opening-element=\"{ openModal }\">\n      <ul>\n        <li @click=\"openModal\">Open here</li>\n        <li>Not here</li>\n      </ul>\n    </template>\n  </BaseIdModalOpen>\n</template>\n\n<script>\nimport { BaseIdModalOpen } from '@empathyco/x-components'\n\nexport default {\n  name: 'BaseIdModalOpenTest',\n  components: {\n    BaseIdModalOpen,\n  },\n}\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;;;;;;;;AAeA;;;;;;AAME;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,KAAK,EAAE;;AAEL,QAAA,OAAO,EAAE;AACP,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;AACF,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,KAAI,EAAG,EAAA;AACpB,QAAA,MAAM,EAAC,GAAI,KAAK,EAAC,CAAA;AAEjB;;;;;AAKE;AACF,QAAA,SAAS,SAAS,CAAC,EAAE,MAAK,EAAU,EAAA;AAClC,YAAA,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,QAAuB,CAAA,CAAA;SAClF;AAEA;AAC+E;AAC/E,QAAA,MAAM,UAAW,GAAE,EAAE,SAAU,EAAA,CAAA;QAC/B,QACE,KAAK,CAAC,iBAAiB,CAAA,GAAI,MAAM,KAAK,CAAC,iBAAiB,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA,GAAI,UAAS,EACnE;KACtB;AACF,CAAA,CAAA;;;;"}

package/js/components/modals/base-id-modal.vue.js

@@ -6,17 +6,17 @@ function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
   const _component_BaseModal = resolveComponent("BaseModal");
   return openBlock(), createBlock(_component_BaseModal, {
     ref: _ctx.el,
-    "onClick:overlay": _ctx.emitClickOutOfModal,
-    "onFocusin:body": _ctx.emitClickOutOfModal,
     animation: _ctx.animation,
-    open: _ctx.isOpen
+    open: _ctx.isOpen,
+    "onClick:overlay": _ctx.emitClickOutOfModal,
+    "onFocusin:body": _ctx.emitClickOutOfModal
   }, {
     default: withCtx(() => [
       renderSlot(_ctx.$slots, "default")
     ]),
     _: 3
     /* FORWARDED */
-  }, 8, ["onClick:overlay", "onFocusin:body", "animation", "open"]);
+  }, 8, ["animation", "open", "onClick:overlay", "onFocusin:body"]);
 }
 var BaseIdModal = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
 

package/js/components/modals/base-id-modal.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-id-modal.vue.js","sources":["../../../../src/components/modals/base-id-modal.vue"],"sourcesContent":["<template>\n  <BaseModal\n    :ref=\"el\"\n    @click:overlay=\"emitClickOutOfModal\"\n    @focusin:body=\"emitClickOutOfModal\"\n    :animation=\"animation\"\n    :open=\"isOpen\"\n  >\n    <slot />\n  </BaseModal>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent, ref } from 'vue';\n  import { WireMetadata } from '../../wiring/wiring.types';\n  import { getTargetElement, isElementEqualOrContained } from '../../utils/html';\n  import { useXBus } from '../../composables';\n  import { AnimationProp } from '../../types/animation-prop';\n  import { XEvent } from '../../wiring/events.types';\n  import BaseModal from './base-modal.vue';\n\n  /**\n   * Component containing a modal expecting a required prop, named `modalId`. It reacts to\n   * `UserClickedOpenModal`, `UserClickedCloseModal` and `UserClickedOutOfModal` events, when their\n   * payload matches the component's 'modalId' prop, to handle its open/close state. The default\n   * slot offers the possibility to customise the modal content.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseIdModal',\n    components: { BaseModal },\n    props: {\n      /**\n       * Animation to use for opening/closing the modal.\n       */\n      animation: {\n        type: AnimationProp\n      },\n      /**\n       * The modalId to use for the open and close event listeners.\n       */\n      modalId: {\n        type: String,\n        required: true\n      }\n    },\n    setup(props) {\n      /** The element that opened the modal. */\n      let openerElement: HTMLElement | undefined;\n\n      /** Whether the modal is open or not. */\n      const isOpen = ref(false);\n\n      const el = ref<HTMLElement>();\n\n      const closeModalEvents: XEvent[] = ['UserClickedCloseModal', 'UserClickedOutOfModal'];\n\n      const xBus = useXBus();\n\n      /**\n       * Opens the modal.\n       *\n       * @param modalId - The payload of the {@link XEventsTypes.UserClickedOpenModal} event.\n       * @param metadata - The metadata of the emitted event.\n       * @public\n       */\n      function openModal(modalId: string, metadata: WireMetadata): void {\n        if (!isOpen.value && props.modalId === modalId) {\n          openerElement = metadata.target;\n          isOpen.value = true;\n        }\n      }\n\n      /**\n       * Closes the modal.\n       *\n       * @param payload - The payload of the closing events:\n       * {@link XEventsTypes.UserClickedCloseModal} or {@link XEventsTypes.UserClickedOutOfModal}.\n       *\n       * @public\n       */\n      function closeModal(payload: string): void {\n        if (isOpen.value && props.modalId === payload) {\n          isOpen.value = false;\n        }\n      }\n\n      /**\n       * Emits a {@link XEventsTypes.UserClickedOutOfModal} event unless the passed event target\n       * is the button that opened the modal.\n       *\n       * @param event - The event that triggered the close attempt.\n       * @public\n       */\n      function emitClickOutOfModal(event: MouseEvent | FocusEvent): void {\n        // Prevents clicking the open button when the panel is already open to close the panel.\n        if (!openerElement || !isElementEqualOrContained(openerElement, getTargetElement(event))) {\n          xBus.emit('UserClickedOutOfModal', props.modalId, { target: el.value as HTMLElement });\n        }\n      }\n\n      xBus\n        .on('UserClickedOpenModal', true)\n        .subscribe(({ eventPayload, metadata }) => openModal(eventPayload, metadata));\n\n      closeModalEvents.forEach(event => {\n        xBus.on(event, false).subscribe(eventPayload => closeModal(eventPayload as string));\n      });\n\n      return {\n        el,\n        isOpen,\n        emitClickOutOfModal\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedOutOfModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks outside the modal. The event payload is the id of the\n  modal and a metadata with the target element that emitted it.\n\n## Examples\n\nThe `BaseIdModal` component reacts to the `UserClickedOpenModal`, `UserClickedCloseModal` and\n`UserClickedOutOfModal` to handle its open/close state. The component filters out the events which\npayload doesn't match its `modalId` prop and reacts only to those who match this criteria.\n\n### Basic usage\n\nThe component interacts with both `BaseIdModalOpen` and `BaseIdModalClose` components, which have to\nshare the same value in their `modalId` prop to work:\n\n```vue\n<template>\n  <div>\n    <BaseIdModalOpen modalId=\"myModal\">Open</BaseIdModalOpen>\n    <BaseIdModal modalId=\"myModal\">\n      <img src=\"success.png\" />\n      <BaseIdModalClose modalId=\"myModal\">Close</BaseIdModalClose>\n    </BaseIdModal>\n  </div>\n</template>\n\n<script>\n  import { BaseIdModalOpen, BaseIdModal, BaseIdModalClose } from '@empathyco/x-components';\n\n  export default {\n    name: 'TestModal',\n    components: {\n      BaseIdModalOpen,\n      BaseIdModal,\n      BaseIdModalClose\n    }\n  };\n</script>\n```\n\n### Customized usage\n\n#### Customizing the content with classes\n\nThe `contentClass` prop can be used to add classes to the modal content.\n\n```vue\n<template>\n  <div>\n    <BaseIdModalOpen modalId=\"myModal\">Open</BaseIdModalOpen>\n    <BaseIdModal modalId=\"myModal\" contentClass=\"x-bg-neutral-75\">\n      <img src=\"success.png\" />\n      <BaseIdModalClose modalId=\"myModal\">Close</BaseIdModalClose>\n    </BaseIdModal>\n  </div>\n</template>\n\n<script>\n  import { BaseIdModalOpen, BaseIdModal, BaseIdModalClose } from '@empathyco/x-components';\n\n  export default {\n    name: 'TestModal',\n    components: {\n      BaseIdModalOpen,\n      BaseIdModal,\n      BaseIdModalClose\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_resolveComponent","_openBlock","emitClickOutOfModal","animation","_renderSlot"],"mappings":";;;;;+BACEA,gBAQY,CAAA,WAAA,CAAA,CAAA;AANT,EAAA,OAAAC,SAAA,IAAeC,WAAmB,CAAA,oBAAA,EAAA;AAAA,IAClC,GAAA,EAAA,IAAA,CAAA,EAAA;AAAA,IACA,iBAAWC,EAAAA,IAAAA,CAAAA,mBAAAA;AAAAA,IACX,gBAAY,EAAA,IAAA,CAAA,mBAAA;AAAA,IAAA,SAAA,EAAA,IAAA,CAAA,SAAA;AANjB,IAAA,IAAA,EAAA,IAAA,CAAA,MAAA;AAAA,GAAA,EAAA;;AAAA,MAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,CAAA;AAAA,KAAA,CAAA;;;;;;;;;"}
+{"version":3,"file":"base-id-modal.vue.js","sources":["../../../../src/components/modals/base-id-modal.vue"],"sourcesContent":["<template>\n  <BaseModal\n    :ref=\"el\"\n    :animation=\"animation\"\n    :open=\"isOpen\"\n    @click:overlay=\"emitClickOutOfModal\"\n    @focusin:body=\"emitClickOutOfModal\"\n  >\n    <slot />\n  </BaseModal>\n</template>\n\n<script lang=\"ts\">\nimport type { XEvent } from '../../wiring/events.types'\nimport type { WireMetadata } from '../../wiring/wiring.types'\nimport { defineComponent, ref } from 'vue'\nimport { useXBus } from '../../composables'\nimport { AnimationProp } from '../../types/animation-prop'\nimport { getTargetElement, isElementEqualOrContained } from '../../utils/html'\nimport BaseModal from './base-modal.vue'\n\n/**\n * Component containing a modal expecting a required prop, named `modalId`. It reacts to\n * `UserClickedOpenModal`, `UserClickedCloseModal` and `UserClickedOutOfModal` events, when their\n * payload matches the component's 'modalId' prop, to handle its open/close state. The default\n * slot offers the possibility to customise the modal content.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseIdModal',\n  components: { BaseModal },\n  props: {\n    /**\n     * Animation to use for opening/closing the modal.\n     */\n    animation: {\n      type: AnimationProp,\n    },\n    /**\n     * The modalId to use for the open and close event listeners.\n     */\n    modalId: {\n      type: String,\n      required: true,\n    },\n  },\n  setup(props) {\n    /** The element that opened the modal. */\n    let openerElement: HTMLElement | undefined\n\n    /** Whether the modal is open or not. */\n    const isOpen = ref(false)\n\n    const el = ref<HTMLElement>()\n\n    const closeModalEvents: XEvent[] = ['UserClickedCloseModal', 'UserClickedOutOfModal']\n\n    const xBus = useXBus()\n\n    /**\n     * Opens the modal.\n     *\n     * @param modalId - The payload of the {@link XEventsTypes.UserClickedOpenModal} event.\n     * @param metadata - The metadata of the emitted event.\n     * @public\n     */\n    function openModal(modalId: string, metadata: WireMetadata): void {\n      if (!isOpen.value && props.modalId === modalId) {\n        openerElement = metadata.target\n        isOpen.value = true\n      }\n    }\n\n    /**\n     * Closes the modal.\n     *\n     * @param payload - The payload of the closing events:\n     * {@link XEventsTypes.UserClickedCloseModal} or {@link XEventsTypes.UserClickedOutOfModal}.\n     *\n     * @public\n     */\n    function closeModal(payload: string): void {\n      if (isOpen.value && props.modalId === payload) {\n        isOpen.value = false\n      }\n    }\n\n    /**\n     * Emits a {@link XEventsTypes.UserClickedOutOfModal} event unless the passed event target\n     * is the button that opened the modal.\n     *\n     * @param event - The event that triggered the close attempt.\n     * @public\n     */\n    function emitClickOutOfModal(event: MouseEvent | FocusEvent): void {\n      // Prevents clicking the open button when the panel is already open to close the panel.\n      if (!openerElement || !isElementEqualOrContained(openerElement, getTargetElement(event))) {\n        xBus.emit('UserClickedOutOfModal', props.modalId, { target: el.value as HTMLElement })\n      }\n    }\n\n    xBus\n      .on('UserClickedOpenModal', true)\n      .subscribe(({ eventPayload, metadata }) => openModal(eventPayload, metadata))\n\n    closeModalEvents.forEach(event => {\n      xBus.on(event, false).subscribe(eventPayload => closeModal(eventPayload as string))\n    })\n\n    return {\n      el,\n      isOpen,\n      emitClickOutOfModal,\n    }\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedOutOfModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks outside the modal. The event payload is the id of the\n  modal and a metadata with the target element that emitted it.\n\n## Examples\n\nThe `BaseIdModal` component reacts to the `UserClickedOpenModal`, `UserClickedCloseModal` and\n`UserClickedOutOfModal` to handle its open/close state. The component filters out the events which\npayload doesn't match its `modalId` prop and reacts only to those who match this criteria.\n\n### Basic usage\n\nThe component interacts with both `BaseIdModalOpen` and `BaseIdModalClose` components, which have to\nshare the same value in their `modalId` prop to work:\n\n```vue\n<template>\n  <div>\n    <BaseIdModalOpen modalId=\"myModal\">Open</BaseIdModalOpen>\n    <BaseIdModal modalId=\"myModal\">\n      <img src=\"success.png\" />\n      <BaseIdModalClose modalId=\"myModal\">Close</BaseIdModalClose>\n    </BaseIdModal>\n  </div>\n</template>\n\n<script>\nimport { BaseIdModalOpen, BaseIdModal, BaseIdModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'TestModal',\n  components: {\n    BaseIdModalOpen,\n    BaseIdModal,\n    BaseIdModalClose,\n  },\n}\n</script>\n```\n\n### Customized usage\n\n#### Customizing the content with classes\n\nThe `contentClass` prop can be used to add classes to the modal content.\n\n```vue\n<template>\n  <div>\n    <BaseIdModalOpen modalId=\"myModal\">Open</BaseIdModalOpen>\n    <BaseIdModal modalId=\"myModal\" contentClass=\"x-bg-neutral-75\">\n      <img src=\"success.png\" />\n      <BaseIdModalClose modalId=\"myModal\">Close</BaseIdModalClose>\n    </BaseIdModal>\n  </div>\n</template>\n\n<script>\nimport { BaseIdModalOpen, BaseIdModal, BaseIdModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'TestModal',\n  components: {\n    BaseIdModalOpen,\n    BaseIdModal,\n    BaseIdModalClose,\n  },\n}\n</script>\n```\n</docs>\n"],"names":["_resolveComponent","_openBlock","_createBlock","isOpen","_renderSlot"],"mappings":";;;;;+BACEA,gBAQY,CAAA,WAAA,CAAA,CAAA;AANT,EAAA,OAAAC,SAAA,EAAoB,EAAAC,WAAA,CAAA,oBAAA,EAAA;AAAA,IACpB,KAAI,IAAEC,CAAAA,EAAAA;AAAAA,IACN,SAAA,EAAA,IAAA,CAAA,SAAA;AAAA,IACA,IAAA,EAAA,IAAA,CAAA,MAAA;AAAA,IAAA,iBAAA,EAAA,IAAA,CAAA,mBAAA;AANL,IAAA,gBAAA,EAQI,IAAQ,CAAA,mBAAA;AAAA,GAAA,EAAA;;AARZ,MAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,CAAA;AAAA,KAAA,CAAA;;;;;;;;;"}

package/js/components/modals/base-id-modal.vue2.js

@@ -1,5 +1,4 @@
 import { defineComponent, ref } from 'vue';
-import { isElementEqualOrContained, getTargetElement } from '../../utils/html.js';
 import '../../composables/create-use-device.js';
 import '@vue/devtools-api';
 import '../../plugins/devtools/timeline.devtools.js';
@@ -13,6 +12,7 @@ import 'vuex';
 import { useXBus } from '../../composables/use-x-bus.js';
 import '@vueuse/core';
 import { AnimationProp } from '../../types/animation-prop.js';
+import { isElementEqualOrContained, getTargetElement } from '../../utils/html.js';
 import BaseModal from './base-modal.vue.js';
 
 /**
@@ -31,15 +31,15 @@ var _sfc_main = defineComponent({
          * Animation to use for opening/closing the modal.
          */
         animation: {
-            type: AnimationProp
+            type: AnimationProp,
         },
         /**
          * The modalId to use for the open and close event listeners.
          */
         modalId: {
             type: String,
-            required: true
-        }
+            required: true,
+        },
     },
     setup(props) {
         /** The element that opened the modal. */
@@ -97,9 +97,9 @@ var _sfc_main = defineComponent({
         return {
             el,
             isOpen,
-            emitClickOutOfModal
+            emitClickOutOfModal,
         };
-    }
+    },
 });
 
 export { _sfc_main as default };

package/js/components/modals/base-id-modal.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-id-modal.vue2.js","sources":["../../../../src/components/modals/base-id-modal.vue"],"sourcesContent":["<template>\n  <BaseModal\n    :ref=\"el\"\n    @click:overlay=\"emitClickOutOfModal\"\n    @focusin:body=\"emitClickOutOfModal\"\n    :animation=\"animation\"\n    :open=\"isOpen\"\n  >\n    <slot />\n  </BaseModal>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent, ref } from 'vue';\n  import { WireMetadata } from '../../wiring/wiring.types';\n  import { getTargetElement, isElementEqualOrContained } from '../../utils/html';\n  import { useXBus } from '../../composables';\n  import { AnimationProp } from '../../types/animation-prop';\n  import { XEvent } from '../../wiring/events.types';\n  import BaseModal from './base-modal.vue';\n\n  /**\n   * Component containing a modal expecting a required prop, named `modalId`. It reacts to\n   * `UserClickedOpenModal`, `UserClickedCloseModal` and `UserClickedOutOfModal` events, when their\n   * payload matches the component's 'modalId' prop, to handle its open/close state. The default\n   * slot offers the possibility to customise the modal content.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseIdModal',\n    components: { BaseModal },\n    props: {\n      /**\n       * Animation to use for opening/closing the modal.\n       */\n      animation: {\n        type: AnimationProp\n      },\n      /**\n       * The modalId to use for the open and close event listeners.\n       */\n      modalId: {\n        type: String,\n        required: true\n      }\n    },\n    setup(props) {\n      /** The element that opened the modal. */\n      let openerElement: HTMLElement | undefined;\n\n      /** Whether the modal is open or not. */\n      const isOpen = ref(false);\n\n      const el = ref<HTMLElement>();\n\n      const closeModalEvents: XEvent[] = ['UserClickedCloseModal', 'UserClickedOutOfModal'];\n\n      const xBus = useXBus();\n\n      /**\n       * Opens the modal.\n       *\n       * @param modalId - The payload of the {@link XEventsTypes.UserClickedOpenModal} event.\n       * @param metadata - The metadata of the emitted event.\n       * @public\n       */\n      function openModal(modalId: string, metadata: WireMetadata): void {\n        if (!isOpen.value && props.modalId === modalId) {\n          openerElement = metadata.target;\n          isOpen.value = true;\n        }\n      }\n\n      /**\n       * Closes the modal.\n       *\n       * @param payload - The payload of the closing events:\n       * {@link XEventsTypes.UserClickedCloseModal} or {@link XEventsTypes.UserClickedOutOfModal}.\n       *\n       * @public\n       */\n      function closeModal(payload: string): void {\n        if (isOpen.value && props.modalId === payload) {\n          isOpen.value = false;\n        }\n      }\n\n      /**\n       * Emits a {@link XEventsTypes.UserClickedOutOfModal} event unless the passed event target\n       * is the button that opened the modal.\n       *\n       * @param event - The event that triggered the close attempt.\n       * @public\n       */\n      function emitClickOutOfModal(event: MouseEvent | FocusEvent): void {\n        // Prevents clicking the open button when the panel is already open to close the panel.\n        if (!openerElement || !isElementEqualOrContained(openerElement, getTargetElement(event))) {\n          xBus.emit('UserClickedOutOfModal', props.modalId, { target: el.value as HTMLElement });\n        }\n      }\n\n      xBus\n        .on('UserClickedOpenModal', true)\n        .subscribe(({ eventPayload, metadata }) => openModal(eventPayload, metadata));\n\n      closeModalEvents.forEach(event => {\n        xBus.on(event, false).subscribe(eventPayload => closeModal(eventPayload as string));\n      });\n\n      return {\n        el,\n        isOpen,\n        emitClickOutOfModal\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedOutOfModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks outside the modal. The event payload is the id of the\n  modal and a metadata with the target element that emitted it.\n\n## Examples\n\nThe `BaseIdModal` component reacts to the `UserClickedOpenModal`, `UserClickedCloseModal` and\n`UserClickedOutOfModal` to handle its open/close state. The component filters out the events which\npayload doesn't match its `modalId` prop and reacts only to those who match this criteria.\n\n### Basic usage\n\nThe component interacts with both `BaseIdModalOpen` and `BaseIdModalClose` components, which have to\nshare the same value in their `modalId` prop to work:\n\n```vue\n<template>\n  <div>\n    <BaseIdModalOpen modalId=\"myModal\">Open</BaseIdModalOpen>\n    <BaseIdModal modalId=\"myModal\">\n      <img src=\"success.png\" />\n      <BaseIdModalClose modalId=\"myModal\">Close</BaseIdModalClose>\n    </BaseIdModal>\n  </div>\n</template>\n\n<script>\n  import { BaseIdModalOpen, BaseIdModal, BaseIdModalClose } from '@empathyco/x-components';\n\n  export default {\n    name: 'TestModal',\n    components: {\n      BaseIdModalOpen,\n      BaseIdModal,\n      BaseIdModalClose\n    }\n  };\n</script>\n```\n\n### Customized usage\n\n#### Customizing the content with classes\n\nThe `contentClass` prop can be used to add classes to the modal content.\n\n```vue\n<template>\n  <div>\n    <BaseIdModalOpen modalId=\"myModal\">Open</BaseIdModalOpen>\n    <BaseIdModal modalId=\"myModal\" contentClass=\"x-bg-neutral-75\">\n      <img src=\"success.png\" />\n      <BaseIdModalClose modalId=\"myModal\">Close</BaseIdModalClose>\n    </BaseIdModal>\n  </div>\n</template>\n\n<script>\n  import { BaseIdModalOpen, BaseIdModal, BaseIdModalClose } from '@empathyco/x-components';\n\n  export default {\n    name: 'TestModal',\n    components: {\n      BaseIdModalOpen,\n      BaseIdModal,\n      BaseIdModalClose\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAqBE;;;;;;;AAOE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,aAAa;IACnB,UAAU,EAAE,EAAE,WAAW;AACzB,IAAA,KAAK,EAAE;AACL;;AAEE;AACF,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAY;AACnB,SAAA;AACD;;AAEE;AACF,QAAA,OAAO,EAAE;AACP,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,QAAQ,EAAE,IAAG;AACf,SAAA;AACD,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;;AAET,QAAA,IAAI,aAAsC,CAAA;;AAG1C,QAAA,MAAM,MAAK,GAAI,GAAG,CAAC,KAAK,CAAC,CAAA;AAEzB,QAAA,MAAM,KAAK,GAAG,EAAe,CAAA;AAE7B,QAAA,MAAM,gBAAgB,GAAa,CAAC,uBAAuB,EAAE,uBAAuB,CAAC,CAAA;AAErF,QAAA,MAAM,IAAG,GAAI,OAAO,EAAE,CAAA;AAEtB;;;;;;AAME;AACF,QAAA,SAAS,SAAS,CAAC,OAAe,EAAE,QAAsB,EAAA;YACxD,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,CAAC,OAAQ,KAAI,OAAO,EAAE;AAC9C,gBAAA,aAAc,GAAE,QAAQ,CAAC,MAAM,CAAA;AAC/B,gBAAA,MAAM,CAAC,KAAM,GAAE,IAAI,CAAA;AACrB,aAAA;SACF;AAEA;;;;;;;AAOE;QACF,SAAS,UAAU,CAAC,OAAe,EAAA;YACjC,IAAI,MAAM,CAAC,SAAS,KAAK,CAAC,OAAQ,KAAI,OAAO,EAAE;AAC7C,gBAAA,MAAM,CAAC,QAAQ,KAAK,CAAA;AACtB,aAAA;SACF;AAEA;;;;;;AAME;QACF,SAAS,mBAAmB,CAAC,KAA8B,EAAA;;AAEzD,YAAA,IAAI,CAAC,aAAY,IAAK,CAAC,yBAAyB,CAAC,aAAa,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE;AACxF,gBAAA,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,KAAmB,EAAG,CAAC,CAAA;AACxF,aAAA;SACF;QAEA,IAAG;AACA,aAAA,EAAE,CAAC,sBAAsB,EAAE,IAAI,CAAA;AAC/B,aAAA,SAAS,CAAC,CAAC,EAAE,YAAY,EAAE,QAAS,EAAC,KAAK,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAA;AAE/E,QAAA,gBAAgB,CAAC,OAAO,CAAC,KAAI,IAAK;AAChC,YAAA,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,YAAa,IAAG,UAAU,CAAC,YAAsB,CAAC,CAAC,CAAA;AACrF,SAAC,CAAC,CAAA;QAEF,OAAO;YACL,EAAE;YACF,MAAM;YACN,mBAAkB;SACnB,CAAA;KACH;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"base-id-modal.vue2.js","sources":["../../../../src/components/modals/base-id-modal.vue"],"sourcesContent":["<template>\n  <BaseModal\n    :ref=\"el\"\n    :animation=\"animation\"\n    :open=\"isOpen\"\n    @click:overlay=\"emitClickOutOfModal\"\n    @focusin:body=\"emitClickOutOfModal\"\n  >\n    <slot />\n  </BaseModal>\n</template>\n\n<script lang=\"ts\">\nimport type { XEvent } from '../../wiring/events.types'\nimport type { WireMetadata } from '../../wiring/wiring.types'\nimport { defineComponent, ref } from 'vue'\nimport { useXBus } from '../../composables'\nimport { AnimationProp } from '../../types/animation-prop'\nimport { getTargetElement, isElementEqualOrContained } from '../../utils/html'\nimport BaseModal from './base-modal.vue'\n\n/**\n * Component containing a modal expecting a required prop, named `modalId`. It reacts to\n * `UserClickedOpenModal`, `UserClickedCloseModal` and `UserClickedOutOfModal` events, when their\n * payload matches the component's 'modalId' prop, to handle its open/close state. The default\n * slot offers the possibility to customise the modal content.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseIdModal',\n  components: { BaseModal },\n  props: {\n    /**\n     * Animation to use for opening/closing the modal.\n     */\n    animation: {\n      type: AnimationProp,\n    },\n    /**\n     * The modalId to use for the open and close event listeners.\n     */\n    modalId: {\n      type: String,\n      required: true,\n    },\n  },\n  setup(props) {\n    /** The element that opened the modal. */\n    let openerElement: HTMLElement | undefined\n\n    /** Whether the modal is open or not. */\n    const isOpen = ref(false)\n\n    const el = ref<HTMLElement>()\n\n    const closeModalEvents: XEvent[] = ['UserClickedCloseModal', 'UserClickedOutOfModal']\n\n    const xBus = useXBus()\n\n    /**\n     * Opens the modal.\n     *\n     * @param modalId - The payload of the {@link XEventsTypes.UserClickedOpenModal} event.\n     * @param metadata - The metadata of the emitted event.\n     * @public\n     */\n    function openModal(modalId: string, metadata: WireMetadata): void {\n      if (!isOpen.value && props.modalId === modalId) {\n        openerElement = metadata.target\n        isOpen.value = true\n      }\n    }\n\n    /**\n     * Closes the modal.\n     *\n     * @param payload - The payload of the closing events:\n     * {@link XEventsTypes.UserClickedCloseModal} or {@link XEventsTypes.UserClickedOutOfModal}.\n     *\n     * @public\n     */\n    function closeModal(payload: string): void {\n      if (isOpen.value && props.modalId === payload) {\n        isOpen.value = false\n      }\n    }\n\n    /**\n     * Emits a {@link XEventsTypes.UserClickedOutOfModal} event unless the passed event target\n     * is the button that opened the modal.\n     *\n     * @param event - The event that triggered the close attempt.\n     * @public\n     */\n    function emitClickOutOfModal(event: MouseEvent | FocusEvent): void {\n      // Prevents clicking the open button when the panel is already open to close the panel.\n      if (!openerElement || !isElementEqualOrContained(openerElement, getTargetElement(event))) {\n        xBus.emit('UserClickedOutOfModal', props.modalId, { target: el.value as HTMLElement })\n      }\n    }\n\n    xBus\n      .on('UserClickedOpenModal', true)\n      .subscribe(({ eventPayload, metadata }) => openModal(eventPayload, metadata))\n\n    closeModalEvents.forEach(event => {\n      xBus.on(event, false).subscribe(eventPayload => closeModal(eventPayload as string))\n    })\n\n    return {\n      el,\n      isOpen,\n      emitClickOutOfModal,\n    }\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`UserClickedOutOfModal`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted after the user clicks outside the modal. The event payload is the id of the\n  modal and a metadata with the target element that emitted it.\n\n## Examples\n\nThe `BaseIdModal` component reacts to the `UserClickedOpenModal`, `UserClickedCloseModal` and\n`UserClickedOutOfModal` to handle its open/close state. The component filters out the events which\npayload doesn't match its `modalId` prop and reacts only to those who match this criteria.\n\n### Basic usage\n\nThe component interacts with both `BaseIdModalOpen` and `BaseIdModalClose` components, which have to\nshare the same value in their `modalId` prop to work:\n\n```vue\n<template>\n  <div>\n    <BaseIdModalOpen modalId=\"myModal\">Open</BaseIdModalOpen>\n    <BaseIdModal modalId=\"myModal\">\n      <img src=\"success.png\" />\n      <BaseIdModalClose modalId=\"myModal\">Close</BaseIdModalClose>\n    </BaseIdModal>\n  </div>\n</template>\n\n<script>\nimport { BaseIdModalOpen, BaseIdModal, BaseIdModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'TestModal',\n  components: {\n    BaseIdModalOpen,\n    BaseIdModal,\n    BaseIdModalClose,\n  },\n}\n</script>\n```\n\n### Customized usage\n\n#### Customizing the content with classes\n\nThe `contentClass` prop can be used to add classes to the modal content.\n\n```vue\n<template>\n  <div>\n    <BaseIdModalOpen modalId=\"myModal\">Open</BaseIdModalOpen>\n    <BaseIdModal modalId=\"myModal\" contentClass=\"x-bg-neutral-75\">\n      <img src=\"success.png\" />\n      <BaseIdModalClose modalId=\"myModal\">Close</BaseIdModalClose>\n    </BaseIdModal>\n  </div>\n</template>\n\n<script>\nimport { BaseIdModalOpen, BaseIdModal, BaseIdModalClose } from '@empathyco/x-components'\n\nexport default {\n  name: 'TestModal',\n  components: {\n    BaseIdModalOpen,\n    BaseIdModal,\n    BaseIdModalClose,\n  },\n}\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAqBA;;;;;;;AAOE;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,aAAa;IACnB,UAAU,EAAE,EAAE,WAAW;AACzB,IAAA,KAAK,EAAE;AACL;;AAEE;AACF,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACpB,SAAA;AACD;;AAEE;AACF,QAAA,OAAO,EAAE;AACP,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;AACF,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;;AAET,QAAA,IAAI,aAAqC,CAAA;;AAGzC,QAAA,MAAM,SAAS,GAAG,CAAC,KAAK,CAAA,CAAA;AAExB,QAAA,MAAM,EAAG,GAAE,GAAG,EAAc,CAAA;AAE5B,QAAA,MAAM,gBAAgB,GAAa,CAAC,uBAAuB,EAAE,uBAAuB,CAAA,CAAA;AAEpF,QAAA,MAAM,IAAG,GAAI,OAAO,EAAC,CAAA;AAErB;;;;;;AAME;AACF,QAAA,SAAS,SAAS,CAAC,OAAe,EAAE,QAAsB,EAAA;YACxD,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,CAAC,OAAQ,KAAI,OAAO,EAAE;AAC9C,gBAAA,aAAc,GAAE,QAAQ,CAAC,MAAK,CAAA;AAC9B,gBAAA,MAAM,CAAC,KAAI,GAAI,IAAG,CAAA;AACpB,aAAA;SACF;AAEA;;;;;;;AAOE;QACF,SAAS,UAAU,CAAC,OAAe,EAAA;YACjC,IAAI,MAAM,CAAC,SAAS,KAAK,CAAC,OAAQ,KAAI,OAAO,EAAE;AAC7C,gBAAA,MAAM,CAAC,KAAM,GAAE,KAAI,CAAA;AACrB,aAAA;SACF;AAEA;;;;;;AAME;QACF,SAAS,mBAAmB,CAAC,KAA8B,EAAA;;AAEzD,YAAA,IAAI,CAAC,aAAY,IAAK,CAAC,yBAAyB,CAAC,aAAa,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE;AACxF,gBAAA,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,OAAsB,CAAA,CAAA;AACvF,aAAA;SACF;QAEA,IAAG;AACA,aAAA,EAAE,CAAC,sBAAsB,EAAE,IAAI,CAAA;AAC/B,aAAA,SAAS,CAAC,CAAC,EAAE,YAAY,EAAE,QAAS,EAAC,KAAK,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA,CAAA;AAE9E,QAAA,gBAAgB,CAAC,OAAO,CAAC,KAAI,IAAK;AAChC,YAAA,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,CAAC,YAAW,IAAK,UAAU,CAAC,YAAsB,CAAC,CAAA,CAAA;AACpF,SAAC,CAAA,CAAA;QAED,OAAO;YACL,EAAE;YACF,MAAM;YACN,mBAAmB;SACrB,CAAA;KACD;AACF,CAAA,CAAA;;;;"}

package/js/components/modals/base-modal.vue.js

@@ -49,10 +49,10 @@ function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
             "div",
             {
               key: 0,
-              onClick: _cache[2] || (_cache[2] = (...args) => _ctx.emitOverlayClicked && _ctx.emitOverlayClicked(...args)),
-              onKeydown: _cache[3] || (_cache[3] = (...args) => _ctx.emitOverlayClicked && _ctx.emitOverlayClicked(...args)),
               class: normalizeClass(["x-modal__overlay", _ctx.overlayClass]),
-              "data-test": "modal-overlay"
+              "data-test": "modal-overlay",
+              onClick: _cache[2] || (_cache[2] = (...args) => _ctx.emitOverlayClicked && _ctx.emitOverlayClicked(...args)),
+              onKeydown: _cache[3] || (_cache[3] = (...args) => _ctx.emitOverlayClicked && _ctx.emitOverlayClicked(...args))
             },
             null,
             34

package/js/components/modals/base-modal.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-modal.vue.js","sources":["../../../../src/components/modals/base-modal.vue"],"sourcesContent":["<template>\n  <div v-show=\"isWaitingForLeave || open\" ref=\"modalRef\" class=\"x-modal\" data-test=\"modal\">\n    <component\n      :is=\"animation\"\n      @before-leave=\"isWaitingForLeave = true\"\n      @after-leave=\"isWaitingForLeave = false\"\n    >\n      <div\n        v-if=\"open\"\n        ref=\"modalContentRef\"\n        class=\"x-modal__content\"\n        data-test=\"modal-content\"\n        role=\"dialog\"\n        :class=\"contentClass\"\n      >\n        <!-- @slot (Required) Modal container content -->\n        <slot />\n      </div>\n    </component>\n    <component :is=\"overlayAnimation\">\n      <div\n        v-if=\"open\"\n        @click=\"emitOverlayClicked\"\n        @keydown=\"emitOverlayClicked\"\n        class=\"x-modal__overlay\"\n        :class=\"overlayClass\"\n        data-test=\"modal-overlay\"\n      />\n    </component>\n  </div>\n</template>\n\n<script lang=\"ts\">\n  import { defineComponent, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue';\n  import { useDebounce } from '../../composables';\n  import { AnimationProp } from '../../types';\n  import { getTargetElement, FOCUSABLE_SELECTORS } from '../../utils';\n  import { Fade, NoAnimation } from '../animations';\n\n  /**\n   * Base component with no XPlugin dependencies that serves as a utility for constructing more\n   * complex modals.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'BaseModal',\n    props: {\n      /** Determines if the modal is open or not. */\n      open: {\n        type: Boolean,\n        required: true\n      },\n      /**\n       * Determines if the focused element changes to one inside the modal when it opens. Either the\n       * first element with a positive tabindex or just the first focusable element.\n       */\n      focusOnOpen: {\n        type: Boolean,\n        default: true\n      },\n      /**\n       * The reference selector of a DOM element to use as reference to position the modal.\n       * This selector can be an ID or a class, if it is a class, it will use the first\n       * element that matches.\n       */\n      referenceSelector: String,\n      /** Animation to use for opening/closing the modal.This animation only affects the content. */\n      animation: {\n        type: AnimationProp,\n        default: () => NoAnimation\n      },\n      /**\n       * Animation to use for the overlay (backdrop) part of the modal. By default, it uses\n       * a fade transition.\n       */\n      overlayAnimation: {\n        type: AnimationProp,\n        default: () => Fade\n      },\n      /** Class inherited by content element. */\n      contentClass: String,\n      /** Class inherited by overlay element. */\n      overlayClass: String\n    },\n    emits: ['click:overlay', 'focusin:body'],\n    setup(props, { emit }) {\n      /** Reference to the modal element in the DOM. */\n      const modalRef = ref<HTMLDivElement>();\n      /** Reference to the modal content element in the DOM. */\n      const modalContentRef = ref<HTMLDivElement>();\n\n      /** The previous value of the body overflow style. */\n      const previousBodyOverflow = ref('');\n      /** The previous value of the HTML element overflow style. */\n      const previousHTMLOverflow = ref('');\n      /** Boolean to delay the leave animation until it has completed. */\n      const isWaitingForLeave = ref(false);\n      /** The reference element to use to find the modal's position. */\n      let referenceElement: HTMLElement | undefined;\n\n      /** Disables the scroll of both the body and the window. */\n      function disableScroll() {\n        previousBodyOverflow.value = document.body.style.overflow;\n        previousHTMLOverflow.value = document.documentElement.style.overflow;\n        document.body.style.overflow = document.documentElement.style.overflow = 'hidden';\n      }\n\n      /** Restores the scroll of both the body and the window. */\n      function enableScroll() {\n        document.body.style.overflow = previousBodyOverflow.value;\n        document.documentElement.style.overflow = previousHTMLOverflow.value;\n      }\n\n      /**\n       * Emits the `click:overlay` event if the click has been triggered in the overlay layer.\n       *\n       * @param event - The click event.\n       */\n      function emitOverlayClicked(event: Event) {\n        emit('click:overlay', event);\n      }\n\n      /**\n       * Emits the `focusin:body` event if a focus event has been triggered outside the modal.\n       *\n       * @param event - The focusin event.\n       */\n      function emitFocusInBody(event: FocusEvent) {\n        if (!modalContentRef.value?.contains(getTargetElement(event))) {\n          emit('focusin:body', event);\n        }\n      }\n\n      /**\n       * Adds listeners to the body element ot detect if the modal should be closed.\n       *\n       * @remarks TODO find a better solution and remove the timeout\n       * To avoid emit the focusin on opening X that provokes closing it immediately.\n       * This is because this event was emitted after the open of main modal when the user clicks\n       * on the customer website search box (focus event). This way we avoid add the listener before\n       * the open and the avoid the event that provokes the close.\n       */\n      function addBodyListeners() {\n        setTimeout(() => {\n          document.body.addEventListener('focusin', emitFocusInBody);\n        });\n      }\n\n      /** Removes the body listeners. */\n      function removeBodyListeners() {\n        document.body.removeEventListener('focusin', emitFocusInBody);\n      }\n\n      /**\n       * Sets the focused element to the first element either the first element with a positive\n       * tabindex or, if there isn't any, the first focusable element inside the modal.\n       */\n      function setFocus() {\n        const candidates: HTMLElement[] = Array.from(\n          modalContentRef.value?.querySelectorAll(FOCUSABLE_SELECTORS) ?? []\n        );\n        const element = candidates.find(element => element.tabIndex) ?? candidates[0];\n        element?.focus();\n      }\n\n      /**\n       * Syncs the body to the open state of the modal, adding or removing styles and listeners.\n       *\n       * @remarks nextTick() to wait for `modalContentRef` to be updated to look for focusable\n       * candidates inside.\n       *\n       * @param isOpen - True when the modal is opened.\n       */\n      async function syncBody(isOpen: boolean) {\n        if (isOpen) {\n          disableScroll();\n          addBodyListeners();\n          if (props.focusOnOpen) {\n            await nextTick();\n            setFocus();\n          }\n        } else {\n          enableScroll();\n          removeBodyListeners();\n        }\n      }\n\n      /**\n       * Updates the position of the modal setting the top of the element depending\n       * on the selector. The modal will be placed under this selector.\n       */\n      const debouncedUpdatePosition = useDebounce(\n        () => {\n          const { height, y } = referenceElement?.getBoundingClientRect() ?? { height: 0, y: 0 };\n          modalRef.value!.style.top = `${height + y}px`;\n          modalRef.value!.style.bottom = '0';\n          modalRef.value!.style.height = 'auto';\n        },\n        100,\n        { leading: true }\n      );\n\n      let resizeObserver: ResizeObserver;\n\n      onMounted(() => {\n        watch(() => props.open, syncBody);\n        if (props.open) {\n          syncBody(true);\n        }\n\n        resizeObserver = new ResizeObserver(debouncedUpdatePosition);\n\n        watch(\n          () => props.referenceSelector,\n          () => {\n            resizeObserver.disconnect();\n\n            if (props.referenceSelector) {\n              const element = document.querySelector(props.referenceSelector) as HTMLElement;\n              if (element) {\n                referenceElement = element;\n                resizeObserver.observe(element);\n              }\n            } else {\n              referenceElement = undefined;\n              debouncedUpdatePosition();\n            }\n          },\n          { immediate: true }\n        );\n      });\n\n      onBeforeUnmount(() => {\n        if (props.open) {\n          removeBodyListeners();\n          enableScroll();\n        }\n        resizeObserver.disconnect();\n      });\n\n      return {\n        emitOverlayClicked,\n        isWaitingForLeave,\n        modalContentRef,\n        modalRef\n      };\n    }\n  });\n</script>\n\n<style lang=\"css\" scoped>\n  .x-modal {\n    position: fixed;\n    top: 0;\n    left: 0;\n    display: flex;\n    align-items: flex-start;\n    justify-content: flex-start;\n    width: 100%;\n    height: 100%;\n    z-index: 1;\n  }\n\n  .x-modal__content {\n    display: flex;\n    flex-flow: column nowrap;\n    z-index: 1;\n  }\n\n  .x-modal__overlay {\n    width: 100%;\n    height: 100%;\n    position: absolute;\n    background-color: rgb(0, 0, 0);\n    opacity: 0.3;\n  }\n</style>\n\n<docs lang=\"mdx\">\n## Examples\n\nThe `BaseModal` is a simple component that serves to create complex modals. Its open state has to be\npassed via prop. There is a prop, `referenceSelector`, used to place the modal under some element\ninstead of set the top of the element directly. It also accepts an animation to use for opening &\nclosing.\n\nIt emits a `click:overlay` event when any part out of the content is clicked, but only if the modal\nis open.\n\n```vue\n<template>\n  <div>\n    <button @click=\"open = true\">Open modal</button>\n    <BaseModal\n      :animation=\"fadeAndSlide\"\n      :open=\"open\"\n      @click:overlay=\"open = false\"\n      referenceSelector=\".header\"\n    >\n      <h1>Hello</h1>\n      <p>The modal is working</p>\n      <button @click=\"open = false\">Close modal</button>\n    </BaseModal>\n  </div>\n</template>\n\n<script>\n  import { BaseModal, FadeAndSlide } from '@empathyco/x-components';\n  import Vue from 'vue';\n\n  Vue.component('fadeAndSlide', FadeAndSlide);\n\n  export default {\n    components: {\n      BaseModal\n    },\n    data() {\n      return {\n        open: false\n      };\n    }\n  };\n</script>\n```\n\n### Customized usage\n\n#### Customizing the content with classes\n\nThe `contentClass` prop can be used to add classes to the modal content.\n\n```vue\n<template>\n  <div>\n    <button @click=\"open = true\">Open modal</button>\n    <BaseModal\n      :animation=\"fadeAndSlide\"\n      :open=\"open\"\n      @click:overlay=\"open = false\"\n      referenceSelector=\".header\"\n      contentClass=\"x-bg-neutral-75\"\n    >\n      <h1>Hello</h1>\n      <p>The modal is working</p>\n      <button @click=\"open = false\">Close modal</button>\n    </BaseModal>\n  </div>\n</template>\n\n<script>\n  import { BaseModal, FadeAndSlide } from '@empathyco/x-components';\n  import Vue from 'vue';\n\n  Vue.component('fadeAndSlide', FadeAndSlide);\n\n  export default {\n    components: {\n      BaseModal\n    },\n    data() {\n      return {\n        open: false\n      };\n    }\n  };\n</script>\n```\n\n#### Customizing the overlay with classes\n\nThe `overlayClass` prop can be used to add classes to the modal overlay.\n\n```vue\n<template>\n  <div>\n    <button @click=\"open = true\">Open modal</button>\n    <BaseModal\n      :animation=\"fadeAndSlide\"\n      :open=\"open\"\n      @click:overlay=\"open = false\"\n      referenceSelector=\".header\"\n      overlayClass=\"x-bg-neutral-75\"\n    >\n      <h1>Hello</h1>\n      <p>The modal is working</p>\n      <button @click=\"open = false\">Close modal</button>\n    </BaseModal>\n  </div>\n</template>\n\n<script>\n  import { BaseModal, FadeAndSlide } from '@empathyco/x-components';\n  import Vue from 'vue';\n\n  Vue.component('fadeAndSlide', FadeAndSlide);\n\n  export default {\n    components: {\n      BaseModal\n    },\n    data() {\n      return {\n        open: false\n      };\n    }\n  };\n</script>\n```\n\n## Vue Events\n\nA list of events that the component will emit:\n\n- `click:overlay`: the event is emitted after the user clicks any part out of the content but only\n  if the modal is open. The event payload is the mouse event that triggers it.\n- `focusin:body`: the event is emitted after the user focus in any part out of the content but only\n  if the modal is open. The event payload is the focus event that triggers it.\n</docs>\n"],"names":["animation","_withDirectives","_openBlock","_createElementBlock","isWaitingForLeave","_createBlock","_withCtx","_normalizeClass","_renderSlot","_createCommentVNode","_resolveDynamicComponent","overlayClass"],"mappings":";;;;;MACyD,UAAe,GAAA;AAAA,EAAC,GAAA,EAAA,UAAA;AAAA,EAAA,KAAA,EAAA,SAAA;;;AACrE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EAFJ,MAGWA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;SACJC,cAAY,EAAAC,SAAA,EAAA,EAAAC,kBAAA;AAAA,IAAEC,KAAAA;AAAAA,IAAAA,UAAAA;AAAAA,IAAAA;AAAAA,OAAAA,SAAAA,EACH,EAAAC,WAAA;AAAA,QAAED,uBAAAA,CAAAA,IAAAA,CAAAA,SAAAA,CAAAA;AAAAA,QAAAA;AAAAA,UAAAA,aAAAA,EAAAA,MAAAA,CAAAA,CAAAA,CAAAA,KAAAA,MAAAA,CAAAA,CAAAA,CAAAA,GAAAA,CAAAA,MAAAA,KAAAA,IAAAA,CAAAA,iBAAAA,GAAAA,IAAAA,CAAAA;UALpB,YAiBY,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,MAAA,KAAA,IAAA,CAAA,iBAAA,GAAA,KAAA,CAAA;AAAA,SAAA;;AAVN,UAAA,OAAA,EAAAE,OAAA,CAAA,MAAA;AAAA,YAAA,IAAA,CAPN,IASY,IAAAJ,SAAA,EAAA,EAAAC,kBAAA;AAAA,cAAiB,KAAA;AAAA,cAAA;AAAA,gBACrB,GAAK,EAAA,CAAA;AAAA,gBACL,GAAA,EAAA,iBAAA;AAAA,gBACA,OAAKI,cAAQ,CAAA,CAAA,kBAAA,EAAA,IAAA,CAAA,YAAA,CAAA,CAAA;AAAA,gBAAA,WAAA,EAAA,eAAA;AAIb,gBAAA,IAAA,EAAA,QAAA;AAAA,eAAA;;AAhBR,gBAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,EAAA,EAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA;AAAA,eAAA;;;AAAA,aAAA,IAAAC,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA;AAAA,WAAA,CAAA;;;;AAAA,QAAA,EAAA;AAAA;AAAA,OA2BQ;AAAA,OAAAP,SAAA,EANU,EAAAG,WAAA,CAAAK,uBAAA,CAAA,IAAA,CAAA,gBAAA,CAAA,EAAA,IAAA,EAAA;AAAA,QADZ,OAAA,EAAAJ,OAAA,CAAA,MAAA;AAAA,UAAA,IAAA,CApBN,IAsBc,IAAAJ,SAAA,EAAA,EAAAC,kBAAA;AAAA,YAAA,KAAA;AAAA,YAAA;AAAA,cACL,GAAA,EAAA,CAAA;AAAA,cACD,OAAA,EAxBR,MAwBc,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KACEQ,IAAY,CAAA,kBAAA,IAAA,IAAA,CAAA,kBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,cACpB,SAAA,EAAS,OAAC,CAAe,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,kBAAA,IAAA,IAAA,CAAA,kBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,cAAA,KAAA,EAAAJ,cAAA,CAAA,CAAA,kBAAA,EAAA,IAAA,CAAA,YAAA,CAAA,CAAA;AA1BjC,cAAA,WAAA,EAAA,eAAA;AAAA,aAAA;;;;AAAA,WAAA,IAAAE,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA;AAAA,SAAA,CAAA;;;;;;;;;;;;;;;"}
+{"version":3,"file":"base-modal.vue.js","sources":["../../../../src/components/modals/base-modal.vue"],"sourcesContent":["<template>\n  <div v-show=\"isWaitingForLeave || open\" ref=\"modalRef\" class=\"x-modal\" data-test=\"modal\">\n    <component\n      :is=\"animation\"\n      @before-leave=\"isWaitingForLeave = true\"\n      @after-leave=\"isWaitingForLeave = false\"\n    >\n      <div\n        v-if=\"open\"\n        ref=\"modalContentRef\"\n        class=\"x-modal__content\"\n        data-test=\"modal-content\"\n        role=\"dialog\"\n        :class=\"contentClass\"\n      >\n        <!-- @slot (Required) Modal container content -->\n        <slot />\n      </div>\n    </component>\n    <component :is=\"overlayAnimation\">\n      <div\n        v-if=\"open\"\n        class=\"x-modal__overlay\"\n        :class=\"overlayClass\"\n        data-test=\"modal-overlay\"\n        @click=\"emitOverlayClicked\"\n        @keydown=\"emitOverlayClicked\"\n      />\n    </component>\n  </div>\n</template>\n\n<script lang=\"ts\">\nimport { defineComponent, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue'\nimport { useDebounce } from '../../composables'\nimport { AnimationProp } from '../../types'\nimport { FOCUSABLE_SELECTORS, getTargetElement } from '../../utils'\nimport { Fade, NoAnimation } from '../animations'\n\n/**\n * Base component with no XPlugin dependencies that serves as a utility for constructing more\n * complex modals.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'BaseModal',\n  props: {\n    /** Determines if the modal is open or not. */\n    open: {\n      type: Boolean,\n      required: true,\n    },\n    /**\n     * Determines if the focused element changes to one inside the modal when it opens. Either the\n     * first element with a positive tabindex or just the first focusable element.\n     */\n    focusOnOpen: {\n      type: Boolean,\n      default: true,\n    },\n    /**\n     * The reference selector of a DOM element to use as reference to position the modal.\n     * This selector can be an ID or a class, if it is a class, it will use the first\n     * element that matches.\n     */\n    referenceSelector: String,\n    /** Animation to use for opening/closing the modal.This animation only affects the content. */\n    animation: {\n      type: AnimationProp,\n      default: () => NoAnimation,\n    },\n    /**\n     * Animation to use for the overlay (backdrop) part of the modal. By default, it uses\n     * a fade transition.\n     */\n    overlayAnimation: {\n      type: AnimationProp,\n      default: () => Fade,\n    },\n    /** Class inherited by content element. */\n    contentClass: String,\n    /** Class inherited by overlay element. */\n    overlayClass: String,\n  },\n  emits: ['click:overlay', 'focusin:body'],\n  setup(props, { emit }) {\n    /** Reference to the modal element in the DOM. */\n    const modalRef = ref<HTMLDivElement>()\n    /** Reference to the modal content element in the DOM. */\n    const modalContentRef = ref<HTMLDivElement>()\n\n    /** The previous value of the body overflow style. */\n    const previousBodyOverflow = ref('')\n    /** The previous value of the HTML element overflow style. */\n    const previousHTMLOverflow = ref('')\n    /** Boolean to delay the leave animation until it has completed. */\n    const isWaitingForLeave = ref(false)\n    /** The reference element to use to find the modal's position. */\n    let referenceElement: HTMLElement | undefined\n\n    /** Disables the scroll of both the body and the window. */\n    function disableScroll() {\n      previousBodyOverflow.value = document.body.style.overflow\n      previousHTMLOverflow.value = document.documentElement.style.overflow\n      document.body.style.overflow = document.documentElement.style.overflow = 'hidden'\n    }\n\n    /** Restores the scroll of both the body and the window. */\n    function enableScroll() {\n      document.body.style.overflow = previousBodyOverflow.value\n      document.documentElement.style.overflow = previousHTMLOverflow.value\n    }\n\n    /**\n     * Emits the `click:overlay` event if the click has been triggered in the overlay layer.\n     *\n     * @param event - The click event.\n     */\n    function emitOverlayClicked(event: Event) {\n      // eslint-disable-next-line vue/custom-event-name-casing\n      emit('click:overlay', event)\n    }\n\n    /**\n     * Emits the `focusin:body` event if a focus event has been triggered outside the modal.\n     *\n     * @param event - The focusin event.\n     */\n    function emitFocusInBody(event: FocusEvent) {\n      if (!modalContentRef.value?.contains(getTargetElement(event))) {\n        // eslint-disable-next-line vue/custom-event-name-casing\n        emit('focusin:body', event)\n      }\n    }\n\n    /**\n     * Adds listeners to the body element ot detect if the modal should be closed.\n     *\n     * @remarks TODO find a better solution and remove the timeout\n     * To avoid emit the focusin on opening X that provokes closing it immediately.\n     * This is because this event was emitted after the open of main modal when the user clicks\n     * on the customer website search box (focus event). This way we avoid add the listener before\n     * the open and the avoid the event that provokes the close.\n     */\n    function addBodyListeners() {\n      setTimeout(() => {\n        document.body.addEventListener('focusin', emitFocusInBody)\n      })\n    }\n\n    /** Removes the body listeners. */\n    function removeBodyListeners() {\n      document.body.removeEventListener('focusin', emitFocusInBody)\n    }\n\n    /**\n     * Sets the focused element to the first element either the first element with a positive\n     * tabindex or, if there isn't any, the first focusable element inside the modal.\n     */\n    function setFocus() {\n      const candidates: HTMLElement[] = Array.from(\n        modalContentRef.value?.querySelectorAll(FOCUSABLE_SELECTORS) ?? [],\n      )\n      const element = candidates.find(element => element.tabIndex) ?? candidates[0]\n      element?.focus()\n    }\n\n    /**\n     * Syncs the body to the open state of the modal, adding or removing styles and listeners.\n     *\n     * @remarks nextTick() to wait for `modalContentRef` to be updated to look for focusable\n     * candidates inside.\n     *\n     * @param isOpen - True when the modal is opened.\n     */\n    async function syncBody(isOpen: boolean) {\n      if (isOpen) {\n        disableScroll()\n        addBodyListeners()\n        if (props.focusOnOpen) {\n          await nextTick()\n          setFocus()\n        }\n      } else {\n        enableScroll()\n        removeBodyListeners()\n      }\n    }\n\n    /**\n     * Updates the position of the modal setting the top of the element depending\n     * on the selector. The modal will be placed under this selector.\n     */\n    const debouncedUpdatePosition = useDebounce(\n      () => {\n        const { height, y } = referenceElement?.getBoundingClientRect() ?? { height: 0, y: 0 }\n        modalRef.value!.style.top = `${height + y}px`\n        modalRef.value!.style.bottom = '0'\n        modalRef.value!.style.height = 'auto'\n      },\n      100,\n      { leading: true },\n    )\n\n    let resizeObserver: ResizeObserver\n\n    onMounted(() => {\n      watch(() => props.open, syncBody)\n      if (props.open) {\n        syncBody(true)\n      }\n\n      resizeObserver = new ResizeObserver(debouncedUpdatePosition)\n\n      watch(\n        () => props.referenceSelector,\n        () => {\n          resizeObserver.disconnect()\n\n          if (props.referenceSelector) {\n            const element = document.querySelector(props.referenceSelector) as HTMLElement\n            if (element) {\n              referenceElement = element\n              resizeObserver.observe(element)\n            }\n          } else {\n            referenceElement = undefined\n            debouncedUpdatePosition()\n          }\n        },\n        { immediate: true },\n      )\n    })\n\n    onBeforeUnmount(() => {\n      if (props.open) {\n        removeBodyListeners()\n        enableScroll()\n      }\n      resizeObserver.disconnect()\n    })\n\n    return {\n      emitOverlayClicked,\n      isWaitingForLeave,\n      modalContentRef,\n      modalRef,\n    }\n  },\n})\n</script>\n\n<style lang=\"css\" scoped>\n.x-modal {\n  position: fixed;\n  top: 0;\n  left: 0;\n  display: flex;\n  align-items: flex-start;\n  justify-content: flex-start;\n  width: 100%;\n  height: 100%;\n  z-index: 1;\n}\n\n.x-modal__content {\n  display: flex;\n  flex-flow: column nowrap;\n  z-index: 1;\n}\n\n.x-modal__overlay {\n  width: 100%;\n  height: 100%;\n  position: absolute;\n  background-color: rgb(0, 0, 0);\n  opacity: 0.3;\n}\n</style>\n\n<docs lang=\"mdx\">\n## Examples\n\nThe `BaseModal` is a simple component that serves to create complex modals. Its open state has to be\npassed via prop. There is a prop, `referenceSelector`, used to place the modal under some element\ninstead of set the top of the element directly. It also accepts an animation to use for opening &\nclosing.\n\nIt emits a `click:overlay` event when any part out of the content is clicked, but only if the modal\nis open.\n\n```vue\n<template>\n  <div>\n    <button @click=\"open = true\">Open modal</button>\n    <BaseModal\n      :animation=\"fadeAndSlide\"\n      :open=\"open\"\n      @click:overlay=\"open = false\"\n      referenceSelector=\".header\"\n    >\n      <h1>Hello</h1>\n      <p>The modal is working</p>\n      <button @click=\"open = false\">Close modal</button>\n    </BaseModal>\n  </div>\n</template>\n\n<script>\nimport { BaseModal, FadeAndSlide } from '@empathyco/x-components'\nimport Vue from 'vue'\n\nVue.component('fadeAndSlide', FadeAndSlide)\n\nexport default {\n  components: {\n    BaseModal,\n  },\n  data() {\n    return {\n      open: false,\n    }\n  },\n}\n</script>\n```\n\n### Customized usage\n\n#### Customizing the content with classes\n\nThe `contentClass` prop can be used to add classes to the modal content.\n\n```vue\n<template>\n  <div>\n    <button @click=\"open = true\">Open modal</button>\n    <BaseModal\n      :animation=\"fadeAndSlide\"\n      :open=\"open\"\n      @click:overlay=\"open = false\"\n      referenceSelector=\".header\"\n      contentClass=\"x-bg-neutral-75\"\n    >\n      <h1>Hello</h1>\n      <p>The modal is working</p>\n      <button @click=\"open = false\">Close modal</button>\n    </BaseModal>\n  </div>\n</template>\n\n<script>\nimport { BaseModal, FadeAndSlide } from '@empathyco/x-components'\nimport Vue from 'vue'\n\nVue.component('fadeAndSlide', FadeAndSlide)\n\nexport default {\n  components: {\n    BaseModal,\n  },\n  data() {\n    return {\n      open: false,\n    }\n  },\n}\n</script>\n```\n\n#### Customizing the overlay with classes\n\nThe `overlayClass` prop can be used to add classes to the modal overlay.\n\n```vue\n<template>\n  <div>\n    <button @click=\"open = true\">Open modal</button>\n    <BaseModal\n      :animation=\"fadeAndSlide\"\n      :open=\"open\"\n      @click:overlay=\"open = false\"\n      referenceSelector=\".header\"\n      overlayClass=\"x-bg-neutral-75\"\n    >\n      <h1>Hello</h1>\n      <p>The modal is working</p>\n      <button @click=\"open = false\">Close modal</button>\n    </BaseModal>\n  </div>\n</template>\n\n<script>\nimport { BaseModal, FadeAndSlide } from '@empathyco/x-components'\nimport Vue from 'vue'\n\nVue.component('fadeAndSlide', FadeAndSlide)\n\nexport default {\n  components: {\n    BaseModal,\n  },\n  data() {\n    return {\n      open: false,\n    }\n  },\n}\n</script>\n```\n\n## Vue Events\n\nA list of events that the component will emit:\n\n- `click:overlay`: the event is emitted after the user clicks any part out of the content but only\n  if the modal is open. The event payload is the mouse event that triggers it.\n- `focusin:body`: the event is emitted after the user focus in any part out of the content but only\n  if the modal is open. The event payload is the focus event that triggers it.\n</docs>\n"],"names":["animation","_withDirectives","_openBlock","_createElementBlock","isWaitingForLeave","_createBlock","_withCtx","_normalizeClass","_renderSlot","_createCommentVNode","_resolveDynamicComponent"],"mappings":";;;;;MACyD,UAAe,GAAA;AAAA,EAAC,GAAA,EAAA,UAAA;AAAA,EAAA,KAAA,EAAA,SAAA;;;AACrE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EAFJ,MAGWA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;SACJC,cAAY,EAAAC,SAAA,EAAA,EAAAC,kBAAA;AAAA,IAAEC,KAAAA;AAAAA,IAAAA,UAAAA;AAAAA,IAAAA;AAAAA,OAAAA,SAAAA,EACH,EAAAC,WAAA;AAAA,QAAED,uBAAAA,CAAAA,IAAAA,CAAAA,SAAAA,CAAAA;AAAAA,QAAAA;AAAAA,UAAAA,aAAAA,EAAAA,MAAAA,CAAAA,CAAAA,CAAAA,KAAAA,MAAAA,CAAAA,CAAAA,CAAAA,GAAAA,CAAAA,MAAAA,KAAAA,IAAAA,CAAAA,iBAAAA,GAAAA,IAAAA,CAAAA;UALpB,YAiBY,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,MAAA,KAAA,IAAA,CAAA,iBAAA,GAAA,KAAA,CAAA;AAAA,SAAA;;AAVN,UAAA,OAAA,EAAAE,OAAA,CAAA,MAAA;AAAA,YAAA,IAAA,CAPN,IASY,IAAAJ,SAAA,EAAA,EAAAC,kBAAA;AAAA,cAAiB,KAAA;AAAA,cAAA;AAAA,gBACrB,GAAK,EAAA,CAAA;AAAA,gBACL,GAAA,EAAA,iBAAA;AAAA,gBACA,OAAKI,cAAQ,CAAA,CAAA,kBAAA,EAAA,IAAA,CAAA,YAAA,CAAA,CAAA;AAAA,gBAAA,WAAA,EAAA,eAAA;AAIb,gBAAA,IAAA,EAAA,QAAA;AAAA,eAAA;;AAhBR,gBAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,SAAA,EAAA,EAAA,EAAA,KAAA,CAAA,EAAA,IAAA,CAAA;AAAA,eAAA;;;AAAA,aAAA,IAAAC,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA;AAAA,WAAA,CAAA;;;;AAAA,QAAA,EAAA;AAAA;AAAA,OA2BQ;AAAA,OAAAP,SAAA,EANU,EAAAG,WAAA,CAAAK,uBAAA,CAAA,IAAA,CAAA,gBAAA,CAAA,EAAA,IAAA,EAAA;AAAA,QADZ,OAAA,EAAAJ,OAAA,CAAA,MAAA;AAAA,UApBN,IAAA,CAAA,IAAA,IAAAJ,SAAA,EAAA,EAAAC,kBAAA;AAAA,YAsBc,KAAA;AAAA,YAAA;AAAA,cAEN,GAAA,EAAA,CAAA;AAAA,cACC,OAAKI,cAAE,CAAA,CAAA,kBAAA,EAAA,IAAA,CAAA,YAAA,CAAA,CAAA;AAAA,cACP,WAAO,EAAA,eAAA;AAAA,cAAA,OAAA,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,kBAAA,IAAA,IAAA,CAAA,kBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AA1BhB,cAAA,SAAA,EAAA,MAAA,CAAA,CAAA,CAAA,KAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,KAAA,IAAA,CAAA,kBAAA,IAAA,IAAA,CAAA,kBAAA,CAAA,GAAA,IAAA,CAAA,CAAA;AAAA,aAAA;;;;AAAA,WAAA,IAAAE,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA;AAAA,SAAA,CAAA;;;;;;;;;;;;;;;"}