rat-widget 3.2.1

ratatui widgets extended edition
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
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
//!
//! Choice/Select widget.
//!
//! ```rust no_run
//! use rat_popup::Placement;
//! use rat_scrolled::Scroll;
//! use rat_widget::choice::{Choice, ChoiceState};
//! # use ratatui_core::buffer::Buffer;
//! # use ratatui_core::layout::Rect;
//! # use ratatui_core::widgets::StatefulWidget;
//! # use ratatui_widgets::block::Block;
//! # let mut buf = Buffer::default();
//! # let mut cstate = ChoiceState::default();
//! # let mut max_bounds: Rect = Rect::default();
//!
//! let (widget, popup) = Choice::new()
//!         .item(1, "Carrots")
//!         .item(2, "Potatoes")
//!         .item(3, "Onions")
//!         .item(4, "Peas")
//!         .item(5, "Beans")
//!         .item(6, "Tomatoes")
//!         .popup_block(Block::bordered())
//!         .popup_placement(Placement::AboveOrBelow)
//!         .popup_boundary(max_bounds)
//!         .into_widgets();
//!  widget.render(Rect::new(3,3,15,1), &mut buf, &mut cstate);
//!
//!  // ... render other widgets
//!
//!  popup.render(Rect::new(3,3,15,1), &mut buf, &mut cstate);
//!
//! ```
//!

use crate::_private::NonExhaustive;
use crate::choice::core::ChoiceCore;
use crate::event::ChoiceOutcome;
use crate::text::HasScreenCursor;
use crate::util::{block_padding, block_size, revert_style};
use rat_event::util::{MouseFlags, item_at, mouse_trap};
use rat_event::{ConsumedEvent, HandleEvent, MouseOnly, Popup, Regular, ct_event};
use rat_focus::{FocusBuilder, FocusFlag, HasFocus, Navigation};
use rat_popup::event::PopupOutcome;
use rat_popup::{Placement, PopupCore, PopupCoreState, PopupStyle, fallback_popup_style};
use rat_reloc::RelocatableState;
use rat_scrolled::event::ScrollOutcome;
use rat_scrolled::{Scroll, ScrollArea, ScrollAreaState, ScrollState, ScrollStyle};
use ratatui_core::buffer::Buffer;
use ratatui_core::layout::{Alignment, Rect};
use ratatui_core::style::Style;
use ratatui_core::text::{Line, Span};
use ratatui_core::widgets::{StatefulWidget, Widget};
use ratatui_crossterm::crossterm::event::Event;
use ratatui_widgets::block::{Block, BlockExt};
use std::cell::{Cell, RefCell};
use std::cmp::{max, min};
use std::marker::PhantomData;
use std::rc::Rc;

/// Enum controling the behaviour of the Choice.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum ChoiceFocus {
    /// Opening the choice popup is a separate action.
    #[default]
    SeparateOpen,
    /// Open the choice popup on focus gained.
    OpenOnFocusGained,
}

/// Enum controling the behaviour of the Choice.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum ChoiceSelect {
    /// Change the selection with the mouse-wheel.
    #[default]
    MouseScroll,
    /// Change the selection just by moving.
    MouseMove,
    /// Change the selection with a click only
    MouseClick,
}

/// Enum controlling the behaviour of the Choice.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum ChoiceClose {
    /// Close the popup with a single click.
    #[default]
    SingleClick,
    /// Close the popup with double-click.
    DoubleClick,
}

/// Choice.
///
/// Select one of a list. No editable mode for this widget.
///
/// This doesn't render itself. [into_widgets](Choice::into_widgets)
/// creates the base part and the popup part, which are rendered
/// separately.
///
#[derive(Debug, Clone)]
pub struct Choice<'a, T = usize>
where
    T: PartialEq + Clone + Default,
{
    values: Rc<RefCell<Vec<T>>>,
    default_value: Option<T>,
    unknown_item: Option<Line<'a>>,
    items: Rc<RefCell<Vec<Line<'a>>>>,

    style: Style,
    button_style: Option<Style>,
    select_style: Option<Style>,
    select_marker: Option<char>,
    focus_style: Option<Style>,
    block: Option<Block<'a>>,
    skip_item_render: bool,

    popup_alignment: Alignment,
    popup_placement: Placement,
    popup_len: Option<u16>,
    popup: PopupCore,
    popup_style: Style,
    popup_scroll: Option<Scroll<'a>>,
    popup_block: Option<Block<'a>>,

    behave_focus: ChoiceFocus,
    behave_select: ChoiceSelect,
    behave_close: ChoiceClose,
}

/// Renders the main widget.
#[derive(Debug)]
pub struct ChoiceWidget<'a, T>
where
    T: PartialEq,
{
    values: Rc<RefCell<Vec<T>>>,
    default_value: Option<T>,
    unknown_item: Option<Line<'a>>,
    items: Rc<RefCell<Vec<Line<'a>>>>,

    style: Style,
    button_style: Option<Style>,
    focus_style: Option<Style>,
    block: Option<Block<'a>>,
    skip_item_render: bool,
    len: Option<u16>,

    behave_focus: ChoiceFocus,
    behave_select: ChoiceSelect,
    behave_close: ChoiceClose,
}

/// Renders the popup. This is called after the rest
/// of the area is rendered and overwrites to display itself.
#[derive(Debug)]
pub struct ChoicePopup<'a, T>
where
    T: PartialEq,
{
    items: Rc<RefCell<Vec<Line<'a>>>>,

    style: Style,
    select_style: Option<Style>,
    select_marker: Option<char>,

    popup_alignment: Alignment,
    popup_placement: Placement,
    popup_len: Option<u16>,
    popup: PopupCore,
    popup_style: Style,
    popup_scroll: Option<Scroll<'a>>,
    popup_block: Option<Block<'a>>,

    _phantom: PhantomData<T>,
}

/// Combined style.
#[derive(Debug, Clone)]
pub struct ChoiceStyle {
    pub style: Style,
    pub button: Option<Style>,
    pub select: Option<Style>,
    pub select_marker: Option<char>,
    pub focus: Option<Style>,
    pub block: Option<Block<'static>>,
    pub border_style: Option<Style>,
    pub title_style: Option<Style>,

    pub popup: PopupStyle,
    pub popup_style: Option<Style>,
    pub popup_border: Option<Style>,
    pub popup_scroll: Option<ScrollStyle>,
    pub popup_block: Option<Block<'static>>,
    pub popup_len: Option<u16>,

    pub behave_focus: Option<ChoiceFocus>,
    pub behave_select: Option<ChoiceSelect>,
    pub behave_close: Option<ChoiceClose>,

    pub non_exhaustive: NonExhaustive,
}

