iced_aw 0.14.1

Additional widgets for the Iced GUI library
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
//! Integration tests for the NumberInput widget
//!
//! These tests verify the NumberInput widget's behavior and public API
//! from an external perspective, testing the widget as a user of the
//! library would interact with it.

#[macro_use]
mod common;

use iced_aw::NumberInput;
use iced_test::{Error, Simulator};

#[derive(Clone, Debug)]
enum Message {
    Changed(#[allow(dead_code)] u32),
    Submit,
}

// Generate test helpers for this Message type
test_helpers!(Message);

// ============================================================================
// Helper Functions
// ============================================================================

/// Helper to click the increment button (tries both icon variants)
fn click_increment(ui: &mut Simulator<'_, Message>) -> Result<(), Error> {
    if ui.find("").is_ok() {
        ui.click("").map(|_| ())
    } else {
        ui.click(" + ").map(|_| ())
    }
}

/// Helper to click the decrement button (tries both icon variants)
fn click_decrement(ui: &mut Simulator<'_, Message>) -> Result<(), Error> {
    if ui.find("").is_ok() {
        ui.click("").map(|_| ())
    } else {
        ui.click(" - ").map(|_| ())
    }
}

// ============================================================================
// Display and Finding Elements Tests
// ============================================================================

#[test]
fn number_input_can_find_value() -> Result<(), Error> {
    let value = 42u32;

    let (mut app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());
    let ui = simulator(&app);
    process_messages(ui, &mut app);

    // Create a new simulator to verify the rendered content
    let mut ui = simulator(&app);
    assert!(
        ui.find("42").is_ok(),
        "Number input value should be findable"
    );

    Ok(())
}

#[test]
fn number_input_displays_correct_initial_value() -> Result<(), Error> {
    let value = 100u32;

    let (app, _) = App::new(move || NumberInput::new(&value, 0..=200, Message::Changed).into());

    let mut ui = simulator(&app);
    assert!(ui.find("100").is_ok(), "Initial value should be displayed");

    // Snapshot testing: verify visual rendering matches baseline
    assert_snapshot_matches(&mut ui, "tests/snapshots/number_input_initial_value_100")?;

    Ok(())
}

#[test]
fn number_input_can_find_increment_button() -> Result<(), Error> {
    let value = 50u32;

    let (app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);
    // The up arrow button should be findable (with spaces around it: " ▲ " or " + ")
    assert!(
        ui.find("").is_ok() || ui.find(" + ").is_ok(),
        "Increment button should be findable"
    );

    Ok(())
}

#[test]
fn number_input_can_find_decrement_button() -> Result<(), Error> {
    let value = 50u32;

    let (app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);
    // The down arrow button should be findable (with spaces around it: " ▼ " or " - ")
    assert!(
        ui.find("").is_ok() || ui.find(" - ").is_ok(),
        "Decrement button should be findable"
    );

    Ok(())
}

// ============================================================================
// Button Click Tests
// ============================================================================

#[test]
fn number_input_increment_button_click_produces_message() -> Result<(), Error> {
    let value = 50u32;

    let (mut app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);

    // Click the increment button
    click_increment(&mut ui)?;

    // Verify we got a Changed message
    assert_message_received(
        ui,
        &mut app,
        |m| matches!(m, Message::Changed(_)),
        "Increment button should produce Message::Changed",
    );

    Ok(())
}

#[test]
fn number_input_decrement_button_click_produces_message() -> Result<(), Error> {
    let value = 50u32;

    let (mut app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);

    // Click the decrement button
    click_decrement(&mut ui)?;

    // Verify we got a Changed message
    assert_message_received(
        ui,
        &mut app,
        |m| matches!(m, Message::Changed(_)),
        "Decrement button should produce Message::Changed",
    );

    Ok(())
}

// ============================================================================
// Boundary Tests
// ============================================================================

#[test]
fn number_input_cannot_increment_past_max() -> Result<(), Error> {
    let value = 100u32;

    let (app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);

    // Verify at max
    assert!(ui.find("100").is_ok(), "Should be at max value");

    // Try to click increment (value should remain at 100)
    // Note: The button may still be clickable but won't change the value
    let _ = click_increment(&mut ui);

    // Value should still be 100
    assert!(
        ui.find("100").is_ok(),
        "Value should remain at max after clicking increment"
    );

    // Snapshot testing: verify visual rendering matches baseline
    assert_snapshot_matches(
        &mut ui,
        "tests/snapshots/number_input_cannot_increment_past_max",
    )?;

    Ok(())
}

#[test]
fn number_input_cannot_decrement_past_min() -> Result<(), Error> {
    let value = 0u32;

    let (app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);

    // Verify at min
    assert!(ui.find("0").is_ok(), "Should be at min value");

    // Try to click decrement (value should remain at 0)
    let _ = click_decrement(&mut ui);

    // Value should still be 0
    assert!(
        ui.find("0").is_ok(),
        "Value should remain at min after clicking decrement"
    );

    // Snapshot testing: verify visual rendering matches baseline
    assert_snapshot_matches(
        &mut ui,
        "tests/snapshots/number_input_cannot_decrement_past_min",
    )?;

    Ok(())
}

// ============================================================================
// On Submit Tests
// ============================================================================

#[test]
fn number_input_on_submit_produces_message() -> Result<(), Error> {
    let value = 50u32;

    let (mut app, _) = App::new(move || {
        NumberInput::new(&value, 0..=100, Message::Changed)
            .on_submit(Message::Submit)
            .into()
    });

    let mut ui = simulator(&app);

    // Click on the value to focus the input
    ui.click("50")?;

    // Press enter
    ui.tap_key(iced::keyboard::Key::Named(
        iced::keyboard::key::Named::Enter,
    ));

    // Verify we got a Submit message
    assert_message_received(
        ui,
        &mut app,
        |m| matches!(m, Message::Submit),
        "Enter key should produce Message::Submit",
    );

    Ok(())
}

// ============================================================================
// Different Value Types Tests
// ============================================================================

#[test]
fn number_input_works_with_i32() -> Result<(), Error> {
    let value = -10i32;

    let (app, _) = App::new(move || {
        // Use a closure that converts i32 to our Message type for testing
        iced_aw::NumberInput::new(&value, -100..=100, |_v| Message::Submit).into()
    });

    let ui = simulator(&app);

    // Just verify it renders without errors
    for _message in ui.into_messages() {
        // Process messages
    }

    Ok(())
}

#[test]
fn number_input_works_with_f64() -> Result<(), Error> {
    let value = 2.5f64;

    // Create a simple widget element without using the full App infrastructure
    // This test just verifies the widget can be constructed with f64
    let _widget: iced_aw::NumberInput<'_, f64, (), iced::Theme, iced::Renderer> =
        iced_aw::NumberInput::new(&value, 0.0..=10.0, |v| {
            // Use a placeholder closure for testing
            let _ = v;
        });

    // If we got here without panic, the test passes
    Ok(())
}

// ============================================================================
// Mouse Wheel Scrolling Tests
// ============================================================================

#[test]
fn number_input_mouse_scroll_up_increases_value() -> Result<(), Error> {
    use iced::Event;
    use iced_core::mouse;

    let value = 50u32;

    let (mut app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);

    // Simulate mouse wheel scroll up (positive y delta)
    ui.simulate([Event::Mouse(mouse::Event::WheelScrolled {
        delta: mouse::ScrollDelta::Lines { x: 0.0, y: 1.0 },
    })]);

    // Verify we got a Changed message
    assert_message_received(
        ui,
        &mut app,
        |m| matches!(m, Message::Changed(_)),
        "Mouse scroll up should produce Message::Changed",
    );

    Ok(())
}

#[test]
fn number_input_mouse_scroll_down_decreases_value() -> Result<(), Error> {
    use iced::Event;
    use iced_core::mouse;

    let value = 50u32;

    let (mut app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);

    // Simulate mouse wheel scroll down (negative y delta)
    ui.simulate([Event::Mouse(mouse::Event::WheelScrolled {
        delta: mouse::ScrollDelta::Lines { x: 0.0, y: -1.0 },
    })]);

    // Verify we got a Changed message
    assert_message_received(
        ui,
        &mut app,
        |m| matches!(m, Message::Changed(_)),
        "Mouse scroll down should produce Message::Changed",
    );

    Ok(())
}

#[test]
fn number_input_ignore_scroll_prevents_wheel_events() -> Result<(), Error> {
    use iced::Event;
    use iced_core::mouse;

    let value = 50u32;

    let (mut app, _) = App::new(move || {
        NumberInput::new(&value, 0..=100, Message::Changed)
            .ignore_scroll(true)
            .into()
    });

    let mut ui = simulator(&app);

    // Simulate mouse wheel scroll up
    ui.simulate([Event::Mouse(mouse::Event::WheelScrolled {
        delta: mouse::ScrollDelta::Lines { x: 0.0, y: 1.0 },
    })]);

    // Verify we did NOT get a Changed message
    let got_changed = check_message_received(ui, &mut app, |m| matches!(m, Message::Changed(_)));

    assert!(
        !got_changed,
        "Mouse scroll should be ignored when ignore_scroll is true"
    );

    Ok(())
}

#[test]
fn number_input_scroll_respects_boundaries() -> Result<(), Error> {
    use iced::Event;
    use iced_core::mouse;

    // Test scrolling down at minimum
    let value = 0u32;
    let (mut app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);

    // Simulate scroll down at minimum - should not change value
    ui.simulate([Event::Mouse(mouse::Event::WheelScrolled {
        delta: mouse::ScrollDelta::Lines { x: 0.0, y: -1.0 },
    })]);

    // Process messages - value should stay at 0
    process_messages(ui, &mut app);

    // Create new simulator to verify value is still displayed as 0
    let mut ui = simulator(&app);
    assert!(
        ui.find("0").is_ok(),
        "Value should remain at minimum when scrolling down"
    );

    Ok(())
}

// ============================================================================
// Multiple Button Click Tests
// ============================================================================

#[test]
fn number_input_multiple_increment_clicks() -> Result<(), Error> {
    use std::cell::RefCell;
    use std::rc::Rc;

    let value = Rc::new(RefCell::new(10u32));
    let value_clone = value.clone();

    #[derive(Clone)]
    struct StatefulApp {
        value: Rc<RefCell<u32>>,
    }

    impl StatefulApp {
        fn new(value: Rc<RefCell<u32>>) -> (Self, iced::Task<Message>) {
            (Self { value }, iced::Task::none())
        }

        fn update(&mut self, message: Message) {
            if let Message::Changed(new_val) = message {
                *self.value.borrow_mut() = new_val;
            }
        }

        fn view(&self) -> iced::Element<'_, Message> {
            let val = *self.value.borrow();
            NumberInput::new(&val, 0..=100, Message::Changed)
                .step(5)
                .into()
        }
    }

