yew_hooks/hooks/
use_scroll.rs

1use web_sys::Element;
2use yew::prelude::*;
3
4use super::{use_event, use_mount};
5
6/// A sensor hook that tracks an HTML element's scroll position.
7///
8/// # Example
9///
10/// ```rust
11/// # use yew::prelude::*;
12/// #
13/// use yew_hooks::prelude::*;
14///
15/// #[function_component(UseScroll)]
16/// fn scroll() -> Html {
17///     let node = use_node_ref();
18///     let state = use_scroll(node.clone());
19///     
20///     html! {
21///         <div ref={node}>
22///             <b>{ " X: " }</b>
23///             { state.0 }
24///             <b>{ " Y: " }</b>
25///             { state.1 }
26///         </div>
27///     }
28/// }
29/// ```
30#[hook]
31pub fn use_scroll(node: NodeRef) -> (i32, i32) {
32    let state = use_state(|| (0, 0));
33
34    {
35        let state = state.clone();
36        let node = node.clone();
37        use_event(node, "scroll", move |e: Event| {
38            let element: Element = e.target_unchecked_into();
39            state.set((element.scroll_left(), element.scroll_top()));
40        });
41    }
42
43    {
44        let state = state.clone();
45        use_mount(move || {
46            if let Some(element) = node.cast::<Element>() {
47                state.set((element.scroll_left(), element.scroll_top()));
48            }
49        });
50    }
51
52    *state
53}
yew_hooks/hooks/use_scroll.rs

yew_hooks/hooks/
use_scroll.rs
