orbital-charts 0.1.1

Chart components for Orbital and Leptos
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
53
54
55
56
57
58
59

//! Chart animation configuration.

use orbital_motion::{MotionDuration, PresenceMotion};

/// Chart-level animation configuration. Default: enabled, respects reduced motion.
#[derive(Clone, Debug)]
pub struct ChartMotion {
    /// When true, skip all enter/update animations.
    /// Also forced when [`orbital_motion::use_reduced_motion`] is true.
    pub skip_animation: bool,
    /// Stagger step between grouped items (bars, pie slices).
    pub stagger: MotionDuration,
    /// Override entrance preset per plot kind.
    pub entrance: Option<PresenceMotion>,
}

impl Default for ChartMotion {
    fn default() -> Self {
        Self {
            skip_animation: false,
            stagger: MotionDuration::Normal,
            entrance: None,
        }
    }
}

/// Resolve whether animations should be skipped.
///
/// Combines explicit `skip_animation` prop, [`ChartMotion::skip_animation`],
/// and the user's reduced-motion preference.
pub fn effective_skip_animation(
    skip_animation: Option<bool>,
    motion: Option<&ChartMotion>,
    prefers_reduced_motion: bool,
) -> bool {
    skip_animation.unwrap_or(false)
        || motion.map(|m| m.skip_animation).unwrap_or(false)
        || prefers_reduced_motion
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn effective_skip_animation_respects_all_sources() {
        assert!(!effective_skip_animation(None, None, false));
        assert!(effective_skip_animation(Some(true), None, false));
        assert!(effective_skip_animation(
            None,
            Some(&ChartMotion {
                skip_animation: true,
                ..Default::default()
            }),
            false
        ));
        assert!(effective_skip_animation(None, None, true));
    }
}