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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
use crate::core::url;
use crate::core::StorageType;
use crate::core::{ElementMaybeSignal, MaybeRwSignal};
use crate::storage::{use_storage_with_options, UseStorageOptions};
use crate::utils::get_header;
use crate::{
sync_signal_with_options, use_cookie, use_preferred_dark_with_options, SyncSignalOptions,
UsePreferredDarkOptions,
};
use codee::string::FromToStringCodec;
use default_struct_builder::DefaultBuilder;
use leptos::*;
use std::fmt::{Display, Formatter};
use std::marker::PhantomData;
use std::rc::Rc;
use std::str::FromStr;
use wasm_bindgen::JsCast;
/// Reactive color mode (dark / light / customs) with auto data persistence.
///
/// ## Demo
///
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_color_mode)
///
/// ## Usage
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_color_mode, UseColorModeReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseColorModeReturn {
/// mode, // Signal<ColorMode::dark | ColorMode::light>
/// set_mode,
/// ..
/// } = use_color_mode();
/// #
/// # view! { }
/// # }
/// ```
///
/// By default, it will match with users' browser preference using [`fn@crate::use_preferred_dark`] (a.k.a. `ColorMode::Auto`).
/// When reading the signal, it will by default return the current color mode (`ColorMode::Dark`, `ColorMode::Light` or
/// your custom modes `ColorMode::Custom("some-custom")`). The `ColorMode::Auto` variant can
/// be included in the returned modes by enabling the `emit_auto` option and using [`use_color_mode_with_options`].
/// When writing to the signal (`set_mode`), it will trigger DOM updates and persist the color mode to local
/// storage (or your custom storage). You can pass `ColorMode::Auto` to set back to auto mode.
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{ColorMode, use_color_mode, UseColorModeReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// # let UseColorModeReturn { mode, set_mode, .. } = use_color_mode();
/// #
/// mode.get(); // ColorMode::Dark or ColorMode::Light
///
/// set_mode.set(ColorMode::Dark); // change to dark mode and persist
///
/// set_mode.set(ColorMode::Auto); // change to auto mode
/// #
/// # view! { }
/// # }
/// ```
///
/// ## Options
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_color_mode_with_options, UseColorModeOptions, UseColorModeReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseColorModeReturn { mode, set_mode, .. } = use_color_mode_with_options(
/// UseColorModeOptions::default()
/// .attribute("theme") // instead of writing to `class`
/// .custom_modes(vec![
/// // custom colors in addition to light/dark
/// "dim".to_string(),
/// "cafe".to_string(),
/// ]),
/// ); // Signal<ColorMode::Dark | ColorMode::Light | ColorMode::Custom("dim") | ColorMode::Custom("cafe")>
/// #
/// # view! { }
/// # }
/// ```
///
/// ### Cookie
///
/// To persist color mode in a cookie, use `use_cookie_with_options` and specify `.cookie_enabled(true)`.
///
/// > Note: To work with SSR you have to add the `axum` or `actix` feature as described in [`fn@crate::use_cookie`].
///
/// ```rust
/// # use leptos::*;
/// # use leptos_meta::*;
/// # use leptos_use::{use_color_mode_with_options, UseColorModeOptions, UseColorModeReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseColorModeReturn { mode, set_mode, .. } = use_color_mode_with_options(
/// UseColorModeOptions::default()
/// .cookie_enabled(true),
/// );
///
/// // This adds the color mode class to the `<html>` element even with SSR
/// view! {
/// <Html class=move || mode.get().to_string()/>
/// }
/// # }
/// ```
///
/// For a working example please check out the [ssr example](https://github.com/Synphonyte/leptos-use/blob/main/examples/ssr/src/app.rs).
///
/// ## Server-Side Rendering
///
/// On the server this will try to read the
/// [`Sec-CH-Prefers-Color-Scheme` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-CH-Prefers-Color-Scheme)
/// to determine the color mode. If the header is not present it will return `ColorMode::Light`.
/// Please have a look at the linked documentation above for that header to see browser support
/// as well as potential server requirements.
///
/// > If you're using `axum` you have to enable the `"axum"` feature in your Cargo.toml.
/// > In case it's `actix-web` enable the feature `"actix"`, for `spin` enable `"spin"`.
///
/// ### Bring your own header
///
/// In case you're neither using Axum, Actix nor Spin, or the default implementation is not to your liking,
/// you can provide your own way of reading the color scheme header value using the option
/// [`crate::UseColorModeOptions::ssr_color_header_getter`].
///
/// ### Cookie
///
/// If `cookie_enabled` is set to `true`, a cookie will be used and if present this value will be used
/// on the server as well as on the client. Please note that you have to add the `axum` or `actix`
/// feature as described in [`fn@crate::use_cookie`].
///
/// ## See also
///
/// * [`fn@crate::use_preferred_dark`]
/// * [`fn@crate::storage::use_storage`]
/// * [`fn@crate::use_cookie`]
pub fn use_color_mode() -> UseColorModeReturn {
use_color_mode_with_options(UseColorModeOptions::default())
}
/// Version of [`use_color_mode`] that takes a `UseColorModeOptions`. See [`use_color_mode`] for how to use.
pub fn use_color_mode_with_options<El, T>(options: UseColorModeOptions<El, T>) -> UseColorModeReturn
where
El: Clone,
El: Into<ElementMaybeSignal<T, web_sys::Element>>,
T: Into<web_sys::Element> + Clone + 'static,
{
let UseColorModeOptions {
target,
attribute,
initial_value,
initial_value_from_url_param,
initial_value_from_url_param_to_storage,
on_changed,
storage_signal,
custom_modes,
storage_key,
storage,
storage_enabled,
cookie_name,
cookie_enabled,
emit_auto,
transition_enabled,
listen_to_storage_changes,
ssr_color_header_getter,
_marker,
} = options;
let modes: Vec<String> = custom_modes
.into_iter()
.chain(vec![
ColorMode::Dark.to_string(),
ColorMode::Light.to_string(),
])
.collect();
let preferred_dark = use_preferred_dark_with_options(UsePreferredDarkOptions {
ssr_color_header_getter,
});
let system = Signal::derive(move || {
if preferred_dark.get() {
ColorMode::Dark
} else {
ColorMode::Light
}
});
let mut initial_value_from_url = None;
if let Some(param) = initial_value_from_url_param.as_ref() {
if let Some(value) = url::params::get(param) {
initial_value_from_url = ColorMode::from_str(&value).map(MaybeRwSignal::Static).ok()
}
}
let (store, set_store) = get_store_signal(
initial_value_from_url.clone().unwrap_or(initial_value),
storage_signal,
&storage_key,
storage_enabled,
storage,
listen_to_storage_changes,
);
let (cookie, set_cookie) = get_cookie_signal(&cookie_name, cookie_enabled);
if cookie_enabled {
let _ = sync_signal_with_options(
(cookie, set_cookie),
(store, set_store),
SyncSignalOptions::with_transforms(
move |cookie: &Option<ColorMode>| {
cookie.clone().unwrap_or_else(|| store.get_untracked())
},
move |store: &ColorMode| Some(store.clone()),
),
);
}
if let Some(initial_value_from_url) = initial_value_from_url {
let value = initial_value_from_url.into_signal().0.get_untracked();
if initial_value_from_url_param_to_storage {
set_store.set(value);
} else {
set_store.set_untracked(value);
}
}
let state = Signal::derive(move || {
let value = store.get();
if value == ColorMode::Auto {
system.get()
} else {
value
}
});
let target = target.into();
let update_html_attrs = {
move |target: ElementMaybeSignal<T, web_sys::Element>,
attribute: String,
value: ColorMode| {
let el = target.get_untracked();
if let Some(el) = el {
let el = el.into();
let mut style: Option<web_sys::HtmlStyleElement> = None;
if !transition_enabled {
if let Ok(styl) = document().create_element("style") {
if let Some(head) = document().head() {
let styl: web_sys::HtmlStyleElement = styl.unchecked_into();
let style_string = "*,*::before,*::after{-webkit-transition:none!important;-moz-transition:none!important;-o-transition:none!important;-ms-transition:none!important;transition:none!important}";
styl.set_text_content(Some(style_string));
let _ = head.append_child(&styl);
style = Some(styl);
}
}
}
if attribute == "class" {
for mode in &modes {
if &value.to_string() == mode {
let _ = el.class_list().add_1(mode);
} else {
let _ = el.class_list().remove_1(mode);
}
}
} else {
let _ = el.set_attribute(&attribute, &value.to_string());
}
if !transition_enabled {
if let Some(style) = style {
if let Some(head) = document().head() {
// Calling getComputedStyle forces the browser to redraw
if let Ok(Some(style)) = window().get_computed_style(&style) {
let _ = style.get_property_value("opacity");
}
let _ = head.remove_child(&style);
}
}
}
}
}
};
let default_on_changed = move |mode: ColorMode| {
update_html_attrs(target.clone(), attribute.clone(), mode);
};
let on_changed = move |mode: ColorMode| {
on_changed(mode, Rc::new(default_on_changed.clone()));
};
create_effect({
let on_changed = on_changed.clone();
move |_| {
on_changed.clone()(state.get());
}
});
on_cleanup(move || {
on_changed(state.get());
});
let mode = Signal::derive(move || if emit_auto { store.get() } else { state.get() });
UseColorModeReturn {
mode,
set_mode: set_store,
store,
set_store,
system,
state,
}
}
/// Color modes
#[derive(Clone, Default, PartialEq, Eq, Hash, Debug)]
pub enum ColorMode {
#[default]
Auto,
Light,
Dark,
Custom(String),
}
fn get_cookie_signal(
cookie_name: &str,
cookie_enabled: bool,
) -> (Signal<Option<ColorMode>>, WriteSignal<Option<ColorMode>>) {
if cookie_enabled {
use_cookie::<ColorMode, FromToStringCodec>(cookie_name)
} else {
let (value, set_value) = create_signal(None);
(value.into(), set_value)
}
}
fn get_store_signal(
initial_value: MaybeRwSignal<ColorMode>,
storage_signal: Option<RwSignal<ColorMode>>,
storage_key: &str,
storage_enabled: bool,
storage: StorageType,
listen_to_storage_changes: bool,
) -> (Signal<ColorMode>, WriteSignal<ColorMode>) {
if let Some(storage_signal) = storage_signal {
let (store, set_store) = storage_signal.split();
(store.into(), set_store)
} else if storage_enabled {
let (store, set_store, _) = use_storage_with_options::<ColorMode, FromToStringCodec>(
storage,
storage_key,
UseStorageOptions::default()
.listen_to_storage_changes(listen_to_storage_changes)
.initial_value(initial_value),
);
(store, set_store)
} else {
initial_value.into_signal()
}
}
impl Display for ColorMode {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
use ColorMode::*;
match self {
Auto => write!(f, "auto"),
Light => write!(f, "light"),
Dark => write!(f, "dark"),
Custom(v) => write!(f, "{}", v),
}
}
}
impl From<&str> for ColorMode {
fn from(s: &str) -> Self {
match s {
"auto" => ColorMode::Auto,
"" => ColorMode::Auto,
"light" => ColorMode::Light,
"dark" => ColorMode::Dark,
_ => ColorMode::Custom(s.to_string()),
}
}
}
impl From<String> for ColorMode {
fn from(s: String) -> Self {
ColorMode::from(s.as_str())
}
}
impl FromStr for ColorMode {
type Err = ();
fn from_str(s: &str) -> Result<Self, Self::Err> {
Ok(ColorMode::from(s))
}
}
#[derive(DefaultBuilder)]
pub struct UseColorModeOptions<El, T>
where
El: Clone,
El: Into<ElementMaybeSignal<T, web_sys::Element>>,
T: Into<web_sys::Element> + Clone + 'static,
{
/// Element that the color mode will be applied to. Defaults to `"html"`.
target: El,
/// HTML attribute applied to the target element. Defaults to `"class"`.
#[builder(into)]
attribute: String,
/// Initial value of the color mode. Defaults to `"Auto"`.
#[builder(into)]
initial_value: MaybeRwSignal<ColorMode>,
/// Discover the initial value of the color mode from an URL parameter. Defaults to `None`.
#[builder(into)]
initial_value_from_url_param: Option<String>,
/// Write the initial value of the discovered color mode from URL parameter to storage.
/// This only has an effect if `initial_value_from_url_param` is specified.
/// Defaults to `false`.
initial_value_from_url_param_to_storage: bool,
/// Custom modes that you plan to use as `ColorMode::Custom(x)`. Defaults to `vec![]`.
custom_modes: Vec<String>,
/// Custom handler that is called on updates.
/// If specified this will override the default behavior.
/// To get the default behaviour back you can call the provided `default_handler` function.
/// It takes two parameters:
/// - `mode: ColorMode`: The color mode to change to.
/// - `default_handler: Rc<dyn Fn(ColorMode)>`: The default handler that would have been called if the `on_changed` handler had not been specified.
on_changed: OnChangedFn,
/// When provided, `useStorage` will be skipped.
/// Defaults to `None`.
#[builder(into)]
storage_signal: Option<RwSignal<ColorMode>>,
/// Key to persist the data into localStorage/sessionStorage.
/// Defaults to `"leptos-use-color-scheme"`.
#[builder(into)]
storage_key: String,
/// Storage type, can be `Local` or `Session` or custom.
/// Defaults to `Local`.
storage: StorageType,
/// If the color mode should be persisted.
/// Defaults to `true`.
storage_enabled: bool,
/// Name of the cookie that should be used to persist the color mode.
/// Defaults to `"leptos-use-color-scheme"`.
#[builder(into)]
cookie_name: String,
/// If the color mode should be persisted through a cookie.
/// Defaults to `false`.
cookie_enabled: bool,
/// Emit `auto` mode from state
///
/// When set to `true`, preferred mode won't be translated into `light` or `dark`.
/// This is useful when the fact that `auto` mode was selected needs to be known.
///
/// Defaults to `false`.
emit_auto: bool,
/// If transitions on color mode change are enabled. Defaults to `false`.
transition_enabled: bool,
/// Listen to changes to this storage key from somewhere else.
/// Defaults to true.
listen_to_storage_changes: bool,
/// Getter function to return the string value of the
/// [`Sec-CH-Prefers-Color-Scheme`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-CH-Prefers-Color-Scheme)
/// header.
/// When you use one of the features `"axum"`, `"actix"` or `"spin"` there's a valid default
/// implementation provided.
#[allow(dead_code)]
ssr_color_header_getter: Rc<dyn Fn() -> Option<String>>,
#[builder(skip)]
_marker: PhantomData<T>,
}
type OnChangedFn = Rc<dyn Fn(ColorMode, Rc<dyn Fn(ColorMode)>)>;
impl Default for UseColorModeOptions<&'static str, web_sys::Element> {
fn default() -> Self {
Self {
target: "html",
attribute: "class".into(),
initial_value: ColorMode::Auto.into(),
initial_value_from_url_param: None,
initial_value_from_url_param_to_storage: false,
custom_modes: vec![],
on_changed: Rc::new(move |mode, default_handler| (default_handler)(mode)),
storage_signal: None,
storage_key: "leptos-use-color-scheme".into(),
storage: StorageType::default(),
storage_enabled: true,
cookie_name: "leptos-use-color-scheme".into(),
cookie_enabled: false,
emit_auto: false,
transition_enabled: false,
listen_to_storage_changes: true,
ssr_color_header_getter: Rc::new(move || {
get_header!(
HeaderName::from_static("sec-ch-prefers-color-scheme"),
use_locale,
ssr_color_header_getter
)
}),
_marker: PhantomData,
}
}
}
/// Return type of [`use_color_mode`]
pub struct UseColorModeReturn {
/// Main value signal of the color mode
pub mode: Signal<ColorMode>,
/// Main value setter signal of the color mode
pub set_mode: WriteSignal<ColorMode>,
/// Direct access to the returned signal of [`fn@crate::storage::use_storage`] if enabled or [`UseColorModeOptions::storage_signal`] if provided
pub store: Signal<ColorMode>,
/// Direct write access to the returned signal of [`fn@crate::storage::use_storage`] if enabled or [`UseColorModeOptions::storage_signal`] if provided
pub set_store: WriteSignal<ColorMode>,
/// Signal of the system's preferred color mode that you would get from a media query
pub system: Signal<ColorMode>,
/// When [`UseColorModeOptions::emit_auto`] is `false` this is the same as `mode`. This will never report `ColorMode::Auto` but always on of the other modes.
pub state: Signal<ColorMode>,
}