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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
use crate::core::now;
use crate::filter_builder_methods;
use crate::utils::{DebounceOptions, FilterOptions, ThrottleOptions};
use cfg_if::cfg_if;
use default_struct_builder::DefaultBuilder;
use leptos::*;
///
///
/// ## Demo
///
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_idle)
///
/// ## Usage
///
/// ```
/// # use leptos::*;
/// # use leptos::logging::log;
/// # use leptos_use::{use_idle, UseIdleReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseIdleReturn {
/// idle, last_active, ..
/// } = use_idle(5 * 60 * 1000); // 5 minutes
///
/// log!("{}", idle.get()); // true or false
/// #
/// # view! { }
/// # }
/// ```
///
/// Programatically resetting:
///
/// ```
/// # use std::time::Duration;
/// use leptos::*;
/// # use leptos::logging::log;
/// # use leptos_use::{use_idle, UseIdleReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseIdleReturn {
/// idle, last_active, reset
/// } = use_idle(5 * 60 * 1000); // 5 minutes
///
/// reset(); // restarts the idle timer. Does not change the `last_active` value.
/// #
/// # view! { }
/// # }
/// ```
///
/// ## Server-Side Rendering
///
/// On the server this will always return static signals
///
/// ```ignore
/// UseIdleReturn{
/// idle: Signal(initial_state),
/// last_active: Signal(now),
/// reset: || {}
/// }
/// ```
pub fn use_idle(timeout: u64) -> UseIdleReturn<impl Fn() + Clone> {
use_idle_with_options(timeout, UseIdleOptions::default())
}
/// Version of [`use_idle`] that takes a `UseIdleOptions`. See [`use_idle`] for how to use.
pub fn use_idle_with_options(
timeout: u64,
options: UseIdleOptions,
) -> UseIdleReturn<impl Fn() + Clone> {
let UseIdleOptions {
events,
listen_for_visibility_change,
initial_state,
filter,
} = options;
let (idle, set_idle) = create_signal(initial_state);
let (last_active, set_last_active) = create_signal(now());
cfg_if! { if #[cfg(feature = "ssr")] {
let reset = || ();
let _ = timeout;
let _ = events;
let _ = listen_for_visibility_change;
let _ = filter;
let _ = set_last_active;
let _ = set_idle;
} else {
use crate::utils::create_filter_wrapper;
use crate::{
use_document, use_event_listener, use_event_listener_with_options, UseEventListenerOptions,
};
use leptos::ev::{visibilitychange, Custom};
use leptos::leptos_dom::helpers::TimeoutHandle;
use std::cell::Cell;
use std::rc::Rc;
use std::time::Duration;
let timer = Rc::new(Cell::new(None::<TimeoutHandle>));
let reset = {
let timer = Rc::clone(&timer);
move || {
set_idle.set(false);
if let Some(timer) = timer.replace(
set_timeout_with_handle(move || set_idle.set(true), Duration::from_millis(timeout))
.ok(),
) {
timer.clear();
}
}
};
let on_event = {
let reset = reset.clone();
let filtered_callback = create_filter_wrapper(filter.filter_fn(), move || {
set_last_active.set(js_sys::Date::now());
reset();
});
move |_: web_sys::Event| {
filtered_callback();
}
};
let listener_options = UseEventListenerOptions::default().passive(true);
for event in events {
let _ = use_event_listener_with_options(
use_document(),
Custom::new(event),
on_event.clone(),
listener_options,
);
}
if listen_for_visibility_change {
let on_event = on_event.clone();
let _ = use_event_listener(use_document(), visibilitychange, move |evt| {
if !document().hidden() {
on_event(evt);
}
});
}
reset.clone()();
}}
UseIdleReturn {
idle: idle.into(),
last_active: last_active.into(),
reset,
}
}
/// Options for [`use_idle_with_options`].
#[derive(DefaultBuilder)]
pub struct UseIdleOptions {
/// Event names to listen to for detected user activity.
/// Default: `vec!["mousemove", "mousedown", "resize", "keydown", "touchstart", "wheel"]`.
events: Vec<String>,
/// Whether to listen for document visibility change.
/// Defaults to `true`.
listen_for_visibility_change: bool,
/// Initial state of the returned `idle`.
/// Defaults to `false`.
initial_state: bool,
/// Allows to debounce or throttle the event listener that is called for
/// every event (from `events`). Defaults to a throttle by 50ms.
filter: FilterOptions,
}
impl Default for UseIdleOptions {
fn default() -> Self {
Self {
events: vec![
"mousemove".to_string(),
"mousedown".to_string(),
"resize".to_string(),
"keydown".to_string(),
"touchstart".to_string(),
"wheel".to_string(),
],
listen_for_visibility_change: true,
initial_state: false,
filter: FilterOptions::throttle(50.0),
}
}
}
impl UseIdleOptions {
filter_builder_methods!(
/// the event listener
filter
);
}
/// Return type of [`use_idle`].
pub struct UseIdleReturn<F>
where
F: Fn() + Clone,
{
/// Wether the use has been inactive for at least `timeout` milliseconds.
pub idle: Signal<bool>,
/// Timestamp of last user activity.
pub last_active: Signal<f64>,
/// Reset function. Sets the idle state to `false`.
pub reset: F,
}