lemon 0.2.0-alpha.21

A reactive UI toolkit for Rust
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
use std::time::Instant;

use crate::{
    animation_frame_signal,
    element::{
        builders::View,
        events::Cursor,
        style::{Color, ColorSource},
        Element,
    },
    request_animation_frame, Cx, Signal,
};

/// Duration of a value-change animation in seconds.
const ANIM_DURATION: f32 = 0.15;

/// Lerp progress epsilon: treat animation as complete when this close to target.
const ANIM_EPSILON: f32 = 1e-4;

#[derive(Clone)]
struct AnimState {
    from: f32,
    to: f32,
    started_at: Instant,
}

impl AnimState {
    fn settled(value: f32) -> Self {
        Self {
            from: value,
            to: value,
            started_at: Instant::now(),
        }
    }

    /// Interpolated display value at the current wall-clock time.
    fn display(&self) -> f32 {
        let elapsed = self.started_at.elapsed().as_secs_f32();
        let progress = (elapsed / ANIM_DURATION).min(1.0);
        self.from + (self.to - self.from) * progress
    }

    /// True while the from→to transition has not yet completed.
    fn is_animating(&self) -> bool {
        let progress = (self.started_at.elapsed().as_secs_f32() / ANIM_DURATION).min(1.0);
        progress < 1.0 && (self.to - self.from).abs() > ANIM_EPSILON
    }
}

/// Per-widget visual overrides for [`Slider`].
///
/// # Examples
///
/// ```no_run
/// use lemon::Color;
/// use lemon::widget::SliderStyle;
///
/// let style = SliderStyle::default().fill_color(Color::rgb8(255, 120, 0));
/// ```
#[derive(Clone, Debug, Default, PartialEq)]
pub struct SliderStyle {
    track_color: Option<Color>,
    fill_color: Option<Color>,
}

impl SliderStyle {
    /// Overrides the slider track color.
    pub fn track_color(mut self, color: Color) -> Self {
        self.track_color = Some(color);
        self
    }

    /// Overrides the slider fill color.
    pub fn fill_color(mut self, color: Color) -> Self {
        self.fill_color = Some(color);
        self
    }
}

/// Horizontal slider widget backed by a user-owned `f32` signal.
///
/// The value is always in the range `[0.0, 1.0]`.
///
/// **Drag** is immediate: the fill tracks the pointer with no latency.
///
/// **Programmatic value changes** (e.g. `signal.set(0.8)` from another widget) animate the fill
/// over ~150 ms using a linear interpolation driven by the platform frame loop.
///
/// Use [`SliderStyle`] to override per-widget visuals while keeping theme defaults for unset fields.
///
/// # Examples
///
/// ```no_run
/// use lemon::{Cx, Color, element::Element};
/// use lemon::widget::{Slider, SliderStyle};
///
/// fn my_view(cx: &Cx) -> Element {
///     let volume = cx.use_signal(0.5_f32);
///     Slider::new(cx, volume)
///         .style(SliderStyle::default().fill_color(Color::rgb8(255, 120, 0)))
///         .into_element()
/// }
/// ```
pub struct Slider {
    value: Signal<f32>,
    anim: Signal<AnimState>,
    hovered: Signal<bool>,
    pressed: Signal<bool>,
    width: f32,
    height: f32,
    track_color: Color,
    track_color_hover: Color,
    track_color_pressed: Color,
    track_color_disabled: Color,
    fill_color: Color,
    fill_color_hover: Color,
    fill_color_pressed: Color,
    fill_color_disabled: Color,
    style: SliderStyle,
    disabled: bool,
}

