From 6897c3d1f14f481a1e7dd6d70d89820da55adf07 Mon Sep 17 00:00:00 2001 From: Maccesch Date: Sun, 16 Jul 2023 01:07:52 +0100 Subject: [PATCH] added use_raf_fn --- CHANGELOG.md | 4 + docs/book/src/SUMMARY.md | 1 + docs/book/src/animation/use_raf_fn.md | 3 + examples/Cargo.toml | 1 + examples/use_raf_fn/Cargo.toml | 16 ++ examples/use_raf_fn/README.md | 23 ++ examples/use_raf_fn/Trunk.toml | 2 + examples/use_raf_fn/index.html | 7 + examples/use_raf_fn/input.css | 3 + examples/use_raf_fn/rust-toolchain.toml | 2 + examples/use_raf_fn/src/main.rs | 31 +++ examples/use_raf_fn/style/output.css | 289 ++++++++++++++++++++++++ examples/use_raf_fn/tailwind.config.js | 15 ++ src/lib.rs | 2 + src/use_raf_fn.rs | 155 +++++++++++++ 15 files changed, 554 insertions(+) create mode 100644 docs/book/src/animation/use_raf_fn.md create mode 100644 examples/use_raf_fn/Cargo.toml create mode 100644 examples/use_raf_fn/README.md create mode 100644 examples/use_raf_fn/Trunk.toml create mode 100644 examples/use_raf_fn/index.html create mode 100644 examples/use_raf_fn/input.css create mode 100644 examples/use_raf_fn/rust-toolchain.toml create mode 100644 examples/use_raf_fn/src/main.rs create mode 100644 examples/use_raf_fn/style/output.css create mode 100644 examples/use_raf_fn/tailwind.config.js create mode 100644 src/use_raf_fn.rs diff --git a/CHANGELOG.md b/CHANGELOG.md index bbcf635..4a2b149 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] - +### New Functions 🚀 + +- `use_raf_fn` + ### Braking Changes 🛠 - The following functions now accept a `MaybeRwSignal` as their initial/default value which means diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 4df8b86..bf3eb46 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -51,6 +51,7 @@ - [use_interval](animation/use_interval.md) - [use_interval_fn](animation/use_interval_fn.md) +- [use_raf_fn](animation/use_raf_fn.md) # Watch diff --git a/docs/book/src/animation/use_raf_fn.md b/docs/book/src/animation/use_raf_fn.md new file mode 100644 index 0000000..5bc4ff4 --- /dev/null +++ b/docs/book/src/animation/use_raf_fn.md @@ -0,0 +1,3 @@ +# use_raf_fn + + diff --git a/examples/Cargo.toml b/examples/Cargo.toml index 54aff8f..c959fca 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -26,6 +26,7 @@ members = [ "use_media_query", "use_mouse", "use_mutation_observer", + "use_raf_fn", "use_resize_observer", "use_round", "use_scroll", diff --git a/examples/use_raf_fn/Cargo.toml b/examples/use_raf_fn/Cargo.toml new file mode 100644 index 0000000..d5a120c --- /dev/null +++ b/examples/use_raf_fn/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_raf_fn" +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_raf_fn/README.md b/examples/use_raf_fn/README.md new file mode 100644 index 0000000..bbfc761 --- /dev/null +++ b/examples/use_raf_fn/README.md @@ -0,0 +1,23 @@ +A simple example for `use_raf_fn`. + +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_raf_fn/Trunk.toml b/examples/use_raf_fn/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_raf_fn/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_raf_fn/index.html b/examples/use_raf_fn/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_raf_fn/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_raf_fn/input.css b/examples/use_raf_fn/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_raf_fn/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_raf_fn/rust-toolchain.toml b/examples/use_raf_fn/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_raf_fn/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_raf_fn/src/main.rs b/examples/use_raf_fn/src/main.rs new file mode 100644 index 0000000..df12e80 --- /dev/null +++ b/examples/use_raf_fn/src/main.rs @@ -0,0 +1,31 @@ +use leptos::*; +use leptos_use::docs::demo_or_body; +use leptos_use::{use_raf_fn, utils::Pausable}; + +#[component] +fn Demo(cx: Scope) -> impl IntoView { + let (count, set_count) = create_signal(cx, 0); + + let Pausable { + pause, + resume, + is_active, + } = use_raf_fn(cx, move |_| { + set_count.update(|count| *count += 1); + }); + + view! { cx, +
Count: { count }
+ + + } +} + +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_raf_fn/style/output.css b/examples/use_raf_fn/style/output.css new file mode 100644 index 0000000..ab5191f --- /dev/null +++ b/examples/use_raf_fn/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_raf_fn/tailwind.config.js b/examples/use_raf_fn/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_raf_fn/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 13ec1cc..bc22852 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -42,6 +42,7 @@ mod use_mouse; mod use_mutation_observer; mod use_preferred_contrast; mod use_preferred_dark; +mod use_raf_fn; mod use_scroll; mod use_supported; mod use_throttle_fn; @@ -76,6 +77,7 @@ pub use use_mouse::*; pub use use_mutation_observer::*; pub use use_preferred_contrast::*; pub use use_preferred_dark::*; +pub use use_raf_fn::*; pub use use_scroll::*; pub use use_supported::*; pub use use_throttle_fn::*; diff --git a/src/use_raf_fn.rs b/src/use_raf_fn.rs new file mode 100644 index 0000000..9616f89 --- /dev/null +++ b/src/use_raf_fn.rs @@ -0,0 +1,155 @@ +use crate::utils::Pausable; +use default_struct_builder::DefaultBuilder; +use leptos::*; +use std::cell::RefCell; +use std::rc::Rc; +use wasm_bindgen::closure::Closure; +use wasm_bindgen::JsCast; + +/// Call function on every requestAnimationFrame. +/// With controls of pausing and resuming. +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_raf_fn) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::use_raf_fn; +/// use leptos_use::utils::Pausable; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// let (count, set_count) = create_signal(cx, 0); +/// +/// let Pausable { pause, resume, is_active } = use_raf_fn(cx, move |_| { +/// set_count.update(|count| *count += 1); +/// }); +/// +/// view! { cx,
Count: { count }
} +/// } +/// ``` +/// +/// You can use `use_raf_fn_with_options` and set `immediate` to `false`. In that case +/// you have to call `resume()` before the `callback` is executed. +pub fn use_raf_fn( + cx: Scope, + callback: impl Fn(UseRafFnCallbackArgs) + Clone + 'static, +) -> Pausable { + use_raf_fn_with_options(cx, callback, UseRafFnOptions::default()) +} + +/// Version of [`use_raf_fn`] that takes a `UseRafFnOptions`. See [`use_raf_fn`] for how to use. +pub fn use_raf_fn_with_options( + cx: Scope, + callback: impl Fn(UseRafFnCallbackArgs) + Clone + 'static, + options: UseRafFnOptions, +) -> Pausable { + let UseRafFnOptions { immediate } = options; + + let previous_frame_timestamp = store_value(cx, 0.0_f64); + let raf_handle = store_value(cx, None::); + + let (is_active, set_active) = create_signal(cx, false); + + let loop_ref = Rc::new(RefCell::new(Box::new(|_: f64| {}) as Box)); + + let request_next_frame = { + let loop_ref = Rc::clone(&loop_ref); + + move || { + let loop_ref = Rc::clone(&loop_ref); + + raf_handle.set_value( + window() + .request_animation_frame( + Closure::once_into_js(move |timestamp: f64| { + loop_ref.borrow()(timestamp); + }) + .as_ref() + .unchecked_ref(), + ) + .ok(), + ); + } + }; + + let loop_fn = { + let request_next_frame = request_next_frame.clone(); + + move |timestamp: f64| { + if !is_active.get() { + return; + } + + let prev_timestamp = previous_frame_timestamp.get_value(); + let delta = if prev_timestamp > 0.0 { + timestamp - prev_timestamp + } else { + 0.0 + }; + + callback(UseRafFnCallbackArgs { delta, timestamp }); + + previous_frame_timestamp.set_value(timestamp); + + request_next_frame(); + } + }; + + let _ = loop_ref.replace(Box::new(loop_fn)); + + let resume = move || { + if !is_active.get() { + set_active.set(true); + request_next_frame(); + } + }; + + let pause = move || { + set_active.set(false); + + let handle = raf_handle.get_value(); + if let Some(handle) = handle { + let _ = window().cancel_animation_frame(handle); + } + raf_handle.set_value(None); + }; + + if immediate { + resume(); + } + + on_cleanup(cx, pause); + + Pausable { + resume, + pause, + is_active: is_active.into(), + } +} + +/// Options for [`use_raf_fn_with_options`]. +#[derive(DefaultBuilder)] +pub struct UseRafFnOptions { + /// Start the requestAnimationFrame loop immediately on creation. Defaults to `true`. + /// If false the loop will only start when you call `resume()`. + immediate: bool, +} + +impl Default for UseRafFnOptions { + fn default() -> Self { + Self { immediate: true } + } +} + +/// Type of the argument for the callback of [`use_raf_fn`]. +pub struct UseRafFnCallbackArgs { + /// Time elapsed between this and the last frame. + pub delta: f64, + + /// Time elapsed since the creation of the web page. See [MDN Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#the_time_origin Time origin). + pub timestamp: f64, +}