dioxus-sdk-time 0.7.0

Timing utilities and hooks for Dioxus.
Documentation 
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

//! # Dioxus Time Utilities
//!
//! Cross-platform timing utilities for your Dioxus apps.
//!
//! We currently offer:
//! - [`use_timeout`]
//! - [`use_debounce`]
//! - [`use_interval`]
//! - and [`sleep`]
#![warn(missing_docs)]

use std::time::Duration;

mod interval;
pub use interval::{UseInterval, use_interval};

mod debounce;
pub use debounce::{UseDebounce, use_debounce};

mod timeout;
pub use timeout::{TimeoutHandle, UseTimeout, use_timeout};

/// Pause the current task for the specified duration.
///
/// # Examples
/// ```rust
/// use std::time::Duration;
/// use dioxus::prelude::*;
///
/// #[component]
/// pub fn App() -> Element {
///     let mut has_slept = use_signal(|| false);
///
///     use_effect(move || {
///         spawn(async move {
///             dioxus_sdk_time::sleep(Duration::from_secs(3)).await;
///             has_slept.set(true);
///         });
///     });
///
///     rsx! {
///         "I have slept: {has_slept}"
///     }
/// }
/// ```
pub async fn sleep(duration: Duration) {
    #[cfg(not(target_family = "wasm"))]
    tokio::time::sleep(duration).await;

    #[cfg(target_family = "wasm")]
    gloo_timers::future::sleep(duration).await;
}