From bb60556f295ff1c1524cddefb37bc5833c3c4be9 Mon Sep 17 00:00:00 2001
From: Jeremy Wall <jeremy@marzhillstudios.com>
Date: Mon, 13 Nov 2023 18:50:24 -0500
Subject: [PATCH] docs: Update docs with event handling information.

---
 wasm-web-component/src/lib.rs | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/wasm-web-component/src/lib.rs b/wasm-web-component/src/lib.rs
index a3cbcfa..57064e1 100644
--- a/wasm-web-component/src/lib.rs
+++ b/wasm-web-component/src/lib.rs
@@ -16,7 +16,8 @@ use web_sys::{window, Element, Event, HtmlElement, Window};
 /// It supports three optional attributes `name = value` parameters.
 /// * `class_name = "ClassName"` - The class name to use for the javascript shim. If not provided uses the structs name instead.
 /// * `element_name = "class-name"` - A valid custom element name to use for the element. if not proviced derives it from the class name.
-/// * `observed_attrs = "['attr1', attr2']"` - A javascript array with a list of observed attributes for this compoment. Defaults to "[]".
+/// * `observed_attrs = "['attr1', 'attr2']"` - A javascript array with a list of observed attributes for this compoment. Defaults to "[]".
+/// * `observed_events = "['click', 'change']"` - A javascript array with a list of observed event types for this compoment. Defaults to "[]".
 ///
 /// It will also create a `Self::define_once` method that will define the WebComponent exactly
 /// once.
@@ -28,6 +29,7 @@ use web_sys::{window, Element, Event, HtmlElement, Window};
 ///     class_name = "MyElement",
 ///     element_name = "my-element",
 ///     observed_attrs = "['class']"
+///     observed_events = "['click']"
 /// )]
 /// pub struct MyElementImpl {}
 /// 
@@ -65,6 +67,10 @@ use web_sys::{window, Element, Event, HtmlElement, Window};
 ///         )));
 ///         element.append_child(&node).unwrap();
 ///     }
+///
+///     fn handle_event(&self, element: &HtmlElement, event: &Event)) {
+///         // handle this event
+///     }
 /// }
 ///
 /// pub fn define_me() {
@@ -177,7 +183,7 @@ pub trait WebComponentBinding: WebComponentDef {
         // noop
     }
 
-    /// Top level event handler for this custome element.
+    /// Top level event handler for this custom element.
     fn handle_event(&self, _element: &HtmlElement, _event: &Event) {
         // noop
     }
@@ -414,6 +420,8 @@ mod tests {
         assert_eq!(ThisElement::element_name(), "this-old-element");
     }
 
+    // TODO(jwall): Tests for event handling
+
     // TODO(jwall): Benchmarks for TemplateElements?
     #[cfg(feature = "HtmlTemplateElement")]
     #[wasm_bindgen_test]