Struct dioxus_core::prelude::EventHandler

pub struct EventHandler<'bump, T = ()> {
    pub callback: RefCell<Option<BumpBox<'bump, dyn FnMut(T) + 'bump>>>,
}

The callback type generated by the rsx! macro when an on field is specified for components.

This makes it possible to pass move |evt| {} style closures into components as property fields.

Example

rsx!{
    MyComponent { onclick: move |evt| log::info!("clicked"), }
}

#[derive(Props)]
struct MyProps<'a> {
    onclick: EventHandler<'a, MouseEvent>,
}

fn MyComponent(cx: Scope<'a, MyProps<'a>>) -> Element {
    cx.render(rsx!{
        button {
            onclick: move |evt| cx.props.onclick.call(evt),
        }
    })
}

Fields

callback: RefCell<Option<BumpBox<'bump, dyn FnMut(T) + 'bump>>>

The (optional) callback that the user specified Uses a RefCell to allow for interior mutability, and FnMut closures.

Implementations

impl<T> EventHandler<'_, T>

pub fn call(&self, event: T)

Call this event handler with the appropriate event type

pub fn release(&self)

Forcibly drop the internal handler callback, releasing memory

Trait Implementations

impl<'a, T> Default for EventHandler<'a, T>

fn default() -> Self

Returns the “default value” for a type.