dioxus-nox-timer 0.13.0

Headless countdown and stopwatch timer 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

//! Core types for dioxus-nox-timer.

use dioxus::prelude::*;

/// Timer state machine.
///
/// Represents the lifecycle of a countdown timer.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum TimerState {
    /// No timer active.
    #[default]
    Idle,
    /// Counting down (or counting up for stopwatch).
    Running,
    /// Paused mid-count.
    Paused,
    /// Countdown reached zero.
    Complete,
}

/// Controls returned by [`use_countdown`](crate::use_countdown).
#[derive(Clone)]
pub struct CountdownControls {
    /// Start countdown with given duration in seconds.
    pub start: Callback<i64>,
    /// Pause a running countdown.
    pub pause: Callback<()>,
    /// Resume a paused countdown.
    pub resume: Callback<()>,
    /// Cancel immediately, return to Idle.
    pub skip: Callback<()>,
    /// Adjust remaining time by delta seconds (positive adds, negative subtracts).
    /// Remaining time is clamped to >= 0.
    pub adjust: Callback<i64>,
    /// Dismiss after completion (Complete → Idle).
    pub dismiss: Callback<()>,
}