leptos-use/src/use_window_focus.rs

48 lines
1.2 KiB
Rust
Raw Normal View History

2023-07-14 22:43:19 +01:00
#![cfg_attr(feature = "ssr", allow(unused_variables, unused_imports))]
2023-07-07 16:38:03 +01:00
use crate::use_event_listener;
2023-07-14 22:43:19 +01:00
use cfg_if::cfg_if;
2023-07-07 16:38:03 +01:00
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]
2023-07-27 18:06:36 +01:00
/// # fn Demo() -> impl IntoView {
/// let focused = use_window_focus();
2023-07-07 16:38:03 +01:00
/// #
2023-07-27 18:06:36 +01:00
/// # view! { }
2023-07-07 16:38:03 +01:00
/// # }
/// ```
2023-07-14 22:43:19 +01:00
///
/// ## Server-Side Rendering
///
/// On the server this returns a `Signal` that is always `true`.
2023-07-27 18:06:36 +01:00
pub fn use_window_focus() -> Signal<bool> {
2023-07-14 22:43:19 +01:00
cfg_if! { if #[cfg(feature = "ssr")] {
let initial_focus = true;
} else {
let initial_focus = document().has_focus().unwrap_or_default();
}}
2023-07-27 18:06:36 +01:00
let (focused, set_focused) = create_signal(initial_focus);
2023-07-07 16:38:03 +01:00
2023-07-14 22:43:19 +01:00
cfg_if! { if #[cfg(not(feature = "ssr"))] {
2023-07-27 18:06:36 +01:00
let _ = use_event_listener(window(), blur, move |_| set_focused.set(false));
let _ = use_event_listener(window(), focus, move |_| set_focused.set(true));
2023-07-14 22:43:19 +01:00
}}
2023-07-07 16:38:03 +01:00
focused.into()
}