Listen for events using visitModal()

pascalbaljet · pascalbaljet · commit a306edb33d1c · 2024-10-31T23:44:37.000+01:00
See #17
diff --git a/demo-app/resources/js/Pages/Visit.jsx b/demo-app/resources/js/Pages/Visit.jsx
@@ -8,6 +8,17 @@ export default function Visit() {
         visitModal('#local');
     };
 
+    const visitEdit = () => {
+        visitModal('/users/1/edit', {
+            navigate: true,
+            listeners: {
+                userGreets: function (greeting) {
+                    alert(greeting);
+                }
+            }
+        })
+    }
+
     return (
         <>
             <Container>
@@ -19,7 +30,7 @@ export default function Visit() {
                     <button onClick={() => visitModal('/data', { method: 'post', data: { message: 'Hi again!' } })} type="button">
                         Open Route Modal
                     </button>
-                    <button onClick={() => visitModal('/users/1/edit', { navigate: true })} type="button">
+                    <button onClick={visitEdit} type="button">
                         Open Route Modal With Navigate
                     </button>
                 </div>
diff --git a/demo-app/resources/js/Pages/Visit.vue b/demo-app/resources/js/Pages/Visit.vue
@@ -1,6 +1,17 @@
 <script setup>
 import Container from './Container.vue'
 import { Modal, visitModal } from '@inertiaui/modal-vue'
+
+function visitEdit() {
+    visitModal('/users/1/edit', {
+        navigate: true,
+        listeners: {
+            userGreets(greeting) {
+                alert(greeting);
+            }
+        }
+    })
+}
 </script>
 
 <template>
@@ -16,7 +27,7 @@ import { Modal, visitModal } from '@inertiaui/modal-vue'
                 Open Route Modal
             </button>
 
-            <button @click="visitModal('/users/1/edit', { navigate: true })" type="button">
+            <button @click="visitEdit" type="button">
                 Open Route Modal With Navigate
             </button>
         </div>
diff --git a/demo-app/tests/Browser/EmitTest.php b/demo-app/tests/Browser/EmitTest.php
@@ -26,6 +26,21 @@ public function it_can_dispatch_an_event_from_the_modal_to_the_modal_link(bool $
         });
     }
 
+    #[DataProvider('booleanProvider')]
+    #[Test]
+    public function it_can_dispatch_an_event_from_the_modal_to_the_visit_modal_method(bool $navigate)
+    {
+        $this->browse(function (Browser $browser) use ($navigate) {
+            $browser->visit('/visit'.($navigate ? '?navigate=1' : ''))
+                ->waitForText('Visit programmatically')
+                ->press('Open Route Modal With Navigate')
+                ->waitFor('.im-modal-content')
+                ->clickLink('Send Message', 'button')
+                ->assertDialogOpened('Hello from EditUser')
+                ->dismissDialog();
+        });
+    }
+
     #[DataProvider('booleanProvider')]
     #[Test]
     public function it_can_dispatch_events_back_and_forth_between_nested_modals(bool $navigate)
