mirror of
https://github.com/adoyle0/leptos-use.git
synced 2025-01-23 00:59:22 -05:00
started adding signal_debounced
This commit is contained in:
Maccesch
parent
a022ac372c
commit
95ef0e2651
16 changed files with 576 additions and 79 deletions
|
|
@ -7,8 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
### New Functions 🚀
|
||||
|
||||
- `signal_debounced`
|
||||
- `signal_throttled`
|
||||
|
||||
### Braking Changes 🛠
|
||||
|
||||
- `watch` is now deprecated in favor of `leptos::watch`. `watch_with_options`
|
||||
will continue to exist.
|
||||
|
||||
## [0.6.0] - 2023-07-17
|
||||
|
||||
### New Functions 🚀
|
||||
|
|
|
|||
3
docs/book/src/reactivity/signal_debounced.md
Normal file
3
docs/book/src/reactivity/signal_debounced.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# signal_debounced
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py signal_debounced -->
|
||||
16
examples/signal_debounced/Cargo.toml
Normal file
16
examples/signal_debounced/Cargo.toml
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
[package]
|
||||
name = "signal_debounced"
|
||||
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"
|
||||
23
examples/signal_debounced/README.md
Normal file
23
examples/signal_debounced/README.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
A simple example for `signal_debounced`.
|
||||
|
||||
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
|
||||
```
|
||||
2
examples/signal_debounced/Trunk.toml
Normal file
2
examples/signal_debounced/Trunk.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
[build]
|
||||
public_url = "/demo/"
|
||||
7
examples/signal_debounced/index.html
Normal file
7
examples/signal_debounced/index.html
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link data-trunk rel="css" href="style/output.css">
|
||||
</head>
|
||||
<body></body>
|
||||
</html>
|
||||
3
examples/signal_debounced/input.css
Normal file
3
examples/signal_debounced/input.css
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
@tailwind base;
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
||||
2
examples/signal_debounced/rust-toolchain.toml
Normal file
2
examples/signal_debounced/rust-toolchain.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
[toolchain]
|
||||
channel = "nightly"
|
||||
21
examples/signal_debounced/src/main.rs
Normal file
21
examples/signal_debounced/src/main.rs
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
use leptos::*;
|
||||
use leptos_use::docs::demo_or_body;
|
||||
use leptos_use::signal_debounced;
|
||||
|
||||
#[component]
|
||||
fn Demo(cx: Scope) -> impl IntoView {
|
||||
|
||||
signal_debounced(cx);
|
||||
|
||||
view! { cx,
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
_ = console_log::init_with_level(log::Level::Debug);
|
||||
console_error_panic_hook::set_once();
|
||||
|
||||
mount_to(demo_or_body(), |cx| {
|
||||
view! { cx, <Demo /> }
|
||||
})
|
||||
}
|
||||
289
examples/signal_debounced/style/output.css
Normal file
289
examples/signal_debounced/style/output.css
Normal file
|
|
@ -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));
|
||||
}
|
||||
}
|
||||
15
examples/signal_debounced/tailwind.config.js
Normal file
15
examples/signal_debounced/tailwind.config.js
Normal file
|
|
@ -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'),
|
||||
],
|
||||
}
|
||||
|
|
@ -25,6 +25,7 @@ mod is_none;
|
|||
mod is_ok;
|
||||
mod is_some;
|
||||
mod on_click_outside;
|
||||
mod signal_debounced;
|
||||
mod signal_throttled;
|
||||
mod use_active_element;
|
||||
mod use_breakpoints;
|
||||
|
|
@ -67,6 +68,7 @@ pub use is_none::*;
|
|||
pub use is_ok::*;
|
||||
pub use is_some::*;
|
||||
pub use on_click_outside::*;
|
||||
pub use signal_debounced::*;
|
||||
pub use signal_throttled::*;
|
||||
pub use use_active_element::*;
|
||||
pub use use_breakpoints::*;
|
||||
|
|
|
|||
62
src/signal_debounced.rs
Normal file
62
src/signal_debounced.rs
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
use crate::utils::signal_filtered;
|
||||
use crate::{use_debounce_fn_with_options, DebounceOptions};
|
||||
use leptos::*;
|
||||
use paste::paste;
|
||||
|
||||
signal_filtered!(
|
||||
/// Debounce changing of a `Signal` value.
|
||||
///
|
||||
/// ## Demo
|
||||
///
|
||||
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/signal_debounced)
|
||||
///
|
||||
/// ## Usage
|
||||
///
|
||||
/// ```
|
||||
/// # use leptos::*;
|
||||
/// # use leptos_use::signal_debounced;
|
||||
/// #
|
||||
/// # #[component]
|
||||
/// # fn Demo(cx: Scope) -> impl IntoView {
|
||||
/// let (input, set_input) = create_signal(cx, "");
|
||||
/// let debounced = signal_debounced(cx, input, 1000.0);
|
||||
/// #
|
||||
/// # view! { cx, }
|
||||
/// # }
|
||||
/// ```
|
||||
///
|
||||
/// ### Options
|
||||
///
|
||||
/// The usual debounce option `max_wait` is available.
|
||||
///
|
||||
/// ```
|
||||
/// # use leptos::*;
|
||||
/// # use leptos_use::{signal_debounced_with_options, DebounceOptions};
|
||||
/// #
|
||||
/// # #[component]
|
||||
/// # fn Demo(cx: Scope) -> impl IntoView {
|
||||
/// let (input, set_input) = create_signal(cx, "");
|
||||
/// let debounced = signal_debounced_with_options(
|
||||
/// cx,
|
||||
/// input,
|
||||
/// 1000.0,
|
||||
/// DebounceOptions::default().max_wait(Some(500.0))
|
||||
/// );
|
||||
/// #
|
||||
/// # view! { cx, }
|
||||
/// # }
|
||||
/// ```
|
||||
///
|
||||
/// ## Recommended Reading
|
||||
///
|
||||
/// - [**Debounce vs Throttle**: Definitive Visual Guide](https://redd.one/blog/debounce-vs-throttle)
|
||||
/// - [Debouncing and Throttling Explained Through Examples](https://css-tricks.com/debouncing-throttling-explained-examples/)
|
||||
///
|
||||
/// ## Server-Side Rendering
|
||||
///
|
||||
/// Internally this uses `setTimeout` which is not supported on the server. So usually
|
||||
/// a throttled signal on the server will simply be ignored.
|
||||
debounce
|
||||
/// [`signal_debounced`]
|
||||
/// [`DebounceOptions`]
|
||||
);
|
||||
|
|
@ -1,82 +1,62 @@
|
|||
use crate::utils::signal_filtered;
|
||||
use crate::{use_throttle_fn_with_options, ThrottleOptions};
|
||||
use leptos::*;
|
||||
use paste::paste;
|
||||
|
||||
/// Throttle changing of a `Signal` value.
|
||||
///
|
||||
/// ## Demo
|
||||
///
|
||||
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/signal_throttled)
|
||||
///
|
||||
/// ## Usage
|
||||
///
|
||||
/// ```
|
||||
/// # use leptos::*;
|
||||
/// # use leptos_use::signal_throttled;
|
||||
/// #
|
||||
/// # #[component]
|
||||
/// # fn Demo(cx: Scope) -> impl IntoView {
|
||||
/// let (input, set_input) = create_signal(cx, "");
|
||||
/// let throttled = signal_throttled(cx, input, 1000.0);
|
||||
/// #
|
||||
/// # view! { cx, }
|
||||
/// # }
|
||||
/// ```
|
||||
///
|
||||
/// ### Options
|
||||
///
|
||||
/// The usual throttle options `leading` and `trailing` are available.
|
||||
///
|
||||
/// ```
|
||||
/// # use leptos::*;
|
||||
/// # use leptos_use::{signal_throttled_with_options, ThrottleOptions};
|
||||
/// #
|
||||
/// # #[component]
|
||||
/// # fn Demo(cx: Scope) -> impl IntoView {
|
||||
/// let (input, set_input) = create_signal(cx, "");
|
||||
/// let throttled = signal_throttled_with_options(cx, input, 1000.0, ThrottleOptions::default().leading(false).trailing(true));
|
||||
/// #
|
||||
/// # view! { cx, }
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn signal_throttled<S, T>(
|
||||
cx: Scope,
|
||||
value: S,
|
||||
ms: impl Into<MaybeSignal<f64>> + 'static,
|
||||
) -> Signal<T>
|
||||
where
|
||||
S: Into<Signal<T>>,
|
||||
T: Clone + 'static,
|
||||
{
|
||||
signal_throttled_with_options(cx, value, ms, ThrottleOptions::default())
|
||||
}
|
||||
|
||||
/// Version of [`signal_throttled`] that takes a `SignalThrottledOptions`. See [`signal_throttled`] for how to use.
|
||||
pub fn signal_throttled_with_options<S, T>(
|
||||
cx: Scope,
|
||||
value: S,
|
||||
ms: impl Into<MaybeSignal<f64>> + 'static,
|
||||
options: ThrottleOptions,
|
||||
) -> Signal<T>
|
||||
where
|
||||
S: Into<Signal<T>>,
|
||||
T: Clone + 'static,
|
||||
{
|
||||
let value = value.into();
|
||||
let ms = ms.into();
|
||||
|
||||
if ms.get_untracked() <= 0.0 {
|
||||
return value;
|
||||
}
|
||||
|
||||
let (throttled, set_throttled) = create_signal(cx, value.get_untracked());
|
||||
|
||||
let update = use_throttle_fn_with_options(
|
||||
move || set_throttled.set(value.get_untracked()),
|
||||
ms,
|
||||
options,
|
||||
);
|
||||
|
||||
let _ = watch(cx, move || value.get(), move |_, _, _| update(), false);
|
||||
|
||||
throttled.into()
|
||||
}
|
||||
signal_filtered!(
|
||||
/// Throttle changing of a `Signal` value.
|
||||
///
|
||||
/// ## Demo
|
||||
///
|
||||
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/signal_throttled)
|
||||
///
|
||||
/// ## Usage
|
||||
///
|
||||
/// ```
|
||||
/// # use leptos::*;
|
||||
/// # use leptos_use::signal_throttled;
|
||||
/// #
|
||||
/// # #[component]
|
||||
/// # fn Demo(cx: Scope) -> impl IntoView {
|
||||
/// let (input, set_input) = create_signal(cx, "");
|
||||
/// let throttled = signal_throttled(cx, input, 1000.0);
|
||||
/// #
|
||||
/// # view! { cx, }
|
||||
/// # }
|
||||
/// ```
|
||||
///
|
||||
/// ### Options
|
||||
///
|
||||
/// The usual throttle options `leading` and `trailing` are available.
|
||||
///
|
||||
/// ```
|
||||
/// # use leptos::*;
|
||||
/// # use leptos_use::{signal_throttled_with_options, ThrottleOptions};
|
||||
/// #
|
||||
/// # #[component]
|
||||
/// # fn Demo(cx: Scope) -> impl IntoView {
|
||||
/// let (input, set_input) = create_signal(cx, "");
|
||||
/// let throttled = signal_throttled_with_options(
|
||||
/// cx,
|
||||
/// input,
|
||||
/// 1000.0,
|
||||
/// ThrottleOptions::default().leading(false).trailing(true)
|
||||
/// );
|
||||
/// #
|
||||
/// # view! { cx, }
|
||||
/// # }
|
||||
/// ```
|
||||
///
|
||||
/// ## Recommended Reading
|
||||
///
|
||||
/// - [**Debounce vs Throttle**: Definitive Visual Guide](https://redd.one/blog/debounce-vs-throttle)
|
||||
/// - [Debouncing and Throttling Explained Through Examples](https://css-tricks.com/debouncing-throttling-explained-examples/)
|
||||
///
|
||||
/// ## Server-Side Rendering
|
||||
///
|
||||
/// Internally this uses `setTimeout` which is not supported on the server. So usually
|
||||
/// a throttled signal on the server will simply be ignored.
|
||||
throttle
|
||||
/// [`signal_throttled`]
|
||||
/// [`ThrottleOptions`]
|
||||
);
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ mod filters;
|
|||
mod is;
|
||||
mod js_value_from_to_string;
|
||||
mod pausable;
|
||||
mod signal_filtered;
|
||||
mod use_derive_signal;
|
||||
|
||||
pub use clonable_fn::*;
|
||||
|
|
@ -10,4 +11,5 @@ pub use filters::*;
|
|||
pub use is::*;
|
||||
pub(crate) use js_value_from_to_string::*;
|
||||
pub use pausable::*;
|
||||
pub(crate) use signal_filtered::*;
|
||||
pub(crate) use use_derive_signal::*;
|
||||
|
|
|
|||
64
src/utils/signal_filtered.rs
Normal file
64
src/utils/signal_filtered.rs
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
macro_rules! signal_filtered {
|
||||
(
|
||||
$(#[$outer:meta])*
|
||||
$filter_name:ident
|
||||
#[$simple_func_doc:meta]
|
||||
#[$options_doc:meta]
|
||||
|
||||
) => {
|
||||
paste! {
|
||||
$(#[$outer])*
|
||||
pub fn [<signal_ $filter_name d>]<S, T>(
|
||||
cx: Scope,
|
||||
value: S,
|
||||
ms: impl Into<MaybeSignal<f64>> + 'static,
|
||||
) -> Signal<T>
|
||||
where
|
||||
S: Into<Signal<T>>,
|
||||
T: Clone + 'static,
|
||||
{
|
||||
[<signal_ $filter_name d_with_options>](cx, value, ms, [<$filter_name:camel Options>]::default())
|
||||
}
|
||||
|
||||
/// Version of
|
||||
#[$simple_func_doc]
|
||||
/// that accepts
|
||||
#[$options_doc]
|
||||
#[doc="."]
|
||||
/// See
|
||||
#[$simple_func_doc]
|
||||
/// for how to use.
|
||||
pub fn [<signal_ $filter_name d_with_options>]<S, T>(
|
||||
cx: Scope,
|
||||
value: S,
|
||||
ms: impl Into<MaybeSignal<f64>> + 'static,
|
||||
options: [<$filter_name:camel Options>],
|
||||
) -> Signal<T>
|
||||
where
|
||||
S: Into<Signal<T>>,
|
||||
T: Clone + 'static,
|
||||
{
|
||||
let value = value.into();
|
||||
let ms = ms.into();
|
||||
|
||||
if ms.get_untracked() <= 0.0 {
|
||||
return value;
|
||||
}
|
||||
|
||||
let (filtered, set_filtered) = create_signal(cx, value.get_untracked());
|
||||
|
||||
let update = [<use_ $filter_name _fn_with_options>](
|
||||
move || set_filtered.set(value.get_untracked()),
|
||||
ms,
|
||||
options,
|
||||
);
|
||||
|
||||
let _ = watch(cx, move || value.get(), move |_, _, _| update(), false);
|
||||
|
||||
filtered.into()
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
pub(crate) use signal_filtered;
|
||||
Loading…
Add table
Reference in a new issue