diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml index 3693411..91f8ed7 100644 --- a/.idea/leptos-use.iml +++ b/.idea/leptos-use.iml @@ -20,6 +20,7 @@ + @@ -37,6 +38,7 @@ + diff --git a/CHANGELOG.md b/CHANGELOG.md index 18991f3..b679427 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,13 +3,18 @@ ## 0.2.0 #### Braking Changes -- `watch` doesn't accept `immediate` as an argument anymore. This is only provided by the option variant. +- `watch` doesn't accept `immediate` as a direct argument anymore. This is only provided by the option variant. #### New Functions - `use_storage` +- `use_local_storage` +- `use_session_storage` - `watch_debounced` - `watch_throttled` - `watch_pausable` +- `use_ceil` +- `use_round` +- `use_media_query` #### Other Changes diff --git a/Cargo.toml b/Cargo.toml index ca34c76..48e7573 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -31,6 +31,7 @@ features = [ "CustomEventInit", "DomRectReadOnly", "Element", + "MediaQueryList", "MouseEvent", "Navigator", "ResizeObserver", diff --git a/README.md b/README.md index 8f36a08..8fbfbe1 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,16 @@ and run ```shell mdbook serve ``` + This builds the html version of the book and runs a local dev server. To also add in the examples open another shell and run ```shell python3 post_build.py +``` + +If you only want to add the example for one function you can run for example + +```shell +python3 post_build.py use_media_query ``` \ No newline at end of file diff --git a/docs/book/post_build.py b/docs/book/post_build.py index d6cc821..61a9909 100644 --- a/docs/book/post_build.py +++ b/docs/book/post_build.py @@ -1,6 +1,7 @@ import os import shutil import subprocess +import sys def main(): @@ -10,7 +11,7 @@ def main(): category_dir = os.path.join(src_dir, dir) if os.path.isdir(category_dir): for file in os.listdir(category_dir): - if file.endswith(".md"): + if file.endswith(".md") and (len(sys.argv) == 1 or (sys.argv[1] in file)): build_and_copy_demo(category, file) diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 7d2000b..b366373 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -19,6 +19,7 @@ # Browser - [use_event_listener](browser/use_event_listener.md) +- [use_media_query](browser/use_media_query.md) # Sensors diff --git a/docs/book/src/browser/use_media_query.md b/docs/book/src/browser/use_media_query.md new file mode 100644 index 0000000..d986055 --- /dev/null +++ b/docs/book/src/browser/use_media_query.md @@ -0,0 +1,3 @@ +# use_media_query + + diff --git a/examples/use_media_query/Cargo.toml b/examples/use_media_query/Cargo.toml new file mode 100644 index 0000000..9b64d51 --- /dev/null +++ b/examples/use_media_query/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_media_query" +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_media_query/README.md b/examples/use_media_query/README.md new file mode 100644 index 0000000..cf0d0dc --- /dev/null +++ b/examples/use_media_query/README.md @@ -0,0 +1,23 @@ +A simple example for `use_media_query`. + +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_media_query/Trunk.toml b/examples/use_media_query/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_media_query/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_media_query/index.html b/examples/use_media_query/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_media_query/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_media_query/input.css b/examples/use_media_query/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_media_query/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_media_query/rust-toolchain.toml b/examples/use_media_query/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_media_query/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_media_query/src/main.rs b/examples/use_media_query/src/main.rs new file mode 100644 index 0000000..90f2329 --- /dev/null +++ b/examples/use_media_query/src/main.rs @@ -0,0 +1,23 @@ +use leptos::*; +use leptos_use::docs::{demo_or_body, BooleanDisplay}; +use leptos_use::use_media_query; + +#[component] +fn Demo(cx: Scope) -> impl IntoView { + let is_large_screen = use_media_query(cx, "(min-width: 1024px)"); + let is_dark_preferred = use_media_query(cx, "(prefers-color-scheme: dark)"); + + view! { cx, +

"Is large screen: "

+

"Is dark preferred: "