    let (mut app, _) = StatefulApp::new(value_clone);
    let mut ui = iced_test::Simulator::with_settings(iced::Settings::default(), app.view());

    // Click increment button
    click_increment(&mut ui)?;
    for message in ui.into_messages() {
        app.update(message);
    }

    // Verify value increased
    let new_value = *value.borrow();
    assert_eq!(new_value, 15, "Value should increase by step (5)");

    Ok(())
}

#[test]
fn number_input_multiple_decrement_clicks() -> Result<(), Error> {
    use std::cell::RefCell;
    use std::rc::Rc;

    let value = Rc::new(RefCell::new(50u32));
    let value_clone = value.clone();

    #[derive(Clone)]
    struct StatefulApp {
        value: Rc<RefCell<u32>>,
    }

    impl StatefulApp {
        fn new(value: Rc<RefCell<u32>>) -> (Self, iced::Task<Message>) {
            (Self { value }, iced::Task::none())
        }

        fn update(&mut self, message: Message) {
            if let Message::Changed(new_val) = message {
                *self.value.borrow_mut() = new_val;
            }
        }

        fn view(&self) -> iced::Element<'_, Message> {
            let val = *self.value.borrow();
            NumberInput::new(&val, 0..=100, Message::Changed)
                .step(5)
                .into()
        }
    }

    let (mut app, _) = StatefulApp::new(value_clone);
    let mut ui = iced_test::Simulator::with_settings(iced::Settings::default(), app.view());

    // Click decrement button
    click_decrement(&mut ui)?;
    for message in ui.into_messages() {
        app.update(message);
    }

    // Verify value decreased
    let new_value = *value.borrow();
    assert_eq!(new_value, 45, "Value should decrease by step (5)");

    Ok(())
}

