diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml index 8acd985..d2dd358 100644 --- a/.idea/leptos-use.iml +++ b/.idea/leptos-use.iml @@ -33,6 +33,7 @@ + diff --git a/CHANGELOG.md b/CHANGELOG.md index 54320a0..2bb0fff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### New Functions 🚀 + +- `use_css_var` + ## [0.3.1] - 2023-06-15 ### New Functions 🚀 diff --git a/Cargo.toml b/Cargo.toml index fc192cb..4a54a02 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -32,6 +32,7 @@ features = [ "CustomEventInit", "DomRectReadOnly", "Element", + "HtmlElement", "HtmlLinkElement", "IntersectionObserver", "IntersectionObserverInit", diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 117203a..a551d9f 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -22,6 +22,7 @@ # Browser - [use_breakpoints](browser/use_breakpoints.md) +- [use_css_var](browser/use_css_var.md) - [use_event_listener](browser/use_event_listener.md) - [use_favicon](browser/use_favicon.md) - [use_media_query](browser/use_media_query.md) diff --git a/docs/book/src/browser/use_css_var.md b/docs/book/src/browser/use_css_var.md new file mode 100644 index 0000000..e977dcd --- /dev/null +++ b/docs/book/src/browser/use_css_var.md @@ -0,0 +1,3 @@ +# use_css_var + + diff --git a/examples/Cargo.toml b/examples/Cargo.toml index dfddd7f..def923e 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -5,6 +5,7 @@ members = [ "use_abs", "use_breakpoints", "use_ceil", + "use_css_var", "use_debounce_fn", "use_element_size", "use_element_visibility", diff --git a/examples/use_css_var/Cargo.toml b/examples/use_css_var/Cargo.toml new file mode 100644 index 0000000..c768e8d --- /dev/null +++ b/examples/use_css_var/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_css_var" +version = "0.1.0" +edition = "2021" + +[dependencies] +leptos = "0.3" +console_error_panic_hook = "0.1" +console_log = "1" +log = "0.4" +leptos-use = { path = "../..", features = ["docs"] } +web-sys = "0.3" + +[dev-dependencies] +wasm-bindgen = "0.2" +wasm-bindgen-test = "0.3.0" diff --git a/examples/use_css_var/README.md b/examples/use_css_var/README.md new file mode 100644 index 0000000..6bf5987 --- /dev/null +++ b/examples/use_css_var/README.md @@ -0,0 +1,23 @@ +A simple example for `use_css_var`. + +If you don't have it installed already, install [Trunk](https://trunkrs.dev/) and [Tailwind](https://tailwindcss.com/docs/installation) +as well as the nightly toolchain for Rust and the wasm32-unknown-unknown target: + +```bash +cargo install trunk +npm install -D tailwindcss @tailwindcss/forms +rustup toolchain install nightly +rustup target add wasm32-unknown-unknown +``` + +Then, open two terminals. In the first one, run: + +``` +npx tailwindcss -i ./input.css -o ./style/output.css --watch +``` + +In the second one, run: + +```bash +trunk serve --open +``` \ No newline at end of file diff --git a/examples/use_css_var/Trunk.toml b/examples/use_css_var/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_css_var/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_css_var/index.html b/examples/use_css_var/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_css_var/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_css_var/input.css b/examples/use_css_var/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_css_var/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_css_var/rust-toolchain.toml b/examples/use_css_var/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_css_var/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_css_var/src/main.rs b/examples/use_css_var/src/main.rs new file mode 100644 index 0000000..781c6cc --- /dev/null +++ b/examples/use_css_var/src/main.rs @@ -0,0 +1,59 @@ +use leptos::*; +use leptos_use::docs::demo_or_body; +use leptos_use::{use_css_var_with_options, UseCssVarOptions}; + +#[component] +fn Demo(cx: Scope) -> impl IntoView { + let el = create_node_ref(cx); + let (color, set_color) = + use_css_var_with_options(cx, "--color", UseCssVarOptions::default().target(el)); + let switch_color = move |_| { + if color() == "#df8543" { + set_color("#7fa998".to_string()); + } else { + set_color("#df8543".to_string()); + } + }; + + let elv = create_node_ref(cx); + let (key, set_key) = create_signal(cx, "--color".to_string()); + let (color_val, _) = use_css_var_with_options(cx, key, UseCssVarOptions::default().target(elv)); + let change_var = move |_| { + if key() == "--color" { + set_key("--color-one".to_string()); + } else { + set_key("--color".to_string()); + } + }; + let style = move || { + format!( + "--color: #7fa998; --color-one: #df8543; color: {}", + color_val() + ) + }; + + view! { cx, +
+
+ "Sample text, " {color} +
+ +
+ +
+
+ "Sample text, " {key} ": " {color_val} +
+ +
+ } +} + +fn main() { + _ = console_log::init_with_level(log::Level::Debug); + console_error_panic_hook::set_once(); + + mount_to(demo_or_body(), |cx| { + view! { cx, } + }) +} diff --git a/examples/use_css_var/style/output.css b/examples/use_css_var/style/output.css new file mode 100644 index 0000000..761f182 --- /dev/null +++ b/examples/use_css_var/style/output.css @@ -0,0 +1,293 @@ +[type='text'],[type='email'],[type='url'],[type='password'],[type='number'],[type='date'],[type='datetime-local'],[type='month'],[type='search'],[type='tel'],[type='time'],[type='week'],[multiple],textarea,select { + -webkit-appearance: none; + -moz-appearance: none; + appearance: none; + background-color: #fff; + border-color: #6b7280; + border-width: 1px; + border-radius: 0px; + padding-top: 0.5rem; + padding-right: 0.75rem; + padding-bottom: 0.5rem; + padding-left: 0.75rem; + font-size: 1rem; + line-height: 1.5rem; + --tw-shadow: 0 0 #0000; +} + +[type='text']:focus, [type='email']:focus, [type='url']:focus, [type='password']:focus, [type='number']:focus, [type='date']:focus, [type='datetime-local']:focus, [type='month']:focus, [type='search']:focus, [type='tel']:focus, [type='time']:focus, [type='week']:focus, [multiple]:focus, textarea:focus, select:focus { + outline: 2px solid transparent; + outline-offset: 2px; + --tw-ring-inset: var(--tw-empty,/*!*/ /*!*/); + --tw-ring-offset-width: 0px; + --tw-ring-offset-color: #fff; + --tw-ring-color: #2563eb; + --tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color); + --tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color); + box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow); + border-color: #2563eb; +} + +input::-moz-placeholder, textarea::-moz-placeholder { + color: #6b7280; + opacity: 1; +} + +input::placeholder,textarea::placeholder { + color: #6b7280; + opacity: 1; +} + +::-webkit-datetime-edit-fields-wrapper { + padding: 0; +} + +::-webkit-date-and-time-value { + min-height: 1.5em; +} + +::-webkit-datetime-edit,::-webkit-datetime-edit-year-field,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute-field,::-webkit-datetime-edit-second-field,::-webkit-datetime-edit-millisecond-field,::-webkit-datetime-edit-meridiem-field { + padding-top: 0; + padding-bottom: 0; +} + +select { + background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e"); + background-position: right 0.5rem center; + background-repeat: no-repeat; + background-size: 1.5em 1.5em; + padding-right: 2.5rem; + -webkit-print-color-adjust: exact; + print-color-adjust: exact; +} + +[multiple] { + background-image: initial; + background-position: initial; + background-repeat: unset; + background-size: initial; + padding-right: 0.75rem; + -webkit-print-color-adjust: unset; + print-color-adjust: unset; +} + +[type='checkbox'],[type='radio'] { + -webkit-appearance: none; + -moz-appearance: none; + appearance: none; + padding: 0; + -webkit-print-color-adjust: exact; + print-color-adjust: exact; + display: inline-block; + vertical-align: middle; + background-origin: border-box; + -webkit-user-select: none; + -moz-user-select: none; + user-select: none; + flex-shrink: 0; + height: 1rem; + width: 1rem; + color: #2563eb; + background-color: #fff; + border-color: #6b7280; + border-width: 1px; + --tw-shadow: 0 0 #0000; +} + +[type='checkbox'] { + border-radius: 0px; +} + +[type='radio'] { + border-radius: 100%; +} + +[type='checkbox']:focus,[type='radio']:focus { + outline: 2px solid transparent; + outline-offset: 2px; + --tw-ring-inset: var(--tw-empty,/*!*/ /*!*/); + --tw-ring-offset-width: 2px; + --tw-ring-offset-color: #fff; + --tw-ring-color: #2563eb; + --tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color); + --tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color); + box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow); +} + +[type='checkbox']:checked,[type='radio']:checked { + border-color: transparent; + background-color: currentColor; + background-size: 100% 100%; + background-position: center; + background-repeat: no-repeat; +} + +[type='checkbox']:checked { + background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3e%3c/svg%3e"); +} + +[type='radio']:checked { + background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3ccircle cx='8' cy='8' r='3'/%3e%3c/svg%3e"); +} + +[type='checkbox']:checked:hover,[type='checkbox']:checked:focus,[type='radio']:checked:hover,[type='radio']:checked:focus { + border-color: transparent; + background-color: currentColor; +} + +[type='checkbox']:indeterminate { + background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3e%3cpath stroke='white' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M4 8h8'/%3e%3c/svg%3e"); + border-color: transparent; + background-color: currentColor; + background-size: 100% 100%; + background-position: center; + background-repeat: no-repeat; +} + +[type='checkbox']:indeterminate:hover,[type='checkbox']:indeterminate:focus { + border-color: transparent; + background-color: currentColor; +} + +[type='file'] { + background: unset; + border-color: inherit; + border-width: 0; + border-radius: 0; + padding: 0; + font-size: unset; + line-height: inherit; +} + +[type='file']:focus { + outline: 1px solid ButtonText; + outline: 1px auto -webkit-focus-ring-color; +} + +*, ::before, ::after { + --tw-border-spacing-x: 0; + --tw-border-spacing-y: 0; + --tw-translate-x: 0; + --tw-translate-y: 0; + --tw-rotate: 0; + --tw-skew-x: 0; + --tw-skew-y: 0; + --tw-scale-x: 1; + --tw-scale-y: 1; + --tw-pan-x: ; + --tw-pan-y: ; + --tw-pinch-zoom: ; + --tw-scroll-snap-strictness: proximity; + --tw-gradient-from-position: ; + --tw-gradient-via-position: ; + --tw-gradient-to-position: ; + --tw-ordinal: ; + --tw-slashed-zero: ; + --tw-numeric-figure: ; + --tw-numeric-spacing: ; + --tw-numeric-fraction: ; + --tw-ring-inset: ; + --tw-ring-offset-width: 0px; + --tw-ring-offset-color: #fff; + --tw-ring-color: rgb(59 130 246 / 0.5); + --tw-ring-offset-shadow: 0 0 #0000; + --tw-ring-shadow: 0 0 #0000; + --tw-shadow: 0 0 #0000; + --tw-shadow-colored: 0 0 #0000; + --tw-blur: ; + --tw-brightness: ; + --tw-contrast: ; + --tw-grayscale: ; + --tw-hue-rotate: ; + --tw-invert: ; + --tw-saturate: ; + --tw-sepia: ; + --tw-drop-shadow: ; + --tw-backdrop-blur: ; + --tw-backdrop-brightness: ; + --tw-backdrop-contrast: ; + --tw-backdrop-grayscale: ; + --tw-backdrop-hue-rotate: ; + --tw-backdrop-invert: ; + --tw-backdrop-opacity: ; + --tw-backdrop-saturate: ; + --tw-backdrop-sepia: ; +} + +::backdrop { + --tw-border-spacing-x: 0; + --tw-border-spacing-y: 0; + --tw-translate-x: 0; + --tw-translate-y: 0; + --tw-rotate: 0; + --tw-skew-x: 0; + --tw-skew-y: 0; + --tw-scale-x: 1; + --tw-scale-y: 1; + --tw-pan-x: ; + --tw-pan-y: ; + --tw-pinch-zoom: ; + --tw-scroll-snap-strictness: proximity; + --tw-gradient-from-position: ; + --tw-gradient-via-position: ; + --tw-gradient-to-position: ; + --tw-ordinal: ; + --tw-slashed-zero: ; + --tw-numeric-figure: ; + --tw-numeric-spacing: ; + --tw-numeric-fraction: ; + --tw-ring-inset: ; + --tw-ring-offset-width: 0px; + --tw-ring-offset-color: #fff; + --tw-ring-color: rgb(59 130 246 / 0.5); + --tw-ring-offset-shadow: 0 0 #0000; + --tw-ring-shadow: 0 0 #0000; + --tw-shadow: 0 0 #0000; + --tw-shadow-colored: 0 0 #0000; + --tw-blur: ; + --tw-brightness: ; + --tw-contrast: ; + --tw-grayscale: ; + --tw-hue-rotate: ; + --tw-invert: ; + --tw-saturate: ; + --tw-sepia: ; + --tw-drop-shadow: ; + --tw-backdrop-blur: ; + --tw-backdrop-brightness: ; + --tw-backdrop-contrast: ; + --tw-backdrop-grayscale: ; + --tw-backdrop-hue-rotate: ; + --tw-backdrop-invert: ; + --tw-backdrop-opacity: ; + --tw-backdrop-saturate: ; + --tw-backdrop-sepia: ; +} + +.static { + position: static; +} + +.mt-4 { + margin-top: 1rem; +} + +.text-\[--brand-color\] { + color: var(--brand-color); +} + +.text-green-600 { + --tw-text-opacity: 1; + color: rgb(22 163 74 / var(--tw-text-opacity)); +} + +.opacity-75 { + opacity: 0.75; +} + +@media (prefers-color-scheme: dark) { + .dark\:text-green-500 { + --tw-text-opacity: 1; + color: rgb(34 197 94 / var(--tw-text-opacity)); + } +} \ No newline at end of file diff --git a/examples/use_css_var/tailwind.config.js b/examples/use_css_var/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_css_var/tailwind.config.js @@ -0,0 +1,15 @@ +/** @type {import('tailwindcss').Config} */ +module.exports = { + content: { + files: ["*.html", "./src/**/*.rs", "../../src/docs/**/*.rs"], + }, + theme: { + extend: {}, + }, + corePlugins: { + preflight: false, + }, + plugins: [ + require('@tailwindcss/forms'), + ], +} \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index 358d6d4..62bea53 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -42,6 +42,7 @@ mod watch_debounced; mod watch_pausable; mod watch_throttled; mod whenever; +mod use_css_var; pub use on_click_outside::*; pub use use_breakpoints::*; @@ -65,3 +66,4 @@ pub use watch_debounced::*; pub use watch_pausable::*; pub use watch_throttled::*; pub use whenever::*; +pub use use_css_var::*; \ No newline at end of file diff --git a/src/use_css_var.rs b/src/use_css_var.rs new file mode 100644 index 0000000..814ddb8 --- /dev/null +++ b/src/use_css_var.rs @@ -0,0 +1,199 @@ +use crate::core::ElementMaybeSignal; +use crate::{use_mutation_observer_with_options, watch, watch_with_options, WatchOptions}; +use default_struct_builder::DefaultBuilder; +use leptos::*; +use std::marker::PhantomData; +use std::time::Duration; +use wasm_bindgen::{JsCast, JsValue}; + +/// Manipulate CSS variables. +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_css_var) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::use_css_var; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// let (color, set_color) = use_css_var(cx, "--color"); +/// +/// set_color("red".to_string()); +/// # +/// # view! { cx, } +/// # } +/// ``` +/// +/// The variable name itself can be a `Signal`. +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::use_css_var; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// let (key, set_key) = create_signal(cx, "--color".to_string()); +/// let (color, set_color) = use_css_var(cx, key); +/// # +/// # view! { cx, } +/// # } +/// ``` +/// +/// You can specify the element that the variable is applied to as well as an initial value in case +/// the variable is not set yet. The option to listen for changes to the variable is also available. +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::{use_css_var_with_options, UseCssVarOptions}; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// let el = create_node_ref(cx); +/// +/// let (color, set_color) = use_css_var_with_options( +/// cx, +/// "--color", +/// UseCssVarOptions::default() +/// .target(el) +/// .initial_value("#eee") +/// .observe(true), +/// ); +/// +/// view! { cx, +///
"..."
+/// } +/// # } +/// ``` + +pub fn use_css_var( + cx: Scope, + prop: impl Into>, +) -> (ReadSignal, WriteSignal) { + use_css_var_with_options(cx, prop, UseCssVarOptions::default()) +} + +/// Version of [`use_css_var`] that takes a `UseCssVarOptions`. See [`use_css_var`] for how to use. +pub fn use_css_var_with_options( + cx: Scope, + prop: P, + options: UseCssVarOptions, +) -> (ReadSignal, WriteSignal) +where + P: Into>, + El: Clone, + (Scope, El): Into>, + T: Into + Clone + 'static, +{ + let UseCssVarOptions { + target, + initial_value, + observe, + .. + } = options; + + let (variable, set_variable) = create_signal(cx, initial_value.clone()); + + let el_signal = (cx, target).into(); + let prop = prop.into(); + + let update_css_var = { + let prop = prop.clone(); + let el_signal = el_signal.clone(); + + move || { + let key = prop.get_untracked(); + + if let Some(el) = el_signal.get_untracked() { + if let Ok(Some(style)) = window().get_computed_style(&el.into()) { + if let Ok(value) = style.get_property_value(&key) { + set_variable.update(|var| *var = value.trim().to_string()); + return; + } + } + + let initial_value = initial_value.clone(); + set_variable.update(|var| *var = initial_value); + } + } + }; + + if observe { + let mut init = web_sys::MutationObserverInit::new(); + let update_css_var = update_css_var.clone(); + let el_signal = el_signal.clone(); + + init.attribute_filter(&js_sys::Array::from_iter( + vec![JsValue::from_str("style")].into_iter(), + )); + use_mutation_observer_with_options::, T, _>( + cx, + el_signal, + move |_, _| update_css_var(), + init, + ); + } + + // To get around style attributes on node_refs that are not applied after the first render + set_timeout(update_css_var.clone(), Duration::ZERO); + + { + let el_signal = el_signal.clone(); + let prop = prop.clone(); + + let _ = watch_with_options( + cx, + move || (el_signal.get(), prop.get()), + move |_, _, _| update_css_var(), + WatchOptions::default().immediate(true), + ); + } + + let _ = watch(cx, variable, move |val, _, _| { + if let Some(el) = el_signal.get() { + let el = el.into().unchecked_into::(); + let style = el.style(); + let _ = style.set_property(&prop.get_untracked(), val); + } + }); + + (variable, set_variable) +} + +/// Options for [`use_css_var_with_options`]. +#[derive(DefaultBuilder)] +pub struct UseCssVarOptions +where + El: Clone, + (Scope, El): Into>, + T: Into + Clone + 'static, +{ + /// The target element to read the variable from and set the variable on. + /// Defaults to the `document.documentElement`. + target: El, + + /// The initial value of the variable before it is read. Also the default value + /// if the variable isn't defined on the target. Defaults to "". + #[builder(into)] + initial_value: String, + + /// If `true` use a `MutationObserver` to monitor variable changes. Defaults to `false`. + observe: bool, + + #[builder(skip)] + _marker: PhantomData, +} + +impl Default for UseCssVarOptions { + fn default() -> Self { + Self { + target: document().document_element().expect("No document element"), + initial_value: "".into(), + observe: false, + _marker: PhantomData, + } + } +} diff --git a/src/utils/clonable_fn.rs b/src/utils/clonable_fn.rs index 00a77bf..6b9ba8c 100644 --- a/src/utils/clonable_fn.rs +++ b/src/utils/clonable_fn.rs @@ -136,3 +136,34 @@ impl Debug for Box> { ) } } + +pub trait CloneableFnMut: FnMut() { + fn clone_box(&self) -> Box; +} + +impl CloneableFnMut for F +where + F: FnMut() + Clone + 'static, +{ + fn clone_box(&self) -> Box { + Box::new(self.clone()) + } +} + +impl Clone for Box { + fn clone(&self) -> Self { + (**self).clone_box() + } +} + +impl Default for Box { + fn default() -> Self { + Box::new(|| {}) + } +} + +impl Debug for Box { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "Box",) + } +}