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

//! # `PageItem`
//!
//! A single page button within a [`Pagination`](super::Pagination) component.
//! Renders an `<li>` with the `page-item` class and active/disabled state.
//!
//! # Example
//!
//! ```rust
//! use yew::prelude::*;
//! use yew_nav_link::components::{PageItem, PageLink};
//!
//! #[component]
//! fn PaginationNav() -> Html {
//!     html! {
//!         <nav><ul class="pagination">
//!             <PageItem page={1} active=true>
//!                 <PageLink href={None}>{ "1" }</PageLink>
//!             </PageItem>
//!             <PageItem page={2}>
//!                 <PageLink href={Some("/page/2")}>{ "2" }</PageLink>
//!             </PageItem>
//!         </ul></nav>
//!     }
//! }
//! ```
//!
//! # CSS Classes
//!
//! | Class | Condition |
//! |-------|-----------|
//! | `page-item` | Always applied |
//! | `active` | Applied when `active` is `true` |
//! | `disabled` | Applied when `disabled` is `true` |
//!
//! # Props
//!
//! | Prop | Type | Default | Description |
//! |------|------|---------|-------------|
//! | `page` | `u32` | — | Page number (required) |
//! | `active` | `bool` | `false` | Currently active page |
//! | `disabled` | `bool` | `false` | Disabled state |
//! | `classes` | `Classes` | — | Additional CSS classes |
//! | `children` | `Children` | — | Content |

use yew::prelude::*;

/// Properties for the [`PageItem`] component.
///
/// | Prop | Type | Default | Description |
/// |------|------|---------|-------------|
/// | `page` | `u32` | — | Page number (required) |
/// | `active` | `bool` | `false` | Currently active page |
/// | `disabled` | `bool` | `false` | Disabled state |
/// | `classes` | `Classes` | — | Additional CSS classes |
/// | `children` | `Children` | — | Content |
#[derive(Properties, Clone, PartialEq, Debug)]
pub struct PageItemProps {
    /// Additional CSS classes applied to the page item.
    #[prop_or_default]
    pub classes: Classes,

    /// Page number this item represents.
    pub page: u32,

    /// Whether this page item is the currently active page.
    #[prop_or(false)]
    pub active: bool,

    /// Whether this page item is disabled (e.g. an ellipsis).
    #[prop_or(false)]
    pub disabled: bool,

    /// Content rendered inside the page item.
    #[prop_or_default]
    pub children: Children
}

/// A single page button within a [`Pagination`](super::Pagination) component.
///
/// # CSS Classes
///
/// - `page-item` - Always applied
/// - `active` - Applied when `active` is `true`
/// - `disabled` - Applied when `disabled` is `true`
#[function_component]
pub fn PageItem(props: &PageItemProps) -> Html {
    let mut classes = props.classes.clone();
    classes.push("page-item");

    if props.active {
        classes.push("active");
    }

    if props.disabled {
        classes.push("disabled");
    }

    html! {
        <li {classes}>
            <span class="page-link">
                { for props.children.iter() }
            </span>
        </li>
    }
}

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

    #[test]
    fn page_item_props() {
        let props = PageItemProps {
            classes:  Classes::default(),
            page:     1,
            active:   false,
            disabled: false,
            children: Children::new(vec![])
        };

        assert_eq!(props.page, 1);
        assert!(!props.active);
        assert!(!props.disabled);
    }
}