// ============================================================================
// Custom Step Tests
// ============================================================================

#[test]
fn number_input_custom_step_with_increment() -> Result<(), Error> {
    let value = 10u32;

    let (mut app, _) = App::new(move || {
        NumberInput::new(&value, 0..=100, Message::Changed)
            .step(10)
            .into()
    });

    let mut ui = simulator(&app);

    // Click increment button
    click_increment(&mut ui)?;

    // Verify we got a Changed message with appropriate value
    assert_message_received(
        ui,
        &mut app,
        |m| matches!(m, Message::Changed(_)),
        "Increment with custom step should produce Message::Changed",
    );

    Ok(())
}

// ============================================================================
// Ignore Buttons Tests
// ============================================================================

#[test]
fn number_input_ignore_buttons_hides_increment() -> Result<(), Error> {
    let value = 50u32;

    let (app, _) = App::new(move || {
        NumberInput::new(&value, 0..=100, Message::Changed)
            .ignore_buttons(true)
            .into()
    });

    let mut ui = simulator(&app);

    // The buttons should not be findable when ignored
    let inc_found = ui.find("").is_ok() || ui.find(" + ").is_ok();
    let dec_found = ui.find("").is_ok() || ui.find(" - ").is_ok();

    assert!(
        !inc_found && !dec_found,
        "Buttons should not be visible when ignore_buttons is true"
    );

    Ok(())
}

// ============================================================================
// Clicking on Value Input Tests
// ============================================================================

#[test]
fn number_input_clicking_value_is_findable() -> Result<(), Error> {
    let value = 42u32;

    let (app, _) = App::new(move || NumberInput::new(&value, 0..=100, Message::Changed).into());

    let mut ui = simulator(&app);

    // Verify we can find and click on the value - this tests that the value
    // is properly exposed through the operate() method
    ui.click("42")?;

    Ok(())
}