/// State.
#[derive(Debug)]
pub struct ChoiceState<T = usize>
where
    T: PartialEq + Clone + Default,
{
    /// Total area.
    /// __read only__. renewed with each render.
    pub area: Rect,
    /// Area inside the border.
    /// __read only__. renewed with each render.
    pub inner: Rect,
    /// First char of each item for navigation.
    /// __read only__. renewed with each render.
    pub nav_char: Vec<Vec<char>>,
    /// Item area in the main widget.
    /// __read only__. renewed with each render.
    pub item_area: Rect,
    /// Button area in the main widget.
    /// __read only__. renewed with each render.
    pub button_area: Rect,
    /// Visible items in the popup.
    /// __read only__. renewed with each render.
    pub item_areas: Vec<Rect>,
    /// Core
    pub core: ChoiceCore<T>,
    /// Popup state.
    pub popup: PopupCoreState,
    /// Popup scroll state.
    pub popup_scroll: ScrollState,
    /// Behaviour for opening the choice popup.
    pub behave_focus: Rc<Cell<ChoiceFocus>>,
    /// Behaviour for selecting from the choice popup.
    /// __read only__ renewed with each render.
    pub behave_select: ChoiceSelect,
    /// Behaviour for closing the choice popup.
    /// __read only__ renewed with each render.
    pub behave_close: ChoiceClose,

    /// Focus flag.
    /// __read+write__
    pub focus: FocusFlag,
    /// Mouse util.
    pub mouse: MouseFlags,

    pub non_exhaustive: NonExhaustive,
}

pub(crate) mod event {
    use rat_event::{ConsumedEvent, Outcome};
    use rat_popup::event::PopupOutcome;

    /// Result value for event-handling.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
    pub enum ChoiceOutcome {
        /// The given event was not handled at all.
        Continue,
        /// The event was handled, no repaint necessary.
        Unchanged,
        /// The event was handled, repaint necessary.
        Changed,
        /// An item has been selected.
        Value,
    }

    impl ConsumedEvent for ChoiceOutcome {
        fn is_consumed(&self) -> bool {
            *self != ChoiceOutcome::Continue
        }
    }

    impl From<Outcome> for ChoiceOutcome {
        fn from(value: Outcome) -> Self {
            match value {
                Outcome::Continue => ChoiceOutcome::Continue,
                Outcome::Unchanged => ChoiceOutcome::Unchanged,
                Outcome::Changed => ChoiceOutcome::Changed,
            }
        }
    }

    impl From<ChoiceOutcome> for Outcome {
        fn from(value: ChoiceOutcome) -> Self {
            match value {
                ChoiceOutcome::Continue => Outcome::Continue,
                ChoiceOutcome::Unchanged => Outcome::Unchanged,
                ChoiceOutcome::Changed => Outcome::Changed,
                ChoiceOutcome::Value => Outcome::Changed,
            }
        }
    }

    impl From<PopupOutcome> for ChoiceOutcome {
        fn from(value: PopupOutcome) -> Self {
            match value {
                PopupOutcome::Continue => ChoiceOutcome::Continue,
                PopupOutcome::Unchanged => ChoiceOutcome::Unchanged,
                PopupOutcome::Changed => ChoiceOutcome::Changed,
                PopupOutcome::Hide => ChoiceOutcome::Changed,
            }
        }
    }
}

pub mod core {
    #[derive(Debug, Default, Clone)]
    pub struct ChoiceCore<T>
    where
        T: PartialEq + Clone + Default,
    {
        /// Values.
        /// __read only__. renewed for each render.
        values: Vec<T>,
        /// Can return to default with a user interaction.
        default_value: Option<T>,
        /// Selected value, or a value set with set_value().
        /// There may be a value and still no selected index,
        /// if the values-vec is empty, or if the value is not in
        /// values.
        value: T,
        /// Index of value.
        selected: Option<usize>,
    }

    impl<T> ChoiceCore<T>
    where
        T: PartialEq + Clone + Default,
    {
        pub fn set_values(&mut self, values: Vec<T>) {
            self.values = values;
            // ensure integrity
            if self.values.is_empty() {
                self.selected = None;
            } else {
                self.selected = self.values.iter().position(|v| *v == self.value);
            }
        }

        /// List of values.
        pub fn values(&self) -> &[T] {
            &self.values
        }

        /// Set a default-value other than T::default()
        ///
        /// The starting value will still be T::default()
        /// after this. You must call clear() to use this
        /// default.
        pub fn set_default_value(&mut self, default_value: Option<T>) {
            self.default_value = default_value.clone();
        }

        /// A default value.
        pub fn default_value(&self) -> &Option<T> {
            &self.default_value
        }

        /// Selected item index.
        ///
        /// This may be None and there may still be a valid value.
        /// This can happen if a value is not in the value-list,
        /// or if the value-list is empty before the first render.
        ///
        /// Use of value() is preferred.
        pub fn selected(&self) -> Option<usize> {
            self.selected
        }

        /// Set the selected item by index.
        ///
        /// If the select-idx doesn't match the list of values,
        /// selected will be None. This may happen before the
        /// first render, while values is still empty.
        ///
        /// Use of set_value() is preferred.
        pub fn set_selected(&mut self, select: usize) -> bool {
            let old_sel = self.selected;
            if self.values.is_empty() {
                self.selected = None;
            } else {
                if let Some(value) = self.values.get(select) {
                    self.value = value.clone();
                    self.selected = Some(select);
                } else {
                    // don't change value
                    self.selected = None;
                }
            }
            old_sel != self.selected
        }

        /// Set the value for this Choice.
        ///
        /// The value will be retained even if it is not in
        /// the value-list. This can happen before the first
        /// render while the value-list is still empty.
        /// Or because a divergent value is set here.
        ///
        /// The starting value will be T::default().
        pub fn set_value(&mut self, value: T) -> bool {
            let old_value = self.value.clone();

            self.value = value;
            self.selected = self.values.iter().position(|v| *v == self.value);

            old_value != self.value
        }

        /// Return the selected value, or any value set with set_value()
        pub fn value(&self) -> T {
            self.value.clone()
        }

        pub fn is_empty(&self) -> bool {
            self.values.is_empty()
        }

        pub fn clear(&mut self) -> bool {
            let old_selected = self.selected;
            let old_value = self.value.clone();

            if let Some(default_value) = &self.default_value {
                self.value = default_value.clone();
            }

            self.selected = self.values.iter().position(|v| *v == self.value);

            old_selected != self.selected || old_value != self.value
        }
    }
}

impl Default for ChoiceStyle {
    fn default() -> Self {
        Self {
            style: Default::default(),
            button: Default::default(),
            select: Default::default(),
            select_marker: Default::default(),
            focus: Default::default(),
            block: Default::default(),
            border_style: Default::default(),
            title_style: Default::default(),
            popup: Default::default(),
            popup_style: Default::default(),
            popup_border: Default::default(),
            popup_scroll: Default::default(),
            popup_block: Default::default(),
            popup_len: Default::default(),
            behave_focus: Default::default(),
            behave_select: Default::default(),
            behave_close: Default::default(),
            non_exhaustive: NonExhaustive,
        }
    }
}

