pub fn use_on_destroy<D: FnOnce() + 'static>(cx: &ScopeState, destroy: D)
Expand description

Creates a callback that will be run before the component is removed. This can be used to clean up side effects from the component (created with use_effect).

Example:

use dioxus::prelude::*;

fn app(cx: Scope) -> Element {
    let state = use_state(cx, || true);
    render! {
        for _ in 0..100 {
            h1 {
                "spacer"
            }
        }
        if **state {
            render! {
                child_component {}
            }
        }
        button {
            onclick: move |_| {
                state.set(!*state.get());
            },
            "Unmount element"
        }
    }
}

fn child_component(cx: Scope) -> Element {
    let original_scroll_position = use_state(cx, || 0.0);
    use_effect(cx, (), move |_| {
        to_owned![original_scroll_position];
        async move {
            let window = web_sys::window().unwrap();
            let document = window.document().unwrap();
            let element = document.get_element_by_id("my_element").unwrap();
            element.scroll_into_view();
            original_scroll_position.set(window.scroll_y().unwrap());
        }
    });

    use_on_destroy(cx, {
        to_owned![original_scroll_position];
        /// restore scroll to the top of the page
        move || {
            let window = web_sys::window().unwrap();
            window.scroll_with_x_and_y(*original_scroll_position.current(), 0.0);
        }
    });

    render!{
        div {
            id: "my_element",
            "hello"
        }
    }
}