dioxus-bootstrap-css 0.3.1

Bootstrap 5.3 components for Dioxus — type-safe RSX wrappers powered by Bootstrap CSS
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

use dioxus::prelude::*;

use crate::types::Color;

/// Bootstrap theme mode.
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub enum Theme {
    #[default]
    Light,
    Dark,
}

impl Theme {
    /// Toggle between light and dark.
    pub fn toggle(self) -> Self {
        match self {
            Theme::Light => Theme::Dark,
            Theme::Dark => Theme::Light,
        }
    }

    /// CSS value for `data-bs-theme` attribute.
    pub fn as_str(&self) -> &'static str {
        match self {
            Theme::Light => "light",
            Theme::Dark => "dark",
        }
    }
}

impl std::fmt::Display for Theme {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

/// Applies `data-bs-theme` to the document root for Bootstrap dark/light mode.
///
/// Place this at the top of your app. It reactively sets `data-bs-theme` on `<html>`.
///
/// # Bootstrap HTML → Dioxus
///
/// ```html
/// <!-- Bootstrap HTML (manual) -->
/// <html data-bs-theme="dark">
/// ```
///
/// ```rust,no_run
/// // Dioxus — reactive theme switching
/// let theme = use_signal(|| Theme::Dark);
/// rsx! {
///     ThemeProvider { theme }
///     BootstrapHead {}
///     ThemeToggle { theme }  // sun/moon toggle button
///     // your app content
/// }
/// ```
#[derive(Clone, PartialEq, Props)]
pub struct ThemeProviderProps {
    /// Signal controlling the current theme.
    pub theme: Signal<Theme>,
}

#[component]
pub fn ThemeProvider(props: ThemeProviderProps) -> Element {
    let theme_signal = props.theme;

    // Reactively set data-bs-theme on <html> whenever the signal changes.
    use_effect(move || {
        let theme = *theme_signal.read();
        let theme_str = theme.as_str();
        document::eval(&format!(
            "document.documentElement.setAttribute('data-bs-theme', '{theme_str}');"
        ));
    });

    rsx! {}
}

/// A toggle button that switches between light and dark mode.
///
/// ```rust
/// let theme = use_signal(|| Theme::Dark);
/// rsx! {
///     ThemeProvider { theme: theme }
///     ThemeToggle { theme: theme }
/// }
/// ```
#[derive(Clone, PartialEq, Props)]
pub struct ThemeToggleProps {
    /// Signal controlling the current theme.
    pub theme: Signal<Theme>,
    /// Button color.
    #[props(default)]
    pub color: Option<Color>,
    /// Additional CSS classes.
    #[props(default)]
    pub class: String,
}

#[component]
pub fn ThemeToggle(props: ThemeToggleProps) -> Element {
    let theme = *props.theme.read();
    let mut theme_signal = props.theme;

    let icon = match theme {
        Theme::Light => "moon-stars",
        Theme::Dark => "sun",
    };

    let label = match theme {
        Theme::Light => "Switch to dark mode",
        Theme::Dark => "Switch to light mode",
    };

    let btn_class = match &props.color {
        Some(c) => format!("btn btn-outline-{c}"),
        None => "btn btn-outline-secondary".to_string(),
    };

    let full_class = if props.class.is_empty() {
        btn_class
    } else {
        format!("{btn_class} {}", props.class)
    };

    rsx! {
        button {
            class: "{full_class}",
            r#type: "button",
            title: "{label}",
            "aria-label": "{label}",
            onclick: move |_| {
                let new_theme = theme.toggle();
                theme_signal.set(new_theme);
            },
            i { class: "bi bi-{icon}" }
        }
    }
}