diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index c06d557..117203a 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -36,6 +36,7 @@ # Animation +- [use_interval](animation/use_interval.md) - [use_interval_fn](animation/use_interval_fn.md) # Watch diff --git a/docs/book/src/animation/use_interval.md b/docs/book/src/animation/use_interval.md new file mode 100644 index 0000000..7c6b277 --- /dev/null +++ b/docs/book/src/animation/use_interval.md @@ -0,0 +1,3 @@ +# use_interval + + diff --git a/examples/Cargo.toml b/examples/Cargo.toml index b8edb5b..dfddd7f 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -12,6 +12,7 @@ members = [ "use_favicon", "use_floor", "use_intersection_observer", + "use_interval", "use_interval_fn", "use_media_query", "use_mouse", diff --git a/examples/use_interval/Cargo.toml b/examples/use_interval/Cargo.toml new file mode 100644 index 0000000..8dfb795 --- /dev/null +++ b/examples/use_interval/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_interval" +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", "math"] } +web-sys = "0.3" + +[dev-dependencies] +wasm-bindgen = "0.2" +wasm-bindgen-test = "0.3.0" diff --git a/examples/use_interval/README.md b/examples/use_interval/README.md new file mode 100644 index 0000000..4eca181 --- /dev/null +++ b/examples/use_interval/README.md @@ -0,0 +1,23 @@ +A simple example for `use_interval`. + +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_interval/Trunk.toml b/examples/use_interval/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_interval/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_interval/index.html b/examples/use_interval/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_interval/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_interval/input.css b/examples/use_interval/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_interval/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_interval/rust-toolchain.toml b/examples/use_interval/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_interval/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_interval/src/main.rs b/examples/use_interval/src/main.rs new file mode 100644 index 0000000..cceb368 --- /dev/null +++ b/examples/use_interval/src/main.rs @@ -0,0 +1,31 @@ +use leptos::*; +use leptos_use::docs::demo_or_body; +use leptos_use::{use_interval, UseIntervalReturn}; + +#[component] +fn Demo(cx: Scope) -> impl IntoView { + let UseIntervalReturn { + counter, + reset, + is_active, + pause, + resume + } = use_interval(cx, 200); + + let (counter_read, _) = create_signal(cx, move || counter()); + + view! { cx, +
+

"Interval fired: " { counter_read() }

+
+ } +} + +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_interval/style/output.css b/examples/use_interval/style/output.css new file mode 100644 index 0000000..2a1a99e --- /dev/null +++ b/examples/use_interval/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: ; +} + +.static { + position: static; +} + +.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_interval/tailwind.config.js b/examples/use_interval/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_interval/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 b4d2c04..358d6d4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -27,6 +27,7 @@ mod use_element_visibility; mod use_event_listener; mod use_favicon; mod use_intersection_observer; +mod use_interval; mod use_interval_fn; mod use_media_query; mod use_mouse; @@ -49,6 +50,7 @@ pub use use_element_visibility::*; pub use use_event_listener::*; pub use use_favicon::*; pub use use_intersection_observer::*; +pub use use_interval::*; pub use use_interval_fn::*; pub use use_media_query::*; pub use use_mouse::*; diff --git a/src/use_interval.rs b/src/use_interval.rs new file mode 100644 index 0000000..dd785ca --- /dev/null +++ b/src/use_interval.rs @@ -0,0 +1,131 @@ +use crate::utils::Pausable; +use crate::{use_interval_fn, use_interval_fn_with_options, UseIntervalFnOptions, watch}; +use default_struct_builder::DefaultBuilder; +use leptos::leptos_dom::helpers::IntervalHandle; +use leptos::*; +use std::cell::Cell; +use std::marker::PhantomData; +use std::rc::Rc; +use std::time::Duration; + +/// Reactive counter increases on every interval. +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_interval) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::{use_interval, UseIntervalReturn}; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// let UseIntervalReturn { +/// counter, +/// reset, +/// is_active, +/// pause, +/// resume +/// } = use_interval( cx, 200 ); +/// # view! { cx, } +/// # } +/// ``` +pub fn use_interval( + cx: Scope, + interval: N, +) -> UseIntervalReturn + where + N: Into>, +{ + use_interval_with_options(cx, interval, UseIntervalOptions { immediate: true, callback: |_: u64| {} }) +} + +/// Version of [`use_interval`] that takes `UseIntervalOptions`. See [`use_interval`] for how to use. +pub fn use_interval_with_options( + cx: Scope, + interval: N, + options: UseIntervalOptions, +) -> UseIntervalReturn + where + CbFn: Fn(u64) + Clone + 'static, + N: Into>, +{ + let UseIntervalOptions { + immediate, + callback, + } = options; + + let (counter, set_counter) = create_signal(cx, 0u64); + + let update = move || set_counter.update(|count| *count += 1); + let reset = move || set_counter(0); + + let cb = + move || { + update(); + callback(counter()); + }; + + let Pausable { is_active, pause, resume } = use_interval_fn_with_options(cx, cb, interval, UseIntervalFnOptions { + immediate, + immediate_callback: false, + }); + + UseIntervalReturn { + counter: counter.into(), + reset, + is_active, + pause, + resume, + } +} + +/// Options for [`use_interval_with_options`] +#[derive(DefaultBuilder)] +pub struct UseIntervalOptions +where + CbFn: Fn(u64) + Clone + 'static, +{ + /// Start the timer immediately. Defaults to `true`. + immediate: bool, + + /// Callback on every interval. + callback: CbFn, +} + +// impl Default for UseIntervalOptions +// where CbFn: Fn(u64) + Clone + 'static +// { +// fn default() -> Self { +// Self { +// immediate: false, +// callback: |_: u64| {}, +// } +// } +// } + +/// Return type of [`use_interval`]. +#[derive(DefaultBuilder)] +pub struct UseIntervalReturn + where + PauseFn: Fn() + Clone, + ResumeFn: Fn() + Clone, + ResetFn: Fn() + Clone, +{ + /// Counter signal that increases by one every interval. + pub counter: Signal, + + /// Reset the counter to zero + pub reset: ResetFn, + + /// A Signal that indicates whether the counter is active. `false` when paused. + pub is_active: Signal, + + /// Temporarily pause the counter + pub pause: PauseFn, + + /// Resume the counter + pub resume: ResumeFn, +} \ No newline at end of file diff --git a/src/use_interval_fn.rs b/src/use_interval_fn.rs index 6348667..30b2372 100644 --- a/src/use_interval_fn.rs +++ b/src/use_interval_fn.rs @@ -131,10 +131,10 @@ where #[derive(DefaultBuilder)] pub struct UseIntervalFnOptions { /// Start the timer immediately. Defaults to `true`. - immediate: bool, + pub immediate: bool, /// Execute the callback immediate after calling this function. Defaults to `false` - immediate_callback: bool, + pub immediate_callback: bool, } impl Default for UseIntervalFnOptions { diff --git a/src/utils/pausable.rs b/src/utils/pausable.rs index 36e0dda..3a1dc34 100644 --- a/src/utils/pausable.rs +++ b/src/utils/pausable.rs @@ -1,4 +1,5 @@ -use leptos::Signal; +use std::cell::Cell; +use leptos::{ReadSignal, Signal}; /// Pausable effect pub struct Pausable