Merge pull request #59 from maartenbreddels/feat_trigger_click

feat: .click convenience function to trigger a click event

Author: maartenbreddels

ipyvue/VueWidget.py

@@ -101,6 +101,23 @@ def on_event(self, event_and_modifiers, callback, remove=False):
 
     def fire_event(self, event, data=None):
         """Manually trigger an event handler on the Python side."""
+        # note that a click event will trigger click.stop if that particular
+        # event+modifier is registered.
+        event_match = [k for k in self._event_handlers_map.keys() if k.startswith(event)]
+        if not event_match:
+            raise ValueError(f"'{event}' not found in widget {self}")
+
+        self._fire_event(event_match[0], data)
+
+    def click(self, data=None):
+        """Manually triggers the event handler for the 'click' event
+
+        Note that this does not trigger a click event in the browser, this only
+        invokes the Python event handlers.
+        """
+        self.fire_event("click", data or {})
+
+    def _fire_event(self, event, data=None):
         dispatcher = self._event_handlers_map[event]
         # we don't call via the dispatcher, since that eats exceptions
         for callback in dispatcher.callbacks:
@@ -109,7 +126,7 @@ def fire_event(self, event, data=None):
     def _handle_event(self, _, content, buffers):
         event = content.get("event", "")
         data = content.get("data", {})
-        self.fire_event(event, data)
+        self._fire_event(event, data)
 
 
 class VueWidget(DOMWidget, Events):

tests/test_vue_widget.py

@@ -1,3 +1,5 @@
+from unittest.mock import MagicMock
+
 from ipyvue import VueWidget
 
 
@@ -58,3 +60,20 @@ def test_show(self):
         test_widget.class_list.add(self.CLASS, "d-none")
         test_widget.show()
         assert "d-none" not in test_widget.class_
+
+
+def test_event_handling():
+    event_handler = MagicMock()
+    button = VueWidget()
+    button.on_event("click.stop", event_handler)
+    button.fire_event("click.stop", {"foo": "bar"})
+    event_handler.assert_called_once_with(button, "click.stop", {"foo": "bar"})
+
+    event_handler.reset_mock()
+    button.click({"foo": "bar"})
+    event_handler.assert_called_once_with(button, "click.stop", {"foo": "bar"})
+
+    # test the code path as if it's coming from the frontend
+    event_handler.reset_mock()
+    button._handle_event(None, dict(event="click.stop", data={"foo": "bar"}), [])
+    event_handler.assert_called_once_with(button, "click.stop", {"foo": "bar"})