impl<T> Default for Choice<'_, T>
where
    T: PartialEq + Clone + Default,
{
    fn default() -> Self {
        Self {
            values: Default::default(),
            default_value: Default::default(),
            unknown_item: Default::default(),
            items: Default::default(),
            style: Default::default(),
            button_style: Default::default(),
            select_style: Default::default(),
            select_marker: Default::default(),
            focus_style: Default::default(),
            block: Default::default(),
            popup_len: Default::default(),
            popup_alignment: Alignment::Left,
            popup_placement: Placement::BelowOrAbove,
            popup: Default::default(),
            popup_style: Default::default(),
            popup_scroll: Default::default(),
            popup_block: Default::default(),
            behave_focus: Default::default(),
            behave_select: Default::default(),
            behave_close: Default::default(),
            skip_item_render: Default::default(),
        }
    }
}

impl<'a> Choice<'a, usize> {
    /// Add items with auto-generated values.
    #[inline]
    pub fn auto_items<V: Into<Line<'a>>>(self, items: impl IntoIterator<Item = V>) -> Self {
        {
            let mut values = self.values.borrow_mut();
            let mut itemz = self.items.borrow_mut();

            values.clear();
            itemz.clear();

            for (k, v) in items.into_iter().enumerate() {
                values.push(k);
                itemz.push(v.into());
            }
        }

        self
    }

    /// Add an item with an auto generated value.
    pub fn auto_item(self, item: impl Into<Line<'a>>) -> Self {
        let idx = self.values.borrow().len();
        self.values.borrow_mut().push(idx);
        self.items.borrow_mut().push(item.into());
        self
    }
}

impl<'a, T> Choice<'a, T>
where
    T: PartialEq + Clone + Default,
{
    pub fn new() -> Self {
        Self::default()
    }

    #[inline]
    pub fn unknown_item(mut self, unknown: impl Into<Line<'a>>) -> Self {
        self.unknown_item = Some(unknown.into());
        self
    }

    /// Button text.
    #[inline]
    pub fn items<V: Into<Line<'a>>>(self, items: impl IntoIterator<Item = (T, V)>) -> Self {
        {
            let mut values = self.values.borrow_mut();
            let mut itemz = self.items.borrow_mut();

            values.clear();
            itemz.clear();

            for (k, v) in items.into_iter() {
                values.push(k);
                itemz.push(v.into());
            }
        }

        self
    }

    /// Add an item.
    pub fn item(self, value: T, item: impl Into<Line<'a>>) -> Self {
        self.values.borrow_mut().push(value);
        self.items.borrow_mut().push(item.into());
        self
    }

    /// Can return to default with user interaction.
    pub fn default_value(mut self, default: T) -> Self {
        self.default_value = Some(default);
        self
    }

    /// Combined styles.
    pub fn styles(mut self, styles: ChoiceStyle) -> Self {
        self.style = styles.style;
        if styles.block.is_some() {
            self.block = styles.block;
        }
        if let Some(border_style) = styles.border_style {
            self.block = self.block.map(|v| v.border_style(border_style));
        }
        if let Some(title_style) = styles.title_style {
            self.block = self.block.map(|v| v.title_style(title_style));
        }
        self.block = self.block.map(|v| v.style(self.style));
        if styles.button.is_some() {
            self.button_style = styles.button;
        }
        if styles.select.is_some() {
            self.select_style = styles.select;
        }
        if let Some(marker) = styles.select_marker {
            self.select_marker = Some(marker);
        }
        if styles.focus.is_some() {
            self.focus_style = styles.focus;
        }
        if let Some(select) = styles.behave_focus {
            self.behave_focus = select;
        }
        if let Some(select) = styles.behave_select {
            self.behave_select = select;
        }
        if let Some(close) = styles.behave_close {
            self.behave_close = close;
        }
        if let Some(alignment) = styles.popup.alignment {
            self.popup_alignment = alignment;
        }
        if let Some(placement) = styles.popup.placement {
            self.popup_placement = placement;
        }
        self.popup = self.popup.styles(styles.popup.clone());
        if let Some(popup_style) = styles.popup_style {
            self.popup_style = popup_style;
        }
        if let Some(popup_scroll) = styles.popup_scroll {
            self.popup_scroll = self.popup_scroll.map(|v| v.styles(popup_scroll));
        }
        self.popup_block = self.popup_block.map(|v| v.style(self.popup_style));
        if let Some(border_style) = styles.popup_border {
            self.popup_block = self.popup_block.map(|v| v.border_style(border_style));
        }
        if styles.popup_block.is_some() {
            self.popup_block = styles.popup_block;
        }
        if styles.popup_len.is_some() {
            self.popup_len = styles.popup_len;
        }

        self
    }

    /// Base style.
    pub fn style(mut self, style: Style) -> Self {
        self.style = style;
        self.block = self.block.map(|v| v.style(self.style));
        self
    }

    /// Style for the down button.
    pub fn button_style(mut self, style: Style) -> Self {
        self.button_style = Some(style);
        self
    }

    /// Selection in the list.
    pub fn select_style(mut self, style: Style) -> Self {
        self.select_style = Some(style);
        self
    }

    /// Selection in the list.
    pub fn select_marker(mut self, marker: char) -> Self {
        self.select_marker = Some(marker);
        self
    }

    /// Focused style.
    pub fn focus_style(mut self, style: Style) -> Self {
        self.focus_style = Some(style);
        self
    }

    /// Block for the main widget.
    pub fn block(mut self, block: Block<'a>) -> Self {
        self.block = Some(block);
        self.block = self.block.map(|v| v.style(self.style));
        self
    }

    /// Skips rendering the selected item.
    /// This is a flag for Combobox, that wants to do its own rendering instead.
    pub fn skip_item_render(mut self, skip: bool) -> Self {
        self.skip_item_render = skip;
        self
    }

    /// Alignment of the popup.
    ///
    /// __Default__
    /// Default is Left.
    pub fn popup_alignment(mut self, alignment: Alignment) -> Self {
        self.popup_alignment = alignment;
        self
    }

    /// Placement of the popup.
    ///
    /// __Default__
    /// Default is BelowOrAbove.
    pub fn popup_placement(mut self, placement: Placement) -> Self {
        self.popup_placement = placement;
        self
    }

    /// Outer boundary for the popup.
    pub fn popup_boundary(mut self, boundary: Rect) -> Self {
        self.popup = self.popup.boundary(boundary);
        self
    }

    /// Override the popup length.
    ///
    /// __Default__
    /// Defaults to the number of items or 5.
    pub fn popup_len(mut self, len: u16) -> Self {
        self.popup_len = Some(len);
        self
    }

    /// Base style for the popup.
    pub fn popup_style(mut self, style: Style) -> Self {
        self.popup_style = style;
        self
    }

    /// Block for the popup.
    pub fn popup_block(mut self, block: Block<'a>) -> Self {
        self.popup_block = Some(block);
        self
    }

    /// Scroll for the popup.
    pub fn popup_scroll(mut self, scroll: Scroll<'a>) -> Self {
        self.popup_scroll = Some(scroll);
        self
    }

    /// Adds an extra offset to the widget area.
    ///
    /// This can be used to
    /// * place the widget under the mouse cursor.
    /// * align the widget not by the outer bounds but by
    ///   the text content.
    pub fn popup_offset(mut self, offset: (i16, i16)) -> Self {
        self.popup = self.popup.offset(offset);
        self
    }

    /// Sets only the x offset.
    /// See [offset](Self::popup_offset)
    pub fn popup_x_offset(mut self, offset: i16) -> Self {
        self.popup = self.popup.x_offset(offset);
        self
    }

    /// Sets only the y offset.
    /// See [offset](Self::popup_offset)
    pub fn popup_y_offset(mut self, offset: i16) -> Self {
        self.popup = self.popup.y_offset(offset);
        self
    }

    /// Sets the behaviour for selecting from the list.
    pub fn behave_focus(mut self, focus: ChoiceFocus) -> Self {
        self.behave_focus = focus;
        self
    }

    /// Sets the behaviour for selecting from the list.
    pub fn behave_select(mut self, select: ChoiceSelect) -> Self {
        self.behave_select = select;
        self
    }

    /// Sets the behaviour for closing the list.
    pub fn behave_close(mut self, close: ChoiceClose) -> Self {
        self.behave_close = close;
        self
    }

    /// Inherent width.
    pub fn width(&self) -> u16 {
        let w = self
            .items
            .borrow()
            .iter()
            .map(|v| v.width())
            .max()
            .unwrap_or_default();

        w as u16 + block_size(&self.block).width + 3
    }

    /// Inherent height.
    pub fn height(&self) -> u16 {
        1 + block_size(&self.block).height
    }

    /// Choice itself doesn't render.
    ///
    /// This builds the widgets from the parameters set for Choice.
    pub fn into_widgets(self) -> (ChoiceWidget<'a, T>, ChoicePopup<'a, T>) {
        (
            ChoiceWidget {
                values: self.values,
                default_value: self.default_value,
                unknown_item: self.unknown_item,
                items: self.items.clone(),
                style: self.style,
                button_style: self.button_style,
                focus_style: self.focus_style,
                block: self.block,
                skip_item_render: self.skip_item_render,
                len: self.popup_len,
                behave_focus: self.behave_focus,
                behave_select: self.behave_select,
                behave_close: self.behave_close,
            },
            ChoicePopup {
                items: self.items.clone(),
                style: self.style,
                select_style: self.select_style,
                select_marker: self.select_marker,
                popup: self.popup,
                popup_style: self.popup_style,
                popup_scroll: self.popup_scroll,
                popup_block: self.popup_block,
                popup_alignment: self.popup_alignment,
                popup_placement: self.popup_placement,
                popup_len: self.popup_len,
                _phantom: Default::default(),
            },
        )
    }
}

