freyr 0.2.8

A UI component library for Dioxus web.
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

use dioxus::prelude::*;
/// Configuration options for the **`Navbar`** component, including color schemes and menu settings.

/// Represents different background color schemes for the navbar.
#[derive(PartialEq, Clone)]
pub enum ColorScheme {
    Freyr,
    Dark,
    Light,
    Custom(&'static str),
}

#[derive(PartialEq, Clone)]
pub enum Orientation {
    Left,
    Center,
    Right,
}

#[derive(PartialEq, Clone)]
pub enum HeaderColor {
    Freyr,
    Dark,
    Light,
    Custom(&'static str),
}

impl ColorScheme {
    /// Returns the CSS class or custom color for the background.
    pub fn as_css_class(&self) -> &'static str {
        match self {
            ColorScheme::Freyr => "#3795BD",
            ColorScheme::Dark => "#222",
            ColorScheme::Light => "#fff",
            ColorScheme::Custom(color) => color,
        }
    }
}

impl HeaderColor {
    /// Returns the CSS class or custom color for the background.
    pub fn as_css_class(&self) -> &'static str {
        match self {
            HeaderColor::Freyr => "#3795BD",
            HeaderColor::Dark => "#222",
            HeaderColor::Light => "#fff",
            HeaderColor::Custom(color) => color,
        }
    }
}

/// Defines different color options for navigation items.
#[derive(PartialEq, Clone)]
pub enum NavItemsColor {
    Freyr,
    Dark,
    Light,
    Custom(&'static str),
}

impl NavItemsColor {
    /// Returns the CSS class or custom color for the navigation items.
    pub fn as_css_class(&self) -> &'static str {
        match self {
            NavItemsColor::Freyr => "#3795BD",
            NavItemsColor::Dark => "#000",
            NavItemsColor::Light => "#fff",
            NavItemsColor::Custom(color) => color,
        }
    }
}

/// Specifies color options for the menu icons (hamburger and cross).
#[derive(PartialEq, Clone)]
pub enum IconColor {
    Freyr,
    White,
    Black,
    Custom(&'static str),
}

impl IconColor {
    /// Returns the CSS class or custom color for the icons.
    pub fn as_css_class(&self) -> &'static str {
        match self {
            IconColor::Freyr => "#3795BD",
            IconColor::White => "#fff",
            IconColor::Black => "#000",
            IconColor::Custom(color) => color,
        }
    }
}

/// Represents a dropdown configuration with its label and items.
#[derive(PartialEq, Clone)]
pub struct DropdownConfigNavBar {
    pub label: String,
    pub title: Option<String>,
    pub items: Vec<(String, String)>,
    pub background_color: Option<ColorScheme>,
    pub title_color: Option<NavItemsColor>,
    pub item_color: Option<NavItemsColor>,
}

impl DropdownConfigNavBar {
    pub fn new(
        label: String,
        items: Vec<(String, String)>,
        title: Option<String>,
        background_color: Option<ColorScheme>,
        title_color: Option<NavItemsColor>,
        item_color: Option<NavItemsColor>,
    ) -> Self {
        Self {
            label,
            items,
            title,
            background_color,
            title_color,
            item_color,
        }
    }
}

/// Configuration struct for the **`Navbar`** component.
#[derive(PartialEq, Clone)]
pub struct NavbarConfig {
    pub background_color: ColorScheme,
    pub header_color: HeaderColor,
    pub nav_header: Option<String>,
    pub nav_items: Vec<String>,
    pub nav_links: Vec<String>,
    pub nav_item_color: NavItemsColor,
    pub icon_color: IconColor,
    pub orientation: Option<Orientation>,
}

/// Configuration struct for the **`NavbarWithLogo`** component.
#[derive(PartialEq, Clone)]
pub struct NavbarWithLogoConfig {
    pub background_color: ColorScheme,
    pub nav_items: Vec<String>,
    pub nav_links: Vec<String>,
    pub nav_item_color: NavItemsColor,
    pub icon_color: IconColor,
    pub logo_url: String,
    pub logo_src: Asset,
    pub logo_alt: String,
    pub orientation: Option<Orientation>,
}

/// Configuration struct for the **`NavbarDropdown`** component.
#[derive(PartialEq, Clone)]
pub struct NavbarDropdownConfig {
    pub background_color: ColorScheme,
    pub nav_header: Option<String>,
    pub header_color: HeaderColor,
    pub nav_items: Vec<String>,
    pub nav_links: Vec<String>,
    pub nav_item_color: NavItemsColor,
    pub icon_color: IconColor,
    pub dropdowns: Vec<DropdownConfigNavBar>,
    pub orientation: Option<Orientation>,
}