leptos_use/
use_document_visibility.rs

1#![cfg_attr(feature = "ssr", allow(unused_variables, unused_imports))]
2
3use crate::use_event_listener;
4use cfg_if::cfg_if;
5use leptos::ev::visibilitychange;
6use leptos::prelude::*;
7use leptos::reactive::wrappers::read::Signal;
8
9/// Reactively track `document.visibilityState`
10///
11/// ## Demo
12///
13/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_document_visibility)
14///
15/// ## Usage
16///
17/// ```
18/// # use leptos::prelude::*;
19/// # use leptos_use::use_document_visibility;
20/// #
21/// # #[component]
22/// # fn Demo() -> impl IntoView {
23/// let visibility = use_document_visibility();
24/// #
25/// # view! { }
26/// # }
27/// ```
28///
29/// ## Server-Side Rendering
30///
31/// On the server this returns a `Signal` that always contains the value `web_sys::VisibilityState::Hidden`.
32pub fn use_document_visibility() -> Signal<web_sys::VisibilityState> {
33    cfg_if! { if #[cfg(feature = "ssr")] {
34        let inital_visibility = web_sys::VisibilityState::Hidden;
35    } else {
36        let inital_visibility = document().visibility_state();
37    }}
38
39    let (visibility, set_visibility) = signal(inital_visibility);
40
41    cfg_if! { if #[cfg(not(feature = "ssr"))] {
42        let _ = use_event_listener(document(), visibilitychange, move |_| {
43            set_visibility.set(document().visibility_state());
44        });
45    }}
46
47    visibility.into()
48}
leptos_use/use_document_visibility.rs

leptos_use/
use_document_visibility.rs