impl<'a, T> ChoiceWidget<'a, T>
where
    T: PartialEq + Clone + Default,
{
    /// Inherent width.
    pub fn width(&self) -> u16 {
        let w = self
            .items
            .borrow()
            .iter()
            .map(|v| v.width())
            .max()
            .unwrap_or_default();

        w as u16 + block_size(&self.block).width
    }

    /// Inherent height.
    pub fn height(&self) -> u16 {
        1 + block_size(&self.block).height
    }
}

impl<'a, T> StatefulWidget for &ChoiceWidget<'a, T>
where
    T: PartialEq + Clone + Default,
{
    type State = ChoiceState<T>;

    fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
        state.core.set_values(self.values.borrow().clone());
        if let Some(default_value) = self.default_value.clone() {
            state.core.set_default_value(Some(default_value));
        }

        render_choice(self, area, buf, state);
    }
}

impl<T> StatefulWidget for ChoiceWidget<'_, T>
where
    T: PartialEq + Clone + Default,
{
    type State = ChoiceState<T>;

    fn render(mut self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
        state.core.set_values(self.values.take());
        if let Some(default_value) = self.default_value.take() {
            state.core.set_default_value(Some(default_value));
        }

        render_choice(&self, area, buf, state);
    }
}

fn render_choice<T: PartialEq + Clone + Default>(
    widget: &ChoiceWidget<'_, T>,
    area: Rect,
    buf: &mut Buffer,
    state: &mut ChoiceState<T>,
) {
    state.area = area;
    state.behave_focus.set(widget.behave_focus);
    state.behave_select = widget.behave_select;
    state.behave_close = widget.behave_close;

    if !state.popup.is_active() {
        let len = widget
            .len
            .unwrap_or_else(|| min(5, widget.items.borrow().len()) as u16);
        state.popup_scroll.max_offset = widget.items.borrow().len().saturating_sub(len as usize);
        state.popup_scroll.page_len = len as usize;
        if let Some(selected) = state.core.selected() {
            state.popup_scroll.scroll_to_pos(selected);
        }
    }

    state.nav_char.clear();
    state.nav_char.extend(widget.items.borrow().iter().map(|v| {
        v.spans
            .first()
            .and_then(|v| v.content.as_ref().chars().next())
            .map_or(Vec::default(), |c| c.to_lowercase().collect::<Vec<_>>())
    }));

    state.inner = widget.block.inner_if_some(area);

    state.item_area = Rect::new(
        state.inner.x,
        state.inner.y,
        state.inner.width.saturating_sub(3),
        state.inner.height,
    );
    state.button_area = Rect::new(
        state
            .inner
            .right()
            .saturating_sub(min(3, state.inner.width)),
        state.inner.y,
        3,
        state.inner.height,
    );

    let style = widget.style;
    let focus_style = widget.focus_style.unwrap_or(revert_style(widget.style));

    if state.is_focused() {
        if let Some(block) = &widget.block {
            block.render(area, buf);
        } else {
            buf.set_style(state.inner, style);
        }
        buf.set_style(state.inner, focus_style);
    } else {
        if let Some(block) = &widget.block {
            block.render(area, buf);
        } else {
            buf.set_style(state.inner, style);
        }
        if let Some(button_style) = widget.button_style {
            buf.set_style(state.button_area, button_style);
        }
    }

    if !widget.skip_item_render {
        if let Some(selected) = state.core.selected() {
            if let Some(item) = widget.items.borrow().get(selected) {
                item.render(state.item_area, buf);
            }
        } else if let Some(unknown) = widget.unknown_item.as_ref() {
            unknown.render(state.item_area, buf);
        }
    }

    let dy = if (state.button_area.height & 1) == 1 {
        state.button_area.height / 2
    } else {
        state.button_area.height.saturating_sub(1) / 2
    };
    let bc = if state.is_popup_active() {
        " â—† "
    } else {
        " â–¼ "
    };
    Span::from(bc).render(
        Rect::new(state.button_area.x, state.button_area.y + dy, 3, 1),
        buf,
    );
}

