orbital-base-components 0.1.1

Headless base primitives for Orbital — structure, semantics, and accessibility
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

use crate::overlay::{
    appearance::OverlayAppearance, arrow::OverlayArrowMode, panel::OverlayPanelSize,
    placement::Placement, trigger::OverlayTriggerType, visibility::HOVER_HIDE_DELAY_MS,
};
use orbital_motion::MotionSlot;

#[derive(Debug, Clone, Copy)]
pub struct AnchoredOverlayConfig {
    pub trigger_type: OverlayTriggerType,
    pub placement: Placement,
    pub appearance: OverlayAppearance,
    pub arrow: OverlayArrowMode,
    pub auto_height: bool,
    pub panel_size: Option<OverlayPanelSize>,
    pub motion: MotionSlot,
    /// Milliseconds before a hover overlay opens (`0` = immediate).
    pub show_delay_ms: u64,
    /// Milliseconds before a hover overlay closes after pointer leave.
    pub hide_delay_ms: u64,
}

impl Default for AnchoredOverlayConfig {
    fn default() -> Self {
        Self {
            trigger_type: OverlayTriggerType::Hover,
            placement: Placement::Top,
            appearance: OverlayAppearance::Default,
            arrow: OverlayArrowMode::None,
            auto_height: false,
            panel_size: None,
            motion: None,
            show_delay_ms: 0,
            hide_delay_ms: HOVER_HIDE_DELAY_MS,
        }
    }
}

pub struct TooltipVariant;

impl TooltipVariant {
    pub fn config() -> AnchoredOverlayConfig {
        AnchoredOverlayConfig {
            trigger_type: OverlayTriggerType::Hover,
            placement: Placement::Top,
            appearance: OverlayAppearance::Normal,
            arrow: OverlayArrowMode::Tooltip,
            auto_height: false,
            panel_size: None,
            motion: None,
            show_delay_ms: 0,
            hide_delay_ms: HOVER_HIDE_DELAY_MS,
        }
    }
}

pub struct PopoverVariant;

impl PopoverVariant {
    pub fn config() -> AnchoredOverlayConfig {
        AnchoredOverlayConfig {
            trigger_type: OverlayTriggerType::Hover,
            placement: Placement::Top,
            appearance: OverlayAppearance::Default,
            arrow: OverlayArrowMode::Popover,
            auto_height: false,
            panel_size: Some(OverlayPanelSize::Medium),
            motion: None,
            show_delay_ms: 0,
            hide_delay_ms: HOVER_HIDE_DELAY_MS,
        }
    }
}

pub struct MenuVariant;

impl MenuVariant {
    pub fn config() -> AnchoredOverlayConfig {
        AnchoredOverlayConfig {
            trigger_type: OverlayTriggerType::Click,
            placement: Placement::Bottom,
            appearance: OverlayAppearance::Default,
            arrow: OverlayArrowMode::None,
            auto_height: true,
            panel_size: None,
            motion: None,
            show_delay_ms: 0,
            hide_delay_ms: HOVER_HIDE_DELAY_MS,
        }
    }
}

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

    #[test]
    fn tooltip_variant_is_hover_with_arrow() {
        let config = TooltipVariant::config();
        assert_eq!(config.trigger_type, OverlayTriggerType::Hover);
        assert_eq!(config.arrow, OverlayArrowMode::Tooltip);
    }

    #[test]
    fn menu_variant_is_click_with_auto_height() {
        let config = MenuVariant::config();
        assert_eq!(config.trigger_type, OverlayTriggerType::Click);
        assert!(config.auto_height);
        assert_eq!(config.arrow, OverlayArrowMode::None);
    }

    #[test]
    fn popover_variant_has_panel_size() {
        let config = PopoverVariant::config();
        assert_eq!(config.arrow, OverlayArrowMode::Popover);
        assert_eq!(config.panel_size, Some(OverlayPanelSize::Medium));
    }
}