frus-widgets 0.5.0

frus — declarative widget tree
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
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

//! [`Skeleton`]: a loading placeholder whose intensity **pulses** over time, a
//! shimmer. It reuses the continuous clock (`Status::time` plus `continuous`).

use frus_core::{Color, Rect, Scene};
use frus_layout::{Dimension, Style};

use crate::interaction::Status;
use crate::theme::Theme;
use crate::widget::Widget;

/// Vitesse de pulsation (radians/seconde).
const SPEED: f32 = 2.5;

/// An animated loading block.
pub struct Skeleton {
    width: Dimension,
    height: f32,
    radius: f32,
}

impl Skeleton {
    /// Creates a placeholder: full width, and 16 tall by default.
    pub fn new() -> Self {
        Self {
            width: Dimension::Auto,
            height: 16.0,
            radius: 6.0,
        }
    }

    /// Sets the width, in logical pixels.
    pub fn width(mut self, width: f32) -> Self {
        self.width = Dimension::Length(width);
        self
    }

    /// Sets the height, in logical pixels.
    pub fn height(mut self, height: f32) -> Self {
        self.height = height;
        self
    }

    /// Sets the corner radius.
    pub fn radius(mut self, radius: f32) -> Self {
        self.radius = radius;
        self
    }
}

impl Default for Skeleton {
    fn default() -> Self {
        Self::new()
    }
}

impl<Msg> Widget<Msg> for Skeleton {
    fn style(&self) -> Style {
        Style {
            width: self.width,
            height: Dimension::Length(self.height),
            ..Default::default()
        }
    }

    fn children(&self) -> &[Box<dyn Widget<Msg>>] {
        &[]
    }

    fn continuous(&self) -> bool {
        true
    }

    fn paint(&self, bounds: Rect, status: Status, theme: &Theme, scene: &mut Scene) {
        let o = status.opacity;
        // A `0..1` pulse driven by time.
        let pulse = 0.5 + 0.5 * (status.time * SPEED).sin();
        let alpha = (0.18 + 0.22 * pulse) * o;
        scene.draw_rect(
            bounds,
            theme.muted.fade(alpha),
            self.radius,
            0.0,
            Color::TRANSPARENT,
        );
    }

    fn on_click(&self) -> Option<Msg> {
        None
    }
}

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

    fn alpha_at(time: f32) -> f32 {
        let sk = Skeleton::new().width(120.0);
        let status = Status {
            time,
            ..Default::default()
        };
        let mut scene = Scene::new();
        Widget::<()>::paint(
            &sk,
            Rect::new(0.0, 0.0, 120.0, 16.0),
            status,
            &Theme::default(),
            &mut scene,
        );
        match scene.primitives()[0] {
            Primitive::Rect { color, .. } => color.a,
            _ => panic!("expected a rect"),
        }
    }

    #[test]
    fn is_continuous() {
        assert!(Widget::<()>::continuous(&Skeleton::new()));
    }

    #[test]
    fn intensity_varies_with_time() {
        // Two distinct instants of the pulse give different opacities.
        assert_ne!(alpha_at(0.0), alpha_at(0.6));
    }
}