impl<T> ChoicePopup<'_, T>
where
    T: PartialEq + Clone + Default,
{
    /// Calculate the layout for the popup before rendering.
    /// Area is the area of the ChoiceWidget not the ChoicePopup.
    pub fn layout(&self, area: Rect, buf: &mut Buffer, state: &mut ChoiceState<T>) -> Rect {
        if state.popup.is_active() {
            let len = min(
                self.popup_len.unwrap_or(5),
                self.items.borrow().len() as u16,
            );
            let padding = block_padding(&self.popup_block);
            let popup_len = len + padding.top + padding.bottom;
            let pop_area = Rect::new(0, 0, area.width, popup_len);

            self.popup
                .ref_constraint(
                    self.popup_placement
                        .into_constraint(self.popup_alignment, area),
                )
                .layout(pop_area, buf)
        } else {
            Rect::default()
        }
    }
}

impl<T> StatefulWidget for &ChoicePopup<'_, T>
where
    T: PartialEq + Clone + Default,
{
    type State = ChoiceState<T>;

    fn render(self, _area: Rect, buf: &mut Buffer, state: &mut Self::State) {
        render_popup(self, buf, state);
    }
}

impl<T> StatefulWidget for ChoicePopup<'_, T>
where
    T: PartialEq + Clone + Default,
{
    type State = ChoiceState<T>;

    fn render(self, _area: Rect, buf: &mut Buffer, state: &mut Self::State) {
        render_popup(&self, buf, state);
    }
}

fn render_popup<T: PartialEq + Clone + Default>(
    widget: &ChoicePopup<'_, T>,
    buf: &mut Buffer,
    state: &mut ChoiceState<T>,
) {
    if state.popup.is_active() {
        let popup_style = widget.popup_style;
        let select_style = widget.select_style.unwrap_or(revert_style(widget.style));

        {
            let area = state.area;

            let len = min(
                widget.popup_len.unwrap_or(5),
                widget.items.borrow().len() as u16,
            );
            let padding = block_padding(&widget.popup_block);
            let popup_len = len + padding.top + padding.bottom;
            let pop_area = Rect::new(0, 0, area.width, popup_len);

            widget
                .popup
                .ref_constraint(
                    widget
                        .popup_placement
                        .into_constraint(widget.popup_alignment, area),
                )
                .render(pop_area, buf, &mut state.popup);
        }

        let sa = ScrollArea::new()
            .style(fallback_popup_style(widget.popup_style))
            .block(widget.popup_block.as_ref())
            .v_scroll(widget.popup_scroll.as_ref());

        let inner = sa.inner(state.popup.area, None, Some(&state.popup_scroll));

        sa.render(
            state.popup.area,
            buf,
            &mut ScrollAreaState::new().v_scroll(&mut state.popup_scroll),
        );

        state.popup_scroll.max_offset = widget
            .items
            .borrow()
            .len()
            .saturating_sub(inner.height as usize);
        state.popup_scroll.page_len = inner.height as usize;

        state.item_areas.clear();
        let mut row = inner.y;
        let mut idx = state.popup_scroll.offset;

        let hidden_marker;
        let (marker_len, marker, no_marker) = {
            if let Some(marker) = widget.select_marker {
                hidden_marker = marker.to_string();
                if unicode_display_width::is_double_width(marker) {
                    (2, Some(hidden_marker.as_str()), Some("  "))
                } else {
                    (1, Some(hidden_marker.as_str()), Some(" "))
                }
            } else {
                (0, None, None)
            }
        };
        loop {
            if row >= inner.bottom() {
                break;
            }

            let item_area = Rect::new(inner.x, row, inner.width, 1);
            state.item_areas.push(item_area);

            let (style, marker) = if state.core.selected() == Some(idx) {
                (popup_style.patch(select_style), marker)
            } else {
                (popup_style, no_marker)
            };
            buf.set_style(item_area, style);

            if let Some(item) = widget.items.borrow().get(idx) {
                if let Some(marker) = &marker {
                    marker.render(
                        Rect::new(item_area.x, item_area.y, marker_len, item_area.height),
                        buf,
                    );
                    item.render(
                        Rect::new(
                            item_area.x + marker_len,
                            item_area.y,
                            item_area.width.saturating_sub(marker_len),
                            item_area.height,
                        ),
                        buf,
                    );
                } else {
                    item.render(item_area, buf);
                }
            } else {
                // noop
            }

            row += 1;
            idx += 1;
        }
    } else {
        state.popup.clear_areas();
    }
}

impl<T> Clone for ChoiceState<T>
where
    T: PartialEq + Clone + Default,
{
    fn clone(&self) -> Self {
        let popup = self.popup.clone();
        let behave_focus = Rc::new(Cell::new(self.behave_focus.get()));
        let focus = focus_cb(
            popup.active.clone(),
            behave_focus.clone(),
            self.focus.new_instance(),
        );

        Self {
            area: self.area,
            inner: self.inner,
            nav_char: self.nav_char.clone(),
            item_area: self.item_area,
            button_area: self.button_area,
            item_areas: self.item_areas.clone(),
            core: self.core.clone(),
            popup,
            popup_scroll: self.popup_scroll.clone(),
            behave_focus,
            behave_select: self.behave_select,
            behave_close: self.behave_close,
            focus,
            mouse: Default::default(),
            non_exhaustive: NonExhaustive,
        }
    }
}

impl<T> Default for ChoiceState<T>
where
    T: PartialEq + Clone + Default,
{
    fn default() -> Self {
        let popup = PopupCoreState::default();
        let behave_focus = Rc::new(Cell::new(ChoiceFocus::default()));
        let focus = focus_cb(
            popup.active.clone(),
            behave_focus.clone(),
            Default::default(),
        );

        Self {
            area: Default::default(),
            inner: Default::default(),
            nav_char: Default::default(),
            item_area: Default::default(),
            button_area: Default::default(),
            item_areas: Default::default(),
            core: Default::default(),
            popup,
            popup_scroll: Default::default(),
            behave_focus,
            behave_select: Default::default(),
            behave_close: Default::default(),
            focus,
            mouse: Default::default(),
            non_exhaustive: NonExhaustive,
        }
    }
}