+ } +} + +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_media_query/style/output.css b/examples/use_media_query/style/output.css new file mode 100644 index 0000000..675f097 --- /dev/null +++ b/examples/use_media_query/style/output.css @@ -0,0 +1,285 @@ +[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: ; +} + +.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_media_query/tailwind.config.js b/examples/use_media_query/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_media_query/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/examples/watch_pausable/src/main.rs b/examples/watch_pausable/src/main.rs index 96bbef5..786db53 100644 --- a/examples/watch_pausable/src/main.rs +++ b/examples/watch_pausable/src/main.rs @@ -9,10 +9,10 @@ fn Demo(cx: Scope) -> impl IntoView { let (source, set_source) = create_signal(cx, "".to_string()); let WatchPausableReturn { - stop, pause, resume, is_active, + .. } = watch_pausable(cx, source, move |v, _, _| { set_log.update(|log| *log = format!("{log}Changed to \"{v}\"\n")); }); diff --git a/src/lib.rs b/src/lib.rs index 92322bb..8bb03a9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -12,6 +12,7 @@ mod use_debounce_fn; #[cfg(web_sys_unstable_apis)] mod use_element_size; mod use_event_listener; +mod use_media_query; mod use_mouse; #[cfg(web_sys_unstable_apis)] mod use_resize_observer; @@ -28,6 +29,7 @@ pub use use_debounce_fn::*; #[cfg(web_sys_unstable_apis)] pub use use_element_size::*; pub use use_event_listener::*; +pub use use_media_query::*; pub use use_mouse::*; #[cfg(web_sys_unstable_apis)] pub use use_resize_observer::*; diff --git a/src/storage/use_storage.rs b/src/storage/use_storage.rs index 91eb4ff..ad50b56 100644 --- a/src/storage/use_storage.rs +++ b/src/storage/use_storage.rs @@ -13,7 +13,7 @@ use wasm_bindgen::{JsCast, JsValue}; const CUSTOM_STORAGE_EVENT_NAME: &str = "leptos-use-storage"; -/// Reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) / [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) +/// Reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) / [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage). /// /// ## Demo /// diff --git a/src/use_media_query.rs b/src/use_media_query.rs new file mode 100644 index 0000000..3dcfc4c --- /dev/null +++ b/src/use_media_query.rs @@ -0,0 +1,86 @@ +use crate::use_event_listener; +use crate::utils::CloneableFnMutWithArg; +use leptos::ev::change; +use leptos::*; +use std::cell::{OnceCell, RefCell}; +use std::rc::Rc; + +/// Reactive [Media Query](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Testing_media_queries). +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_media_query) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::use_media_query; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// # +/// let is_large_screen = use_media_query(cx, "(min-width: 1024px)"); +/// +/// let is_dark_preferred = use_media_query(cx, "(prefers-color-scheme: dark)"); +/// # +/// # view! { cx, } +/// # } +/// ``` +/// +pub fn use_media_query(cx: Scope, query: impl Into>) -> Signal { + let query = query.into(); + + let (matches, set_matches) = create_signal(cx, false); + + let media_query: Rc>> = Rc::new(RefCell::new(None)); + let remove_listener: Rc>>> = Rc::new(RefCell::new(None)); + + let rem_listener = Rc::clone(&remove_listener); + + let listener: Rc>>> = + Rc::new(OnceCell::new()); + + let cleanup = move || { + if let Some(remove_listener) = rem_listener.take().as_ref() { + remove_listener(); + } + }; + + let clean = cleanup.clone(); + let listen = Rc::clone(&listener); + + let update = move || { + clean(); + + let mut media_query = media_query.borrow_mut(); + *media_query = window().match_media(&query.get()).unwrap_or(None); + + if let Some(media_query) = media_query.as_ref() { + set_matches(media_query.matches()); + + remove_listener.replace(Some(use_event_listener( + cx, + media_query.clone(), + change, + listen + .get() + .expect("cell should be initialized by now") + .clone(), + ))); + } else { + set_matches(false); + } + }; + + let upd = update.clone(); + listener + .set(Box::new(move |_| upd()) as Box>) + .expect("cell is empty"); + + create_effect(cx, move |_| update()); + + on_cleanup(cx, cleanup); + + matches.into() +} diff --git a/src/utils/clonable_fn.rs b/src/utils/clonable_fn.rs index 4e8510e..00a77bf 100644 --- a/src/utils/clonable_fn.rs +++ b/src/utils/clonable_fn.rs @@ -1,3 +1,5 @@ +use std::fmt::Debug; + pub trait CloneableFnWithReturn: FnOnce() -> R { fn clone_box(&self) -> Box>; } @@ -99,3 +101,38 @@ impl Default for Box> { Box::new(|_| {}) } } + +pub trait CloneableFnMutWithArg: FnMut(Arg) { + fn clone_box(&self) -> Box>; +} + +impl CloneableFnMutWithArg for F +where + F: FnMut(Arg) + 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>", + std::any::type_name::() + ) + } +}