From e8f92eb351b8de15708ca8dfa431c5e5b47f25ec Mon Sep 17 00:00:00 2001
From: Andrew Beng <2418932+andrewbeng89@users.noreply.github.com>
Date: Fri, 21 Feb 2025 02:11:54 +0100
Subject: [PATCH] Fix/616 vue custom event listeners (#617)

* fix(vue): shift event listener logic from directive to onMounted

* fix(vue): remove lower case event naming

* tests(vue): for custom event handler and v-model directive

* test(vue): include coverage for custom event handler for input component
---
 example-project/vue-app/src/App.vue           |  9 +++++++
 .../vue-app/src/components/Input.vue          | 16 ++++--------
 example-project/vue-app/tests/test.e2e.ts     |  7 ++++-
 packages/vue/src/runtime.ts                   | 26 ++++++++++---------
 4 files changed, 34 insertions(+), 24 deletions(-)

diff --git a/example-project/vue-app/src/App.vue b/example-project/vue-app/src/App.vue
index 548391f2..0f6bead6 100644
--- a/example-project/vue-app/src/App.vue
+++ b/example-project/vue-app/src/App.vue
@@ -2,6 +2,13 @@
 import HelloWorld from './components/HelloWorld.vue'
 // @ts-ignore
 import Input from './components/Input.vue'
+import { MyComponent } from 'component-library-vue'
+import { ref } from 'vue'
+
+const isClicked = ref(false)
+const handleCustomEvent = () => {
+  isClicked.value = true
+}
 </script>
 
 <template>
@@ -14,6 +21,8 @@ import Input from './components/Input.vue'
     </a>
   </div>
   <HelloWorld msg="Vite + Vue" />
+  <MyComponent @myCustomEvent="handleCustomEvent" />
+  <p data-testid="mycomponent-click" v-show="isClicked">MyComponent was clicked</p>
   <Input />
 </template>
 
diff --git a/example-project/vue-app/src/components/Input.vue b/example-project/vue-app/src/components/Input.vue
index 3a88e54a..3b12afd4 100644
--- a/example-project/vue-app/src/components/Input.vue
+++ b/example-project/vue-app/src/components/Input.vue
@@ -8,24 +8,18 @@ export default defineComponent({
     MyInput,
   },
   setup() {
-    const inputEvent = ref('');
+    const inputValue = ref('');
     const changeEvent = ref('');
 
-    const handleInput = (ev) => {
-      console.log('handleInput', ev.target.value);
-      inputEvent.value = ev.target.value;
-    };
-
     const handleChange = (ev) => {
       console.log('handleChange', ev.target.value);
       changeEvent.value = ev.detail.value;
     };
 
     return {
-      inputEvent,
+      inputValue,
       changeEvent,
-      handleInput,
-      handleChange,
+      handleChange
     };
   },
 });
@@ -40,12 +34,12 @@ export default defineComponent({
 <template>
   <div>
     <MyInput
-      @myInput="handleInput"
+      v-model="inputValue"
       @myChange="handleChange"
     >
     </MyInput>
     <div class="inputResult">
-      <p>Input Event: {{ inputEvent }}</p>
+      <p>Input v-model: {{ inputValue }}</p>
       <p>Change Event: {{ changeEvent }}</p>
     </div>
   </div>
diff --git a/example-project/vue-app/tests/test.e2e.ts b/example-project/vue-app/tests/test.e2e.ts
index 2bd001e7..c707b47f 100644
--- a/example-project/vue-app/tests/test.e2e.ts
+++ b/example-project/vue-app/tests/test.e2e.ts
@@ -8,8 +8,13 @@ describe('Stencil Vue Integration', () => {
   it('should allow to interact with input element', async () => {
     await $('my-input').$('input').setValue('Hello World');
     await expect(await $$('.inputResult p').map((p) => p.getText())).toEqual([
-      'Input Event: Hello World',
+      'Input v-model: Hello World',
       'Change Event: Hello World'
     ]);
   });
+
+  it('should listen to custom events', async () => {
+    await $('my-component').$('div').click();
+    await expect(await $('[data-testid="mycomponent-click"]').getText()).toEqual('MyComponent was clicked');
+  });
 });
diff --git a/packages/vue/src/runtime.ts b/packages/vue/src/runtime.ts
index 93b7085b..1692120c 100644
--- a/packages/vue/src/runtime.ts
+++ b/packages/vue/src/runtime.ts
@@ -1,4 +1,4 @@
-import { defineComponent, getCurrentInstance, h, inject, ref, Ref, withDirectives } from 'vue';
+import { defineComponent, getCurrentInstance, h, inject, onMounted, ref, Ref, withDirectives } from 'vue';
 
 export { defineStencilSSRComponent } from './ssr';
 export interface InputProps<T> {
@@ -81,6 +81,18 @@ export const defineContainer = <Props, VModelType = string | number | boolean>(
     const containerRef = ref<HTMLElement>();
     const classes = new Set(getComponentClasses(attrs.class));
 
+    onMounted(() => {
+      /**
+       * we register the event emmiter for @Event definitions
+       * so we can use @event
+       */
+      emitProps.forEach((eventName: string) => {
+        containerRef.value!.addEventListener(eventName, (e: Event) => {
+          emit(eventName, e);
+        });
+      });
+    });
+
     /**
      * This directive is responsible for updating any reactive
      * reference associated with v-model on the component.
@@ -95,7 +107,7 @@ export const defineContainer = <Props, VModelType = string | number | boolean>(
       created: (el: HTMLElement) => {
         const eventsNames = Array.isArray(modelUpdateEvent) ? modelUpdateEvent : [modelUpdateEvent];
         eventsNames.forEach((eventName: string) => {
-          el.addEventListener(eventName.toLowerCase(), (e: Event) => {
+          el.addEventListener(eventName, (e: Event) => {
             /**
              * Only update the v-model binding if the event's target is the element we are
              * listening on. For example, Component A could emit ionChange, but it could also
@@ -109,16 +121,6 @@ export const defineContainer = <Props, VModelType = string | number | boolean>(
             }
           });
         });
-
-        /**
-         * we register the event emmiter for @Event definitions
-         * so we can use @event
-         */
-        emitProps.forEach((eventName: string) => {
-          el.addEventListener(eventName, (e: Event) => {
-            emit(eventName, e);
-          });
-        });
       },
     };