fn focus_cb(
    active: Rc<Cell<bool>>,
    behave_focus: Rc<Cell<ChoiceFocus>>,
    flag: FocusFlag,
) -> FocusFlag {
    let active_clone = active.clone();
    flag.on_lost(move || {
        if active_clone.get() {
            active_clone.set(false);
        }
    });
    flag.on_gained(move || {
        if !active.get() {
            if behave_focus.get() == ChoiceFocus::OpenOnFocusGained {
                active.set(true);
            }
        }
    });
    flag
}

impl<T> HasFocus for ChoiceState<T>
where
    T: PartialEq + Clone + Default,
{
    fn build(&self, builder: &mut FocusBuilder) {
        builder.leaf_with_flags(self.focus(), self.area(), 0, self.navigable());
        builder.leaf_with_flags(self.focus(), self.popup.area, 1, Navigation::Mouse);
    }

    fn focus(&self) -> FocusFlag {
        self.focus.clone()
    }

    fn area(&self) -> Rect {
        self.area
    }
}

impl<T> HasScreenCursor for ChoiceState<T>
where
    T: PartialEq + Clone + Default,
{
    fn screen_cursor(&self) -> Option<(u16, u16)> {
        None
    }
}

impl<T> RelocatableState for ChoiceState<T>
where
    T: PartialEq + Clone + Default,
{
    fn relocate(&mut self, _shift: (i16, i16), _clip: Rect) {
        // relocate after the popup is rendered.
    }

    fn relocate_popup(&mut self, shift: (i16, i16), clip: Rect) {
        self.area.relocate(shift, clip);
        self.inner.relocate(shift, clip);
        self.item_area.relocate(shift, clip);
        self.button_area.relocate(shift, clip);
        self.item_areas.relocate(shift, clip);
        self.popup.relocate_popup(shift, clip);
        self.popup_scroll.relocate(shift, clip);
    }
}

impl<T> ChoiceState<T>
where
    T: PartialEq + Clone + Default,
{
    pub fn new() -> Self {
        Self::default()
    }

    pub fn named(name: &str) -> Self {
        let mut z = Self::default();
        z.focus = z.focus.with_name(name);
        z
    }

    /// Popup is active?
    pub fn is_popup_active(&self) -> bool {
        self.popup.is_active()
    }

    /// Flip the popup state.
    pub fn flip_popup_active(&mut self) {
        self.popup.flip_active();
    }

    /// Show the popup.
    pub fn set_popup_active(&mut self, active: bool) -> bool {
        self.popup.set_active(active)
    }

    /// Set a default-value other than T::default()
    ///
    /// The starting value will still be T::default()
    /// after this. You must call clear() to use this
    /// default.
    ///
    /// This default will be overridden by a default set
    /// on the widget.
    pub fn set_default_value(&mut self, default_value: Option<T>) {
        self.core.set_default_value(default_value);
    }

    /// A default value.
    pub fn default_value(&self) -> &Option<T> {
        self.core.default_value()
    }

    /// Select the given value.
    ///
    /// If the value doesn't exist in the list or the list is
    /// empty the value will still be set, but selected will be
    /// None. The list will be empty before the first render, but
    /// the first thing render will do is set the list of values.
    /// This will adjust the selected index if possible.
    /// It's still ok to set a value here that can not be represented.
    /// As long as there is no user interaction, the same value
    /// will be returned by value().
    pub fn set_value(&mut self, value: T) -> bool {
        self.core.set_value(value)
    }

    /// Get the selected value.
    pub fn value(&self) -> T {
        self.core.value()
    }

    /// Select the default value or T::default.
    pub fn clear(&mut self) -> bool {
        self.core.clear()
    }

    /// Select the value at index. This will set the value
    /// to the given index in the value-list. If the index is
    /// out of bounds or the value-list is empty it will
    /// set selected to None and leave the value as is.
    /// The list is empty before the first render so this
    /// may not work as expected.
    ///
    /// The selected index is a best effort artefact, the main
    /// thing is the value itself.
    ///
    /// Use of set_value() is preferred.
    pub fn select(&mut self, select: usize) -> bool {
        self.core.set_selected(select)
    }

    /// Returns the selected index or None if the
    /// value is not in the list or the list is empty.
    ///
    /// You can still get the value set with set_value() though.
    pub fn selected(&self) -> Option<usize> {
        self.core.selected()
    }

    /// Any items?
    pub fn is_empty(&self) -> bool {
        self.core.values().is_empty()
    }

    /// Number of items.
    pub fn len(&self) -> usize {
        self.core.values().len()
    }

    /// Scroll offset for the item list.
    pub fn clear_offset(&mut self) {
        self.popup_scroll.set_offset(0);
    }

    /// Scroll offset for the item list.
    pub fn set_offset(&mut self, offset: usize) -> bool {
        self.popup_scroll.set_offset(offset)
    }

    /// Scroll offset for the item list.
    pub fn offset(&self) -> usize {
        self.popup_scroll.offset()
    }

    /// Scroll offset for the item list.
    pub fn max_offset(&self) -> usize {
        self.popup_scroll.max_offset()
    }

    /// Page length for the item list.
    pub fn page_len(&self) -> usize {
        self.popup_scroll.page_len()
    }

    /// Scroll unit for the item list.
    pub fn scroll_by(&self) -> usize {
        self.popup_scroll.scroll_by()
    }

    /// Scroll the item list to the selected value.
    pub fn scroll_to_selected(&mut self) -> bool {
        if let Some(selected) = self.core.selected() {
            self.popup_scroll.scroll_to_pos(selected)
        } else {
            false
        }
    }
}