impl Slider {
    /// Creates a `Slider` backed by `value` (a `f32` signal in `[0.0, 1.0]`).
    ///
    /// `cx` is used to allocate internal hook state for the animation.  Pass the same `&Cx`
    /// received by your view function.
    pub fn new(cx: &Cx, value: Signal<f32>) -> Self {
        let theme = cx.use_theme();
        let initial = value.peek().clamp(0.0, 1.0);
        let anim = cx.use_signal(AnimState::settled(initial));

        // When the target value changes from outside (programmatic), start a new animation from
        // the current display position.  Drag bypasses this: the pointer handlers update `anim`
        // before calling `value.set`, so the effect sees `anim.to == target` and does nothing.
        let anim_eff = anim.clone();
        let val_eff = value.clone();
        cx.use_effect(move || {
            let target = val_eff.get().clamp(0.0, 1.0); // subscribe to value
            let current = anim_eff.peek();
            if (current.to - target).abs() > ANIM_EPSILON {
                let display = current.display();
                anim_eff.set(AnimState {
                    from: display,
                    to: target,
                    started_at: Instant::now(),
                });
            }
        });

        Self {
            value,
            anim,
            hovered: cx.use_signal(false),
            pressed: cx.use_signal(false),
            width: 200.0,
            height: theme.spacing.sm * 2.0,
            track_color: theme.colors.border,
            track_color_hover: theme.colors.surface_hover,
            track_color_pressed: theme.colors.surface_pressed,
            track_color_disabled: theme.colors.surface,
            fill_color: theme.colors.accent,
            fill_color_hover: theme.colors.accent_hover,
            fill_color_pressed: theme.colors.accent_pressed,
            fill_color_disabled: theme.colors.foreground_disabled,
            style: SliderStyle::default(),
            disabled: false,
        }
    }

    /// Fixed track width in logical points (default: `200.0`).
    pub fn width(mut self, v: f32) -> Self {
        self.width = v;
        self
    }

    /// Fixed track height in logical points (default: `16.0`).
    pub fn height(mut self, v: f32) -> Self {
        self.height = v;
        self
    }

    /// Replaces all slider style overrides.
    pub fn style(mut self, style: SliderStyle) -> Self {
        self.style = style;
        self
    }

    /// Overrides the slider track color for this widget.
    pub fn track_color(mut self, color: Color) -> Self {
        self.style.track_color = Some(color);
        self
    }

    /// Overrides the slider fill color for this widget.
    pub fn fill_color(mut self, color: Color) -> Self {
        self.style.fill_color = Some(color);
        self
    }

    /// Marks this slider as disabled, preventing pointer interactions.
    pub fn disabled(mut self, disabled: bool) -> Self {
        self.disabled = disabled;
        self
    }

    /// Builds and returns the [`Element`] for this slider.
    ///
    /// Call this at the end of the builder chain to insert the widget into a parent container.
    pub fn into_element(self) -> Element {
        let anim = self.anim.get();
        let display = anim.display().clamp(0.0, 1.0);
        let fill_width = display * self.width;
        let radius = self.height / 2.0;
        let disabled = self.disabled;
        let track_color = self.style.track_color.map(ColorSource::Static).unwrap_or({
            let hovered = self.hovered.clone();
            let pressed = self.pressed.clone();
            let track_color = self.track_color;
            let track_color_hover = self.track_color_hover;
            let track_color_pressed = self.track_color_pressed;
            let track_color_disabled = self.track_color_disabled;
            ColorSource::Dynamic(std::rc::Rc::new(move || {
                if disabled {
                    track_color_disabled
                } else if pressed.get() {
                    track_color_pressed
                } else if hovered.get() {
                    track_color_hover
                } else {
                    track_color
                }
            }))
        });
        let fill_color = self.style.fill_color.map(ColorSource::Static).unwrap_or({
            let hovered = self.hovered.clone();
            let pressed = self.pressed.clone();
            let fill_color = self.fill_color;
            let fill_color_hover = self.fill_color_hover;
            let fill_color_pressed = self.fill_color_pressed;
            let fill_color_disabled = self.fill_color_disabled;
            ColorSource::Dynamic(std::rc::Rc::new(move || {
                if disabled {
                    fill_color_disabled
                } else if pressed.get() {
                    fill_color_pressed
                } else if hovered.get() {
                    fill_color_hover
                } else {
                    fill_color
                }
            }))
        });

        // Subscribe to the frame clock while animating so the platform drives re-renders.
        if anim.is_animating() {
            animation_frame_signal().get();
            request_animation_frame();
        }

        let anim_down = self.anim.clone();
        let val_down = self.value.clone();
        let anim_move = self.anim.clone();
        let val_move = self.value.clone();
        let mut slider = View::new()
            .width(self.width)
            .height(self.height)
            .radius(radius)
            .background(track_color)
            .cursor(if disabled {
                Cursor::NotAllowed
            } else {
                Cursor::Pointer
            })
            .child(
                View::new()
                    .width(fill_width)
                    .height(self.height)
                    .radius(radius)
                    .background(fill_color),
            );
        if !disabled {
            let hovered_enter = self.hovered.clone();
            let hovered_leave = self.hovered.clone();
            let pressed_down = self.pressed.clone();
            let pressed_up = self.pressed.clone();
            let pressed_leave = self.pressed.clone();
            slider = slider
                .on_hover_enter(move || hovered_enter.set(true))
                .on_hover_leave(move || {
                    hovered_leave.set(false);
                    pressed_leave.set(false);
                })
                .on_pointer_down(move |nx, _| {
                    let v = nx.clamp(0.0, 1.0);
                    pressed_down.set(true);
                    // Update anim first so the effect sees anim.to == v and skips animation.
                    anim_down.set(AnimState::settled(v));
                    val_down.set(v);
                })
                .on_pointer_move(move |nx, _| {
                    let v = nx.clamp(0.0, 1.0);
                    anim_move.set(AnimState::settled(v));
                    val_move.set(v);
                })
                .on_pointer_up(move |_, _| pressed_up.set(false));
        }
        slider.into_element()
    }
}

