yew-nav-link 0.9.0

Navigation link component for Yew with automatic active state detection
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

//! # `NavDivider`
//!
//! Semantic separator for dividing sections within a navigation list.
//! Renders a `<li>` with `role="separator"` and an optional text label.
//!
//! # Example
//!
//! ```rust
//! use yew::prelude::*;
//! use yew_nav_link::{NavDivider, NavItem, NavLink, NavList};
//! use yew_router::prelude::*;
//!
//! # #[derive(Clone, PartialEq, Routable)]
//! # enum Route {
//! #     #[at("/")]
//! #     Home,
//! #     #[at("/about")]
//! #     About,
//! # }
//! #[component]
//! fn Nav() -> Html {
//!     html! {
//!         <NavList>
//!             <NavItem><NavLink<Route> to={Route::Home}>{ "Home" }</NavLink<Route>></NavItem>
//!             <NavDivider />
//!             <NavItem><NavLink<Route> to={Route::About}>{ "About" }</NavLink<Route>></NavItem>
//!         </NavList>
//!     }
//! }
//! ```
//!
//! # CSS Classes
//!
//! | Class | Condition |
//! |-------|-----------|
//! | `nav-divider` | Always applied |
//! | `nav-divider-vertical` | Applied when `vertical` is `true` |
//! | `nav-divider-text` | Inner text span when `text` is set |
//!
//! # Props
//!
//! | Prop | Type | Default | Description |
//! |------|------|---------|-------------|
//! | `text` | `Option<&'static str>` | `None` | Optional text label |
//! | `vertical` | `bool` | `false` | Vertical divider style |
//! | `classes` | `Classes` | — | Additional CSS classes |

use yew::prelude::*;

/// Properties for the [`NavDivider`] component.
///
/// | Prop | Type | Default | Description |
/// |------|------|---------|-------------|
/// | `text` | `Option<&'static str>` | `None` | Optional text label |
/// | `vertical` | `bool` | `false` | Vertical divider style |
/// | `classes` | `Classes` | — | Additional CSS classes |
#[derive(Properties, Clone, PartialEq, Eq, Debug, Default)]
pub struct NavDividerProps {
    /// Additional CSS classes applied to the divider.
    #[prop_or_default]
    pub classes: Classes,

    /// Whether to render a vertical divider instead of horizontal.
    #[prop_or_default]
    pub vertical: bool,

    /// Optional text label displayed in the center of the divider.
    #[prop_or_default]
    pub text: Option<&'static str>
}

/// Semantic separator for dividing sections within a navigation list.
///
/// Renders a `<li>` element with `role="separator"`.
///
/// # CSS Classes
///
/// - `nav-divider` - Always applied
/// - `nav-divider-vertical` - Applied when `vertical` is `true`
/// - `nav-divider-text` - Applied to inner text span when `text` is set
#[function_component]
pub fn NavDivider(props: &NavDividerProps) -> Html {
    let mut classes = props.classes.clone();

    classes.push("nav-divider");
    if props.vertical {
        classes.push("nav-divider-vertical");
    }

    if let Some(text) = props.text {
        html! {
            <li {classes} role="separator">
                <span class="nav-divider-text">{ text }</span>
            </li>
        }
    } else {
        html! {
            <li {classes} role="separator" />
        }
    }
}

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

    #[test]
    fn nav_divider_props_default() {
        let props = NavDividerProps {
            classes:  Classes::default(),
            vertical: false,
            text:     None
        };

        assert!(!props.vertical);
        assert!(props.text.is_none());
    }

    #[test]
    fn nav_divider_props_vertical() {
        let props = NavDividerProps {
            classes:  Classes::default(),
            vertical: true,
            text:     None
        };

        assert!(props.vertical);
    }

    #[test]
    fn nav_divider_props_with_text() {
        let props = NavDividerProps {
            classes:  Classes::default(),
            vertical: false,
            text:     Some("Or")
        };

        assert_eq!(props.text, Some("Or"));
    }

    #[test]
    fn nav_divider_props_clone() {
        let props1 = NavDividerProps {
            classes:  Classes::from("custom"),
            vertical: true,
            text:     Some("Divider")
        };

        let props2 = props1.clone();
        assert_eq!(props1.vertical, props2.vertical);
        assert_eq!(props1.text, props2.text);
        assert_eq!(props1.classes, props2.classes);
    }

    #[test]
    fn nav_divider_equality() {
        let default = NavDividerProps::default();
        let with_class = NavDividerProps {
            classes: Classes::from("custom"),
            ..Default::default()
        };

        assert_ne!(default.classes, with_class.classes);
    }
}