impl<T> ChoiceState<T>
where
    T: PartialEq + Clone + Default,
{
    /// Select by first character.
    pub fn select_by_char(&mut self, c: char) -> bool {
        if self.nav_char.is_empty() {
            return false;
        }
        let c = c.to_lowercase().collect::<Vec<_>>();

        let (mut idx, end_loop) = if let Some(idx) = self.core.selected() {
            (idx + 1, idx)
        } else {
            if self.nav_char[0] == c {
                self.core.set_selected(0);
                return true;
            } else {
                (1, 0)
            }
        };
        loop {
            if idx >= self.nav_char.len() {
                idx = 0;
            }
            if idx == end_loop {
                break;
            }

            if self.nav_char[idx] == c {
                self.core.set_selected(idx);
                return true;
            }

            idx += 1;
        }
        false
    }

    /// Select by first character. Reverse direction
    pub fn reverse_select_by_char(&mut self, c: char) -> bool {
        if self.nav_char.is_empty() {
            return false;
        }
        let c = c.to_lowercase().collect::<Vec<_>>();

        let (mut idx, end_loop) = if let Some(idx) = self.core.selected() {
            if idx == 0 {
                (self.nav_char.len() - 1, 0)
            } else {
                (idx - 1, idx)
            }
        } else {
            if self.nav_char.last() == Some(&c) {
                self.core.set_selected(self.nav_char.len() - 1);
                return true;
            } else {
                (self.nav_char.len() - 1, 0)
            }
        };
        loop {
            if self.nav_char[idx] == c {
                self.core.set_selected(idx);
                return true;
            }

            if idx == end_loop {
                break;
            }

            if idx == 0 {
                idx = self.nav_char.len() - 1;
            } else {
                idx -= 1;
            }
        }
        false
    }

    /// Select at position
    pub fn move_to(&mut self, n: usize) -> ChoiceOutcome {
        let old_selected = self.selected();
        let r1 = self.popup.set_active(true);
        let r2 = self.select(n);
        let r3 = self.scroll_to_selected();
        if old_selected != self.selected() {
            ChoiceOutcome::Value
        } else if r1 || r2 || r3 {
            ChoiceOutcome::Changed
        } else {
            ChoiceOutcome::Continue
        }
    }

    /// Select next entry.
    pub fn move_down(&mut self, n: usize) -> ChoiceOutcome {
        if self.core.is_empty() {
            return ChoiceOutcome::Continue;
        }

        let old_selected = self.selected();
        let r1 = self.popup.set_active(true);
        let idx = if let Some(idx) = self.core.selected() {
            idx + n
        } else {
            n.saturating_sub(1)
        };
        let idx = idx.clamp(0, self.len() - 1);
        let r2 = self.core.set_selected(idx);
        let r3 = self.scroll_to_selected();

        if old_selected != self.selected() {
            ChoiceOutcome::Value
        } else if r1 || r2 || r3 {
            ChoiceOutcome::Changed
        } else {
            ChoiceOutcome::Continue
        }
    }

    /// Select prev entry.
    pub fn move_up(&mut self, n: usize) -> ChoiceOutcome {
        if self.core.is_empty() {
            return ChoiceOutcome::Continue;
        }

        let old_selected = self.selected();
        let r1 = self.popup.set_active(true);
        let idx = if let Some(idx) = self.core.selected() {
            idx.saturating_sub(n)
        } else {
            0
        };
        let idx = idx.clamp(0, self.len() - 1);
        let r2 = self.core.set_selected(idx);
        let r3 = self.scroll_to_selected();

        if old_selected != self.selected() {
            ChoiceOutcome::Value
        } else if r1 || r2 || r3 {
            ChoiceOutcome::Changed
        } else {
            ChoiceOutcome::Continue
        }
    }
}

impl<T: PartialEq + Clone + Default> HandleEvent<Event, Regular, ChoiceOutcome> for ChoiceState<T> {
    fn handle(&mut self, event: &Event, _qualifier: Regular) -> ChoiceOutcome {
        self.handle(event, Popup)
    }
}

impl<T: PartialEq + Clone + Default> HandleEvent<Event, Popup, ChoiceOutcome> for ChoiceState<T> {
    fn handle(&mut self, event: &Event, _qualifier: Popup) -> ChoiceOutcome {
        let r = if self.is_focused() {
            match event {
                ct_event!(key press ' ') | ct_event!(keycode press Enter) => {
                    self.flip_popup_active();
                    ChoiceOutcome::Changed
                }
                ct_event!(keycode press Esc) => {
                    if self.set_popup_active(false) {
                        ChoiceOutcome::Changed
                    } else {
                        ChoiceOutcome::Continue
                    }
                }
                ct_event!(key press c) => {
                    if self.select_by_char(*c) {
                        self.scroll_to_selected();
                        ChoiceOutcome::Value
                    } else {
                        ChoiceOutcome::Continue
                    }
                }
                ct_event!(key press SHIFT-c) => {
                    if self.reverse_select_by_char(*c) {
                        self.scroll_to_selected();
                        ChoiceOutcome::Value
                    } else {
                        ChoiceOutcome::Continue
                    }
                }
                ct_event!(keycode press Delete) | ct_event!(keycode press Backspace) => {
                    if self.clear() {
                        ChoiceOutcome::Value
                    } else {
                        ChoiceOutcome::Continue
                    }
                }
                ct_event!(keycode press Down) => self.move_down(1),
                ct_event!(keycode press Up) => self.move_up(1),
                ct_event!(keycode press PageUp) => self.move_up(self.page_len()),
                ct_event!(keycode press PageDown) => self.move_down(self.page_len()),
                ct_event!(keycode press Home) => self.move_to(0),
                ct_event!(keycode press End) => self.move_to(self.len().saturating_sub(1)),
                _ => ChoiceOutcome::Continue,
            }
        } else {
            ChoiceOutcome::Continue
        };

        if !r.is_consumed() {
            self.handle(event, MouseOnly)
        } else {
            r
        }
    }
}

impl<T: PartialEq + Clone + Default> HandleEvent<Event, MouseOnly, ChoiceOutcome>
    for ChoiceState<T>
{
    fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> ChoiceOutcome {
        let r0 = handle_mouse(self, event);
        let r1 = handle_select(self, event);
        let r2 = handle_close(self, event);

        let r = max(r0, max(r1, r2));
        r.or_else(|| mouse_trap(event, self.popup.area).into())
    }
}

fn handle_mouse<T: PartialEq + Clone + Default>(
    state: &mut ChoiceState<T>,
    event: &Event,
) -> ChoiceOutcome {
    match event {
        ct_event!(mouse down Left for x,y)
        | ct_event!(mouse down Right for x,y)
        | ct_event!(mouse down Middle for x,y)
            if !state.item_area.contains((*x, *y).into())
                && !state.button_area.contains((*x, *y).into()) =>
        {
            match state.popup.handle(event, Popup) {
                PopupOutcome::Hide => {
                    state.set_popup_active(false);
                    return ChoiceOutcome::Changed;
                }
                _ => {}
            }
        }
        _ => {}
    }

    if !state.has_mouse_focus() {
        return ChoiceOutcome::Continue;
    }

    match event {
        ct_event!(mouse down Left for x,y)
            if state.item_area.contains((*x, *y).into())
                || state.button_area.contains((*x, *y).into()) =>
        {
            if !state.gained_focus() {
                state.flip_popup_active();
                ChoiceOutcome::Changed
            } else {
                // hide is down by self.popup.handle() as this click
                // is outside the popup area!!
                ChoiceOutcome::Continue
            }
        }
        _ => ChoiceOutcome::Continue,
    }
}