impl From<Slider> for Element {
    fn from(slider: Slider) -> Self {
        slider.into_element()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::element::{style::Dimension, Element};

    fn make_slider(value: Signal<f32>) -> (Element, Signal<AnimState>) {
        let cx = crate::Cx::new();
        let slider = Slider::new(&cx, value);
        let anim = slider.anim.clone();
        (slider.into_element(), anim)
    }

    #[test]
    fn slider_has_pointer_down_and_move_handlers() {
        let value = Signal::new(0.0_f32);
        let (el, _) = make_slider(value);

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        assert!(
            track.handlers.on_pointer_down.is_some(),
            "Slider track must have on_pointer_down"
        );
        assert!(
            track.handlers.on_pointer_move.is_some(),
            "Slider track must have on_pointer_move"
        );
    }

    #[test]
    fn slider_pointer_down_updates_value() {
        let value = Signal::new(0.0_f32);
        let (el, _) = make_slider(value.clone());

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        let on_down = track
            .handlers
            .on_pointer_down
            .as_ref()
            .expect("must have on_pointer_down");
        on_down(0.5, 0.0);
        assert!(
            (value.get() - 0.5).abs() < 1e-6,
            "value should be 0.5 after pointer_down at nx=0.5"
        );
    }

    #[test]
    fn slider_pointer_move_updates_value() {
        let value = Signal::new(0.0_f32);
        let (el, _) = make_slider(value.clone());

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        let on_move = track
            .handlers
            .on_pointer_move
            .as_ref()
            .expect("must have on_pointer_move");
        on_move(0.75, 0.0);
        assert!(
            (value.get() - 0.75).abs() < 1e-6,
            "value should be 0.75 after pointer_move at nx=0.75"
        );
    }

    #[test]
    fn slider_fill_child_width_reflects_initial_value() {
        let value = Signal::new(0.25_f32);
        let cx = crate::Cx::new();
        let el = Slider::new(&cx, value).width(200.0).into_element();

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        assert_eq!(track.children.len(), 1);
        let Element::View(fill) = &track.children[0] else {
            panic!("expected View fill child");
        };
        assert_eq!(
            fill.style.width,
            Some(Dimension::Points(50.0)),
            "fill width should be 0.25 * 200 = 50"
        );
    }

    #[test]
    fn slider_default_dimensions() {
        let previous = crate::current_theme();
        let mut custom = crate::Theme::default_dark();
        custom.spacing.sm = 9.0;
        crate::set_active_theme(custom.clone());

        let value = Signal::new(0.0_f32);
        let (el, _) = make_slider(value);

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        assert_eq!(track.style.width, Some(Dimension::Points(200.0)));
        assert_eq!(
            track.style.height,
            Some(Dimension::Points(custom.spacing.sm * 2.0))
        );

        crate::set_active_theme(previous);
    }

    #[test]
    fn slider_style_overrides_beat_theme_defaults() {
        let previous = crate::current_theme();
        let mut custom = crate::Theme::default_dark();
        custom.colors.border = Color::rgb8(11, 22, 33);
        custom.colors.accent = Color::rgb8(44, 55, 66);
        crate::set_active_theme(custom);

        let value = Signal::new(0.5_f32);
        let override_track = Color::rgb8(99, 88, 77);
        let override_fill = Color::rgb8(66, 55, 44);
        let cx = crate::Cx::new();
        let el = Slider::new(&cx, value)
            .style(
                SliderStyle::default()
                    .track_color(override_track)
                    .fill_color(override_fill),
            )
            .into_element();

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        assert_eq!(track.paint.resolve().background, Some(override_track));
        let Element::View(fill) = &track.children[0] else {
            panic!("expected View fill child");
        };
        assert_eq!(fill.paint.resolve().background, Some(override_fill));

        crate::set_active_theme(previous);
    }

    #[test]
    fn slider_style_unset_fields_fall_back_to_theme() {
        let previous = crate::current_theme();
        let mut custom = crate::Theme::default_dark();
        custom.colors.accent = Color::rgb8(44, 55, 66);
        crate::set_active_theme(custom.clone());

        let value = Signal::new(0.5_f32);
        let cx = crate::Cx::new();
        let el = Slider::new(&cx, value)
            .style(SliderStyle::default().track_color(Color::rgb8(99, 88, 77)))
            .into_element();

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        let Element::View(fill) = &track.children[0] else {
            panic!("expected View fill child");
        };
        assert_eq!(fill.paint.resolve().background, Some(custom.colors.accent));

        crate::set_active_theme(previous);
    }

    #[test]
    fn slider_pointer_coords_are_clamped_to_unit_range() {
        let value = Signal::new(0.5_f32);
        let (el, _) = make_slider(value.clone());

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        let on_down = track
            .handlers
            .on_pointer_down
            .as_ref()
            .expect("must have on_pointer_down");

        on_down(1.5, 0.0);
        assert_eq!(value.get(), 1.0, "value above 1.0 should clamp to 1.0");

        on_down(-0.5, 0.0);
        assert_eq!(value.get(), 0.0, "value below 0.0 should clamp to 0.0");
    }

    #[test]
    fn slider_cursor_is_pointer() {
        let value = Signal::new(0.0_f32);
        let (el, _) = make_slider(value);

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        assert_eq!(
            track.style.cursor,
            Cursor::Pointer,
            "Slider track should use Pointer cursor"
        );
    }

    #[test]
    fn slider_defaults_follow_active_theme_colors() {
        let previous = crate::current_theme();
        let mut custom = crate::Theme::default_dark();
        custom.colors.border = Color::rgb8(11, 22, 33);
        custom.colors.accent = Color::rgb8(44, 55, 66);
        crate::set_active_theme(custom.clone());

        let value = Signal::new(0.25_f32);
        let (el, _) = make_slider(value);

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        assert_eq!(track.paint.resolve().background, Some(custom.colors.border));
        let Element::View(fill) = &track.children[0] else {
            panic!("expected View fill child");
        };
        assert_eq!(fill.paint.resolve().background, Some(custom.colors.accent));

        crate::set_active_theme(previous);
    }

    #[test]
    fn slider_hover_and_press_states_update_colors() {
        let previous = crate::current_theme();
        let mut custom = crate::Theme::default_dark();
        custom.colors.border = Color::rgb8(1, 2, 3);
        custom.colors.surface_hover = Color::rgb8(4, 5, 6);
        custom.colors.surface_pressed = Color::rgb8(7, 8, 9);
        custom.colors.accent = Color::rgb8(10, 11, 12);
        custom.colors.accent_hover = Color::rgb8(13, 14, 15);
        custom.colors.accent_pressed = Color::rgb8(16, 17, 18);
        crate::set_active_theme(custom.clone());

        let value = Signal::new(0.25_f32);
        let (el, _) = make_slider(value);

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        assert_eq!(track.paint.resolve().background, Some(custom.colors.border));
        let Element::View(fill) = &track.children[0] else {
            panic!("expected View fill child");
        };
        assert_eq!(fill.paint.resolve().background, Some(custom.colors.accent));

        track
            .handlers
            .on_hover_enter
            .as_ref()
            .expect("hover enter handler")();
        assert_eq!(
            track.paint.resolve().background,
            Some(custom.colors.surface_hover)
        );
        let Element::View(fill) = &track.children[0] else {
            panic!("expected View fill child");
        };
        assert_eq!(
            fill.paint.resolve().background,
            Some(custom.colors.accent_hover)
        );

        track
            .handlers
            .on_pointer_down
            .as_ref()
            .expect("pointer down handler")(0.5, 0.0);
        assert_eq!(
            track.paint.resolve().background,
            Some(custom.colors.surface_pressed)
        );
        let Element::View(fill) = &track.children[0] else {
            panic!("expected View fill child");
        };
        assert_eq!(
            fill.paint.resolve().background,
            Some(custom.colors.accent_pressed)
        );

        track
            .handlers
            .on_pointer_up
            .as_ref()
            .expect("pointer up handler")(0.5, 0.0);
        assert_eq!(
            track.paint.resolve().background,
            Some(custom.colors.surface_hover)
        );

        crate::set_active_theme(previous);
    }

    #[test]
    fn disabled_slider_ignores_pointer_interactions() {
        let value = Signal::new(0.25_f32);
        let cx = crate::Cx::new();
        let el = Slider::new(&cx, value.clone())
            .disabled(true)
            .into_element();

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        assert!(track.handlers.on_pointer_down.is_none());
        assert!(track.handlers.on_pointer_move.is_none());
        assert!(track.handlers.on_hover_enter.is_none());
        assert!(track.handlers.on_pointer_up.is_none());
        assert_eq!(value.get(), 0.25);
    }

    #[test]
    fn drag_sets_anim_from_and_to_equal_no_animation() {
        let value = Signal::new(0.0_f32);
        let (el, anim) = make_slider(value.clone());

        let Element::View(track) = el else {
            panic!("expected View element from Slider");
        };
        let on_down = track
            .handlers
            .on_pointer_down
            .as_ref()
            .expect("must have on_pointer_down");
        on_down(0.6, 0.0);

        let state = anim.get();
        assert!(
            (state.from - 0.6).abs() < 1e-6,
            "anim.from should equal drag position"
        );
        assert!(
            (state.to - 0.6).abs() < 1e-6,
            "anim.to should equal drag position"
        );
        assert!(
            !state.is_animating(),
            "no animation should be active after drag"
        );
    }

    #[test]
    fn lerp_clamped_progress_stays_in_zero_one() {
        // AnimState::display must clamp progress to [0, 1] regardless of elapsed time.
        let state = AnimState {
            from: 0.0,
            to: 1.0,
            // A started_at far in the past guarantees elapsed >> ANIM_DURATION.
            started_at: Instant::now() - std::time::Duration::from_secs(10),
        };
        let display = state.display();
        assert!(
            (display - 1.0).abs() < 1e-6,
            "display should reach 1.0 when animation time exceeded: got {display}"
        );
    }

    #[test]
    fn lerp_returns_from_at_zero_elapsed() {
        let state = AnimState {
            from: 0.2,
            to: 0.8,
            started_at: Instant::now() + std::time::Duration::from_secs(10), // far in future
        };
        // elapsed will be negative-ish, clamped to 0 progress
        let display = state.display();
        // progress = elapsed.max(0) / ANIM_DURATION — Instant::elapsed never returns negative,
        // but a started_at in the future means elapsed ≈ 0.
        // We just verify the result is in [from, to].
        assert!(
            (0.2 - 1e-4..=0.8 + 1e-4).contains(&display),
            "display must be between from and to: {display}"
        );
    }

    #[test]
    fn settled_state_is_not_animating() {
        let state = AnimState::settled(0.5);
        assert!(
            !state.is_animating(),
            "a settled state should not be animating"
        );
    }

    #[test]
    fn animating_state_reports_is_animating_until_complete() {
        let state = AnimState {
            from: 0.0,
            to: 1.0,
            started_at: Instant::now(),
        };
        // Immediately after creation, elapsed ≈ 0 → progress ≈ 0 < 1
        assert!(
            state.is_animating(),
            "freshly started animation should be animating"
        );
    }
}