Skip to content

docs: add note to ElementExt::on about dropping the handle #3544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add note to ElementExt::on about dropping the handle #3544

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions tachys/src/html/element/element_ext.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<E>(
&self,
ev: E,
Expand Down
Loading