From d6c63c026968c7692ec8642a991a0ab774a2b8fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20Schl=C3=BCter?= Date: Mon, 3 Feb 2025 22:51:50 +0100 Subject: [PATCH] docs: add note to ElementExt::on about dropping the handle --- tachys/src/html/element/element_ext.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tachys/src/html/element/element_ext.rs b/tachys/src/html/element/element_ext.rs index b259d7f9a1..370f199baa 100644 --- a/tachys/src/html/element/element_ext.rs +++ b/tachys/src/html/element/element_ext.rs @@ -44,6 +44,14 @@ pub trait ElementExt { S: IntoStyle; /// Adds an event listener to the element, at runtime. + /// + /// Dropping the returned handle also drops the closure and invalidates the event listener. + /// Consider using [on_cleanup](reactive_graph::owner::Owner::on_cleanup) to delay dropping: + /// + /// ```rust,ignore + /// let remove = element.on(ev::blur, move |_| /* ... */); + /// on_cleanup(move || std::mem::drop(remove)); + /// ``` fn on( &self, ev: E,