diff --git a/docs/basic-usage.md b/docs/basic-usage.md
@@ -329,6 +329,7 @@ visitModal('/users/create', {
     config: {
         slideover: true,
     }
+    listeners: {},
     onClose: () => console.log('Modal closed'),
     onAfterLeave: () => console.log('Modal removed from DOM'),
     queryStringArrayFormat: 'brackets',
diff --git a/docs/event-bus.md b/docs/event-bus.md
@@ -72,7 +72,7 @@ export default function MyPage() {
 
 :::
 
-On the parent page, you can listen to the event like this:
+On the parent page, you can listen to the event on the `ModalLink` component:
 
 ::: code-group
 
@@ -98,7 +98,17 @@ export default function MyPage() {
 }
 ```
 
-:::
+If you're [programmatically opening the modal](/basic-usage.html#programmatic-usage), you add listeners using the `listeners` option:
+
+```js
+visitModal('/users/create', {
+    listeners: {
+        increaseBy(amount) {
+            console.log(`Increase by ${amount}`);
+        }
+    }
+})
+```
 
 ## Nested / Stacked Modals
 
diff --git a/react/src/ModalRoot.jsx b/react/src/ModalRoot.jsx
@@ -1,6 +1,6 @@
 import { createElement, useEffect, useState, useRef } from 'react'
 import { default as Axios } from 'axios'
-import { except, only } from './helpers'
+import { except, only, kebabCase } from './helpers'
 import { router, usePage } from '@inertiajs/react'
 import { mergeDataIntoQueryString } from '@inertiajs/core'
 import { createContext, useContext } from 'react'
@@ -164,11 +164,13 @@ export const ModalStackProvider = ({ children }) => {
         }
 
         on = (event, callback) => {
+            event = kebabCase(event)
             this.listeners[event] = this.listeners[event] ?? []
             this.listeners[event].push(callback)
         }
 
         off = (event, callback) => {
+            event = kebabCase(event)
             if (callback) {
                 this.listeners[event] = this.listeners[event]?.filter((cb) => cb !== callback) ?? []
             } else {
@@ -177,7 +179,7 @@ export const ModalStackProvider = ({ children }) => {
         }
 
         emit = (event, ...args) => {
-            this.listeners[event]?.forEach((callback) => callback(...args))
+            this.listeners[kebabCase(event)]?.forEach((callback) => callback(...args))
         }
 
         registerEventListenersFromProps = (props) => {
@@ -187,14 +189,9 @@ export const ModalStackProvider = ({ children }) => {
                 .filter((key) => key.startsWith('on'))
                 .forEach((key) => {
                     // e.g. onRefreshKey -> refresh-key
-                    const snakeCaseKey = key
-                        .replace(/^on/, '')
-                        .replace(/^./, (firstLetter) => firstLetter.toLowerCase())
-                        .replace(/([A-Z])/g, '-$1')
-                        .toLowerCase()
-
-                    this.on(snakeCaseKey, props[key])
-                    unsubscribers.push(() => this.off(snakeCaseKey, props[key]))
+                    const eventName = kebabCase(key).replace(/^on-/, '')
+                    this.on(eventName, props[key])
+                    unsubscribers.push(() => this.off(eventName, props[key]))
                 })
 
             return () => unsubscribers.forEach((unsub) => unsub())
@@ -274,7 +271,17 @@ export const ModalStackProvider = ({ children }) => {
             options.onAfterLeave,
             options.queryStringArrayFormat ?? 'brackets',
             options.navigate ?? getConfig('navigate'),
-        )
+        ).then((modal) => {
+            const listeners = options.listeners ?? {}
+
+            Object.keys(listeners).forEach((event) => {
+                // e.g. refreshKey -> refresh-key
+                const eventName = kebabCase(event)
+                modal.on(eventName, listeners[event])
+            })
+
+            return modal
+        })
 
     const visit = (
         href,
diff --git a/react/src/helpers.js b/react/src/helpers.js
@@ -1,2 +1,2 @@
-import { except, only, rejectNullValues, waitFor } from './../../vue/src/helpers.js'
-export { except, only, rejectNullValues, waitFor }
+import { except, only, rejectNullValues, waitFor, kebabCase } from './../../vue/src/helpers.js'
+export { except, only, rejectNullValues, waitFor, kebabCase }
diff --git a/vue/src/helpers.js b/vue/src/helpers.js
@@ -63,4 +63,30 @@ function waitFor(conditionFn, waitForSeconds = 3, checkIntervalMilliseconds = 10
     })
 }
 
-export { except, only, rejectNullValues, waitFor }
+function kebabCase(string) {
+    if (!string) return ''
+
+    // Replace all underscores with hyphens
+    string = string.replace(/_/g, '-')
+
+    // Replace all multiple consecutive hyphens with a single hyphen
+    string = string.replace(/-+/g, '-')
+
+    // Check if string is already all lowercase
+    if (!/[A-Z]/.test(string)) {
+        return string
+    }
+
+    // Remove all spaces and convert to word case
+    string = string
+        .replace(/\s+/g, '')
+        .replace(/_/g, '')
+        .replace(/(?:^|\s|-)+([A-Za-z])/g, (m, p1) => p1.toUpperCase())
+
+    // Add delimiter before uppercase letters
+    string = string.replace(/(.)(?=[A-Z])/g, '$1-')
+
+    // Convert to lowercase
+    return string.toLowerCase()
+}
+export { except, only, rejectNullValues, waitFor, kebabCase }
diff --git a/vue/src/inertiauiModal.js b/vue/src/inertiauiModal.js
@@ -7,17 +7,29 @@ import ModalRoot from './ModalRoot.vue'
 import useModal from './useModal.js'
 
 function visitModal(url, options = {}) {
-    return useModalStack().visit(
-        url,
-        options.method ?? 'get',
-        options.data ?? {},
-        options.headers ?? {},
-        options.config ?? {},
-        options.onClose,
-        options.onAfterLeave,
-        options.queryStringArrayFormat ?? 'brackets',
-        options.navigate ?? getConfig('navigate'),
-    )
+    return useModalStack()
+        .visit(
+            url,
+            options.method ?? 'get',
+            options.data ?? {},
+            options.headers ?? {},
+            options.config ?? {},
+            options.onClose,
+            options.onAfterLeave,
+            options.queryStringArrayFormat ?? 'brackets',
+            options.navigate ?? getConfig('navigate'),
+        )
+        .then((modal) => {
+            const listeners = options.listeners ?? {}
+
+            Object.keys(listeners).forEach((event) => {
+                // e.g. refreshKey -> refresh-key
+                const eventName = event.replace(/([A-Z])/g, '-$1').toLowerCase()
+                modal.on(eventName, listeners[event])
+            })
+
+            return modal
+        })
 }
 
 export { HeadlessModal, Modal, ModalLink, ModalRoot, getConfig, putConfig, resetConfig, visitModal, renderApp, useModal }
diff --git a/vue/src/modalStack.js b/vue/src/modalStack.js
@@ -1,5 +1,5 @@
 import { computed, readonly, ref, markRaw, nextTick, h } from 'vue'
-import { except, only, waitFor } from './helpers'
+import { except, only, waitFor, kebabCase } from './helpers'
 import { router } from '@inertiajs/vue3'
 import { usePage } from '@inertiajs/vue3'
 import { mergeDataIntoQueryString } from '@inertiajs/core'
@@ -143,11 +143,13 @@ class Modal {
     }
 
     on = (event, callback) => {
+        event = kebabCase(event)
         this.listeners[event] = this.listeners[event] ?? []
         this.listeners[event].push(callback)
     }
 
     off = (event, callback) => {
+        event = kebabCase(event)
         if (callback) {
             this.listeners[event] = this.listeners[event]?.filter((cb) => cb !== callback) ?? []
         } else {
@@ -156,7 +158,7 @@ class Modal {
     }
 
     emit = (event, ...args) => {
-        this.listeners[event]?.forEach((callback) => callback(...args))
+        this.listeners[kebabCase(event)]?.forEach((callback) => callback(...args))
     }
 
     registerEventListenersFromAttrs = ($attrs) => {
@@ -165,15 +167,9 @@ class Modal {
         Object.keys($attrs)
             .filter((key) => key.startsWith('on'))
             .forEach((key) => {
-                // e.g. onRefreshKey -> refresh-key
-                const snakeCaseKey = key
-                    .replace(/^on/, '')
-                    .replace(/^./, (firstLetter) => firstLetter.toLowerCase())
-                    .replace(/([A-Z])/g, '-$1')
-                    .toLowerCase()
-
-                this.on(snakeCaseKey, $attrs[key])
-                unsubscribers.push(() => this.off(snakeCaseKey, $attrs[key]))
+                const eventName = kebabCase(key).replace(/^on-/, '')
+                this.on(eventName, $attrs[key])
+                unsubscribers.push(() => this.off(eventName, $attrs[key]))
             })
 
         return () => unsubscribers.forEach((unsub) => unsub())
diff --git a/vue/tests/helpers.test.js b/vue/tests/helpers.test.js
@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest'
-import { except, only, rejectNullValues } from '../src/helpers'
+import { except, only, rejectNullValues, kebabCase } from '../src/helpers'
 
 describe('helpers', () => {
     describe('except', () => {
@@ -97,4 +97,27 @@ describe('helpers', () => {
             expect(rejectNullValues(arr)).toEqual([])
         })
     })
+
+    describe('kebabCase', () => {
+        it.each([
+            // Basic camelCase/PascalCase
+            ['camelCase', 'camel-case'],
+            ['ThisIsPascalCase', 'this-is-pascal-case'],
+
+            // With numbers
+            ['user123Name', 'user123-name'],
+            ['FirstName1', 'first-name1'],
+
+            // With acronyms
+            ['parseXMLDocument', 'parse-x-m-l-document'],
+
+            // Mixed cases and special chars
+            ['snake_case_value', 'snake-case-value'],
+            ['already-kebab-case', 'already-kebab-case'],
+            ['UPPERCASE', 'u-p-p-e-r-c-a-s-e'],
+            ['multiple__underscores', 'multiple-underscores'],
+        ])('should convert %s to %s', (input, expected) => {
+            expect(kebabCase(input)).toBe(expected)
+        })
+    })
 })

Original file line number	Diff line number	Diff line change
`@@ -329,6 +329,7 @@ visitModal('/users/create', {`
`329`	`329`	`config: {`
`330`	`330`	`slideover: true,`
`331`	`331`	`}`
	`332`	`+ listeners: {},`
`332`	`333`	`onClose: () => console.log('Modal closed'),`
`333`	`334`	`onAfterLeave: () => console.log('Modal removed from DOM'),`
`334`	`335`	`queryStringArrayFormat: 'brackets',`