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

/// Orbital material treatment for a surface root.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum MaterialVariant {
    /// Opaque surface using neutral background tokens.
    #[default]
    Solid,
    /// Semi-transparent frosted glass for transient overlays and popovers.
    Frost,
    /// Opaque shell base layer with subtle wallpaper tint (app chrome).
    Shell,
    /// Translucent dimming scrim behind modals.
    Scrim,
    /// Flat bordered surface — stroke outline, typically paired with [`MaterialElevation::Flat`].
    Outlined,
}

/// Corner treatment for the surface root.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum MaterialCorners {
    /// Default rounded corners (`--orb-radius-md`).
    #[default]
    Rounded,
    /// Square corners (`border-radius: 0`).
    Square,
}

/// Orbital elevation tier mapped to shadow CSS variables.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum MaterialElevation {
    /// No shadow — flush with the parent plane.
    Flat,
    /// Default lift (`--orb-elev-raised-sm`) for cards and panels at rest.
    #[default]
    Resting,
    /// Raised lift (`--orb-elev-raised-md`) for emphasized surfaces.
    Raised,
    /// Floating lift (`--orb-elev-floating`) for popovers and callouts.
    Floating,
    /// Modal lift (`--orb-elev-modal`) for dialogs and blocking overlays.
    Modal,
}

impl MaterialVariant {
    pub const fn as_data(self) -> &'static str {
        match self {
            Self::Solid => "solid",
            Self::Frost => "frost",
            Self::Shell => "shell",
            Self::Scrim => "scrim",
            Self::Outlined => "outlined",
        }
    }

    pub const fn modifier_class(self) -> &'static str {
        match self {
            Self::Solid => "orbital-material--solid",
            Self::Frost => "orbital-material--frost",
            Self::Shell => "orbital-material--shell",
            Self::Scrim => "orbital-material--scrim",
            Self::Outlined => "orbital-material--outlined",
        }
    }
}

impl MaterialCorners {
    pub const fn as_data(self) -> &'static str {
        match self {
            Self::Rounded => "rounded",
            Self::Square => "square",
        }
    }

    pub const fn modifier_class(self) -> &'static str {
        match self {
            Self::Rounded => "orbital-material--rounded",
            Self::Square => "orbital-material--square",
        }
    }
}

impl MaterialElevation {
    pub const fn shadow_token(self) -> &'static str {
        match self {
            Self::Flat => "none",
            Self::Resting => "var(--orb-elev-raised-sm)",
            Self::Raised => "var(--orb-elev-raised-md)",
            Self::Floating => "var(--orb-elev-floating)",
            Self::Modal => "var(--orb-elev-modal)",
        }
    }

    pub const fn as_data(self) -> &'static str {
        match self {
            Self::Flat => "flat",
            Self::Resting => "resting",
            Self::Raised => "raised",
            Self::Floating => "floating",
            Self::Modal => "modal",
        }
    }

    pub const fn modifier_class(self) -> &'static str {
        match self {
            Self::Flat => "orbital-material--elev-flat",
            Self::Resting => "orbital-material--elev-resting",
            Self::Raised => "orbital-material--elev-raised",
            Self::Floating => "orbital-material--elev-floating",
            Self::Modal => "orbital-material--elev-modal",
        }
    }
}