freya-components 0.4.0-rc.18

Components for Freya apps
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use freya_animation::{
    easing::Function,
    hook::{
        Ease,
        use_animation_transition,
    },
    prelude::AnimNum,
};
use freya_core::prelude::*;
use torin::{
    prelude::Alignment,
    size::Size,
};

use crate::{
    define_theme,
    get_theme,
};

define_theme! {
    %[component]
    pub ProgressBar {
        %[fields]
        color: Color,
        background: Color,
        progress_background: Color,
        height: f32,
    }
}

/// ProgressBar component.
///
/// # Example
///
/// ```rust
/// # use freya::prelude::*;
/// fn app() -> impl IntoElement {
///     ProgressBar::new(50.)
/// }
///
/// # use freya_testing::prelude::*;
/// # launch_doc(|| {
/// #   rect().padding(8.).center().expanded().child(app())
/// # }, "./images/gallery_progressbar.png").render();
/// ```
///
/// # Preview
/// ![Progressbar Preview][progressbar]
#[cfg_attr(feature = "docs",
    doc = embed_doc_image::embed_image!("progressbar", "images/gallery_progressbar.png")
)]
#[derive(Clone, PartialEq)]
pub struct ProgressBar {
    pub(crate) theme: Option<ProgressBarThemePartial>,
    width: Size,
    show_progress: bool,
    progress: f32,
    key: DiffKey,
}

impl KeyExt for ProgressBar {
    fn write_key(&mut self) -> &mut DiffKey {
        &mut self.key
    }
}

impl ProgressBar {
    pub fn new(progress: impl Into<f32>) -> Self {
        Self {
            width: Size::fill(),
            theme: None,
            show_progress: true,
            progress: progress.into(),
            key: DiffKey::None,
        }
    }

    pub fn width(mut self, width: impl Into<Size>) -> Self {
        self.width = width.into();
        self
    }

    /// Shows the progress bar percentage label
    ///
    /// This is set to true by default
    pub fn show_progress(mut self, show_progress: bool) -> Self {
        self.show_progress = show_progress;
        self
    }
}

impl Component for ProgressBar {
    fn render(&self) -> impl IntoElement {
        let progressbar_theme = get_theme!(&self.theme, ProgressBarThemePreference, "progressbar");

        let progress = use_reactive(&self.progress.clamp(0., 100.));
        let animation = use_animation_transition(progress, |from, to| {
            AnimNum::new(from, to)
                .time(500)
                .ease(Ease::Out)
                .function(Function::Expo)
        });

        rect()
            .a11y_alt(format!("Progress {}%", progress()))
            .a11y_focusable(true)
            .a11y_role(AccessibilityRole::ProgressIndicator)
            .horizontal()
            .width(self.width.clone())
            .height(Size::px(progressbar_theme.height))
            .corner_radius(99.)
            .overflow(Overflow::Clip)
            .background(progressbar_theme.background)
            .border(
                Border::new()
                    .width(1.)
                    .alignment(BorderAlignment::Outer)
                    .fill(progressbar_theme.background),
            )
            .font_size(13.)
            .child(
                rect()
                    .horizontal()
                    .width(Size::percent(&*animation.read()))
                    .cross_align(Alignment::Center)
                    .height(Size::fill())
                    .corner_radius(99.)
                    .background(progressbar_theme.progress_background)
                    .maybe(self.show_progress, |el| {
                        el.child(
                            label()
                                .width(Size::fill())
                                .color(progressbar_theme.color)
                                .text_align(TextAlign::Center)
                                .text(format!("{}%", self.progress))
                                .max_lines(1),
                        )
                    }),
            )
    }

    fn render_key(&self) -> DiffKey {
        self.key.clone().or(self.default_key())
    }
}