leptos_use/
use_window_focus.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#![cfg_attr(feature = "ssr", allow(unused_variables, unused_imports))]

use crate::use_event_listener;
use cfg_if::cfg_if;
use leptos::ev::{blur, focus};
use leptos::*;

/// Reactively track window focus
/// with `window.onfocus` and `window.onblur` events.
///
/// ## Demo
///
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_window_focus)
///
/// ## Usage
///
/// ```
/// # use leptos::*;
/// # use leptos_use::use_window_focus;
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let focused = use_window_focus();
/// #
/// # view! { }
/// # }
/// ```
///
/// ## Server-Side Rendering
///
/// On the server this returns a `Signal` that is always `true`.
pub fn use_window_focus() -> Signal<bool> {
    cfg_if! { if #[cfg(feature = "ssr")] {
        let initial_focus = true;
    } else {
        let initial_focus = document().has_focus().unwrap_or_default();
    }}

    let (focused, set_focused) = create_signal(initial_focus);

    cfg_if! { if #[cfg(not(feature = "ssr"))] {
        let _ = use_event_listener(window(), blur, move |_| set_focused.set(false));
        let _ = use_event_listener(window(), focus, move |_| set_focused.set(true));
    }}

    focused.into()
}