From 3ccdfe8c50cbb7c6ef59b2ab6dfc68f6f1dc65c7 Mon Sep 17 00:00:00 2001 From: Maccesch Date: Fri, 7 Jul 2023 23:07:56 +0100 Subject: [PATCH] added use_window_scroll --- CHANGELOG.md | 1 + docs/book/src/SUMMARY.md | 1 + docs/book/src/elements/use_window_scroll.md | 3 + examples/Cargo.toml | 1 + examples/use_window_scroll/Cargo.toml | 16 + examples/use_window_scroll/README.md | 23 ++ examples/use_window_scroll/Trunk.toml | 2 + examples/use_window_scroll/index.html | 7 + examples/use_window_scroll/input.css | 3 + .../use_window_scroll/rust-toolchain.toml | 2 + examples/use_window_scroll/src/main.rs | 37 +++ examples/use_window_scroll/style/output.css | 289 ++++++++++++++++++ examples/use_window_scroll/tailwind.config.js | 15 + src/lib.rs | 2 + src/use_window_scroll.rs | 45 +++ 15 files changed, 447 insertions(+) create mode 100644 docs/book/src/elements/use_window_scroll.md create mode 100644 examples/use_window_scroll/Cargo.toml create mode 100644 examples/use_window_scroll/README.md create mode 100644 examples/use_window_scroll/Trunk.toml create mode 100644 examples/use_window_scroll/index.html create mode 100644 examples/use_window_scroll/input.css create mode 100644 examples/use_window_scroll/rust-toolchain.toml create mode 100644 examples/use_window_scroll/src/main.rs create mode 100644 examples/use_window_scroll/style/output.css create mode 100644 examples/use_window_scroll/tailwind.config.js create mode 100644 src/use_window_scroll.rs diff --git a/CHANGELOG.md b/CHANGELOG.md index b107560..4b350bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### New Functions 🚀 - `use_window_focus` +- `use_window_scroll` ## [0.4.0] - 2023-07-03 diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index cf5f383..0f3b420 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -20,6 +20,7 @@ - [use_mutation_observer](elements/use_mutation_observer.md) - [use_resize_observer](elements/use_resize_observer.md) - [use_window_focus](elements/use_window_focus.md) +- [use_window_scroll](elements/use_window_scroll.md) # Browser diff --git a/docs/book/src/elements/use_window_scroll.md b/docs/book/src/elements/use_window_scroll.md new file mode 100644 index 0000000..84ff90d --- /dev/null +++ b/docs/book/src/elements/use_window_scroll.md @@ -0,0 +1,3 @@ +# use_window_scroll + + diff --git a/examples/Cargo.toml b/examples/Cargo.toml index d17ba25..acf29c4 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -29,6 +29,7 @@ members = [ "use_storage", "use_throttle_fn", "use_window_focus", + "use_window_scroll", "watch_debounced", "watch_pausable", "watch_throttled", diff --git a/examples/use_window_scroll/Cargo.toml b/examples/use_window_scroll/Cargo.toml new file mode 100644 index 0000000..0925dc9 --- /dev/null +++ b/examples/use_window_scroll/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_window_scroll" +version = "0.1.0" +edition = "2021" + +[dependencies] +leptos = { version = "0.4", features = ["nightly", "csr"] } +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_window_scroll/README.md b/examples/use_window_scroll/README.md new file mode 100644 index 0000000..0fad31a --- /dev/null +++ b/examples/use_window_scroll/README.md @@ -0,0 +1,23 @@ +A simple example for `use_window_scroll`. + +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_window_scroll/Trunk.toml b/examples/use_window_scroll/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_window_scroll/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_window_scroll/index.html b/examples/use_window_scroll/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_window_scroll/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_window_scroll/input.css b/examples/use_window_scroll/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_window_scroll/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_window_scroll/rust-toolchain.toml b/examples/use_window_scroll/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_window_scroll/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_window_scroll/src/main.rs b/examples/use_window_scroll/src/main.rs new file mode 100644 index 0000000..84b545e --- /dev/null +++ b/examples/use_window_scroll/src/main.rs @@ -0,0 +1,37 @@ +use leptos::*; +use leptos_use::docs::{demo_or_body, Note}; +use leptos_use::use_window_scroll; + +#[component] +fn Demo(cx: Scope) -> impl IntoView { + let (x, y) = use_window_scroll(cx); + + let div = document().create_element("div").unwrap(); + div.set_attribute( + "style", + "position: absolute; top: 100%; left: 100%; width: 10000px; height: 10000px;", + ) + .unwrap(); + + document().body().unwrap().append_child(&div).unwrap(); + + view! { cx, +
See scroll values in the lower right corner of the screen.
+
+ Scroll value +
+ x: { move || format!("{:.1}", x()) }
+ y: { move || format!("{:.1}", y()) } +
+
+ } +} + +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_window_scroll/style/output.css b/examples/use_window_scroll/style/output.css new file mode 100644 index 0000000..ab5191f --- /dev/null +++ b/examples/use_window_scroll/style/output.css @@ -0,0 +1,289 @@ +[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: ; +} + +.block { + display: block; +} + +.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_window_scroll/tailwind.config.js b/examples/use_window_scroll/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_window_scroll/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 5827135..5062315 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -21,6 +21,7 @@ pub use use_element_size::*; pub use use_resize_observer::*; mod on_click_outside; +mod use_window_scroll; mod use_window_focus; mod use_active_element; mod use_breakpoints; @@ -50,6 +51,7 @@ mod watch_throttled; mod whenever; pub use on_click_outside::*; +pub use use_window_scroll::*; pub use use_window_focus::*; pub use use_active_element::*; pub use use_breakpoints::*; diff --git a/src/use_window_scroll.rs b/src/use_window_scroll.rs new file mode 100644 index 0000000..6418f30 --- /dev/null +++ b/src/use_window_scroll.rs @@ -0,0 +1,45 @@ +use crate::use_event_listener_with_options; +use leptos::ev::scroll; +use leptos::*; +use web_sys::AddEventListenerOptions; + +/// Reactive window scroll. +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_window_scroll) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// use leptos_use::use_window_scroll; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// let (x, y) = use_window_scroll(cx); +/// # +/// # view! { cx, } +/// # } +/// ``` +pub fn use_window_scroll(cx: Scope) -> (Signal, Signal) { + let (x, set_x) = create_signal(cx, window().scroll_x().unwrap_or_default()); + let (y, set_y) = create_signal(cx, window().scroll_y().unwrap_or_default()); + + let mut options = AddEventListenerOptions::new(); + options.capture(false); + options.passive(true); + + let _ = use_event_listener_with_options( + cx, + window(), + scroll, + move |_| { + set_x.set(window().scroll_x().unwrap_or_default()); + set_y.set(window().scroll_y().unwrap_or_default()); + }, + options, + ); + + (x.into(), y.into()) +}