damascene-core 0.6.0

Damascene — backend-agnostic UI library core
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

//! Breadcrumb anatomy — shadcn-shaped path navigation.

// Lock in full per-item documentation for this module (issue #73).
#![warn(missing_docs)]

use std::panic::Location;

use crate::cursor::Cursor;
use crate::tokens;
use crate::tree::*;
use crate::widgets::text::text;

/// Breadcrumb root (shadcn's `Breadcrumb`) — a centered inline row;
/// fill it with a [`breadcrumb_list`] or items directly.
#[track_caller]
pub fn breadcrumb<I, E>(children: I) -> El
where
    I: IntoIterator<Item = E>,
    E: Into<El>,
{
    row(children)
        .at_loc(Location::caller())
        .width(Size::Hug)
        .height(Size::Hug)
        .gap(tokens::SPACE_2)
        .align(Align::Center)
}

/// Row of [`breadcrumb_item`]s interleaved with
/// [`breadcrumb_separator`]s (shadcn's `BreadcrumbList`).
#[track_caller]
pub fn breadcrumb_list<I, E>(children: I) -> El
where
    I: IntoIterator<Item = E>,
    E: Into<El>,
{
    row(children)
        .at_loc(Location::caller())
        .width(Size::Hug)
        .height(Size::Hug)
        .gap(tokens::SPACE_2)
        .align(Align::Center)
}

/// Wrapper around one path segment (shadcn's `BreadcrumbItem`) —
/// typically holds a [`breadcrumb_link`] or [`breadcrumb_page`].
#[track_caller]
pub fn breadcrumb_item(child: impl Into<El>) -> El {
    row([child.into()])
        .at_loc(Location::caller())
        .width(Size::Hug)
        .height(Size::Hug)
        .align(Align::Center)
}

/// A navigable ancestor segment (shadcn's `BreadcrumbLink`) — muted
/// text that routes clicks (and keyboard activation — the link is
/// focusable, like [`crate::widgets::pagination::pagination_previous`])
/// to `key`.
#[track_caller]
pub fn breadcrumb_link(key: impl Into<String>, label: impl Into<String>) -> El {
    text(label)
        .at_loc(Location::caller())
        .key(key)
        .focusable()
        .small()
        .muted()
        .ellipsis()
        .cursor(Cursor::Pointer)
        .width(Size::Hug)
}

/// The current, non-clickable segment (shadcn's `BreadcrumbPage`) —
/// semibold foreground text.
#[track_caller]
pub fn breadcrumb_page(label: impl Into<String>) -> El {
    text(label)
        .at_loc(Location::caller())
        .small()
        .semibold()
        .ellipsis()
        .width(Size::Hug)
}

/// Muted `/` between segments (shadcn's `BreadcrumbSeparator`).
#[track_caller]
pub fn breadcrumb_separator() -> El {
    text("/")
        .at_loc(Location::caller())
        .small()
        .muted()
        .width(Size::Hug)
}

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

    #[test]
    fn breadcrumb_list_centers_inline_items() {
        let crumbs = breadcrumb_list([
            breadcrumb_item(breadcrumb_link("crumb-projects", "Projects")),
            breadcrumb_separator(),
            breadcrumb_item(breadcrumb_page("Damascene")),
        ]);

        assert_eq!(crumbs.axis, Axis::Row);
        assert_eq!(crumbs.align, Align::Center);
        assert_eq!(crumbs.gap, tokens::SPACE_2);
        assert_eq!(crumbs.children.len(), 3);
    }

    #[test]
    fn breadcrumb_link_and_page_have_distinct_treatments() {
        let link = breadcrumb_link("crumb-projects", "Projects");
        let page = breadcrumb_page("Damascene");

        assert_eq!(link.text_color, Some(tokens::MUTED_FOREGROUND));
        assert_eq!(link.cursor, Some(Cursor::Pointer));
        assert_eq!(page.font_weight, FontWeight::Semibold);
    }
}