fn handle_select<T: PartialEq + Clone + Default>(
    state: &mut ChoiceState<T>,
    event: &Event,
) -> ChoiceOutcome {
    if !state.has_mouse_focus() {
        return ChoiceOutcome::Continue;
    }

    match state.behave_select {
        ChoiceSelect::MouseScroll => {
            let mut sas = ScrollAreaState::new()
                .area(state.popup.area)
                .v_scroll(&mut state.popup_scroll);
            let mut r = match sas.handle(event, MouseOnly) {
                ScrollOutcome::Up(n) => state.move_up(n),
                ScrollOutcome::Down(n) => state.move_down(n),
                ScrollOutcome::VPos(n) => state.move_to(n),
                _ => ChoiceOutcome::Continue,
            };

            r = r.or_else(|| match event {
                ct_event!(mouse down Left for x,y)
                    if state.popup.area.contains((*x, *y).into()) =>
                {
                    if let Some(n) = item_at(&state.item_areas, *x, *y) {
                        state.move_to(state.offset() + n)
                    } else {
                        ChoiceOutcome::Unchanged
                    }
                }
                ct_event!(mouse drag Left for x,y)
                    if state.popup.area.contains((*x, *y).into()) =>
                {
                    if let Some(n) = item_at(&state.item_areas, *x, *y) {
                        state.move_to(state.offset() + n)
                    } else {
                        ChoiceOutcome::Unchanged
                    }
                }
                _ => ChoiceOutcome::Continue,
            });
            r
        }
        ChoiceSelect::MouseMove => {
            // effect: move the content below the mouse and keep visible selection.
            let mut r = if let Some(selected) = state.core.selected() {
                let rel_sel = selected.saturating_sub(state.offset());
                let mut sas = ScrollAreaState::new()
                    .area(state.popup.area)
                    .v_scroll(&mut state.popup_scroll);
                match sas.handle(event, MouseOnly) {
                    ScrollOutcome::Up(n) => {
                        state.popup_scroll.scroll_up(n);
                        if state.select(state.offset() + rel_sel) {
                            ChoiceOutcome::Value
                        } else {
                            ChoiceOutcome::Unchanged
                        }
                    }
                    ScrollOutcome::Down(n) => {
                        state.popup_scroll.scroll_down(n);
                        if state.select(state.offset() + rel_sel) {
                            ChoiceOutcome::Value
                        } else {
                            ChoiceOutcome::Unchanged
                        }
                    }
                    ScrollOutcome::VPos(n) => {
                        if state.popup_scroll.set_offset(n) {
                            ChoiceOutcome::Value
                        } else {
                            ChoiceOutcome::Unchanged
                        }
                    }
                    _ => ChoiceOutcome::Continue,
                }
            } else {
                ChoiceOutcome::Continue
            };

            r = r.or_else(|| match event {
                ct_event!(mouse moved for x,y) if state.popup.area.contains((*x, *y).into()) => {
                    if let Some(n) = item_at(&state.item_areas, *x, *y) {
                        state.move_to(state.offset() + n)
                    } else {
                        ChoiceOutcome::Unchanged
                    }
                }
                _ => ChoiceOutcome::Continue,
            });
            r
        }
        ChoiceSelect::MouseClick => {
            // effect: move the content below the mouse and keep visible selection.
            let mut sas = ScrollAreaState::new()
                .area(state.popup.area)
                .v_scroll(&mut state.popup_scroll);
            let mut r = match sas.handle(event, MouseOnly) {
                ScrollOutcome::Up(n) => {
                    if state.popup_scroll.scroll_up(n) {
                        ChoiceOutcome::Changed
                    } else {
                        ChoiceOutcome::Unchanged
                    }
                }
                ScrollOutcome::Down(n) => {
                    if state.popup_scroll.scroll_down(n) {
                        ChoiceOutcome::Changed
                    } else {
                        ChoiceOutcome::Unchanged
                    }
                }
                ScrollOutcome::VPos(n) => {
                    if state.popup_scroll.set_offset(n) {
                        ChoiceOutcome::Changed
                    } else {
                        ChoiceOutcome::Unchanged
                    }
                }
                _ => ChoiceOutcome::Continue,
            };

            r = r.or_else(|| match event {
                ct_event!(mouse down Left for x,y)
                    if state.popup.area.contains((*x, *y).into()) =>
                {
                    if let Some(n) = item_at(&state.item_areas, *x, *y) {
                        state.move_to(state.offset() + n)
                    } else {
                        ChoiceOutcome::Unchanged
                    }
                }
                ct_event!(mouse drag Left for x,y)
                    if state.popup.area.contains((*x, *y).into()) =>
                {
                    if let Some(n) = item_at(&state.item_areas, *x, *y) {
                        state.move_to(state.offset() + n)
                    } else {
                        ChoiceOutcome::Unchanged
                    }
                }
                _ => ChoiceOutcome::Continue,
            });
            r
        }
    }
}

fn handle_close<T: PartialEq + Clone + Default>(
    state: &mut ChoiceState<T>,
    event: &Event,
) -> ChoiceOutcome {
    if !state.has_mouse_focus() {
        return ChoiceOutcome::Continue;
    }

    match state.behave_close {
        ChoiceClose::SingleClick => match event {
            ct_event!(mouse down Left for x,y) if state.popup.area.contains((*x, *y).into()) => {
                if let Some(n) = item_at(&state.item_areas, *x, *y) {
                    let r = state.move_to(state.offset() + n);
                    let s = if state.set_popup_active(false) {
                        ChoiceOutcome::Changed
                    } else {
                        ChoiceOutcome::Unchanged
                    };
                    max(r, s)
                } else {
                    ChoiceOutcome::Unchanged
                }
            }
            _ => ChoiceOutcome::Continue,
        },
        ChoiceClose::DoubleClick => match event {
            ct_event!(mouse any for m) if state.mouse.doubleclick(state.popup.area, m) => {
                if let Some(n) = item_at(&state.item_areas, m.column, m.row) {
                    let r = state.move_to(state.offset() + n);
                    let s = if state.set_popup_active(false) {
                        ChoiceOutcome::Changed
                    } else {
                        ChoiceOutcome::Unchanged
                    };
                    max(r, s)
                } else {
                    ChoiceOutcome::Unchanged
                }
            }
            _ => ChoiceOutcome::Continue,
        },
    }
}

/// Handle events for the popup.
/// Call before other handlers to deal with intersections
/// with other widgets.
pub fn handle_events<T: PartialEq + Clone + Default>(
    state: &mut ChoiceState<T>,
    focus: bool,
    event: &Event,
) -> ChoiceOutcome {
    state.focus.set(focus);
    HandleEvent::handle(state, event, Popup)
}

/// Handle only mouse-events.
pub fn handle_mouse_events<T: PartialEq + Clone + Default>(
    state: &mut ChoiceState<T>,
    event: &Event,
) -> ChoiceOutcome {
    HandleEvent::handle(state, event, MouseOnly)
}