diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml
index c55e122..8f87229 100644
--- a/.idea/leptos-use.iml
+++ b/.idea/leptos-use.iml
@@ -17,6 +17,8 @@
+
+
@@ -30,6 +32,8 @@
+
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ea515f0..7be3f1a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,11 +2,18 @@
## 0.1.10
+#### Braking Changes
+- `watch` doesn't accept `immediate` as an argument anymore. This is only provided by the option variant.
+
#### New Functions
- `use_local_storage`
+- `watch_debounced`
+- `watch_throttled`
+- `watch_pausable`
-#### Changed Functions
-- `watch` has now variant `watch_with_options` which allows for debouncing and throttling
+#### Other Changes
+
+- `watch` has now variant `watch_with_options` which allows for debouncing and throttling.
## 0.1.8/9
diff --git a/Cargo.toml b/Cargo.toml
index 54fcfd8..47b007f 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -17,8 +17,9 @@ homepage = "https://leptos-use.rs"
leptos = "0.3.0"
wasm-bindgen = "0.2.86"
js-sys = "0.3.63"
-default-struct-builder = "0.2.0"
+default-struct-builder = { path = "../default-struct-builder"}
num = { version = "0.4.0", optional = true }
+serde = "1.0.163"
[dependencies.web-sys]
version = "0.3.63"
@@ -35,9 +36,11 @@ features = [
"ResizeObserverSize",
"ScrollBehavior",
"ScrollToOptions",
+ "Storage",
"Touch",
"TouchEvent",
"TouchList",
+ "Window",
]
[features]
diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
index a00a283..edb6291 100644
--- a/docs/book/src/SUMMARY.md
+++ b/docs/book/src/SUMMARY.md
@@ -22,6 +22,8 @@
# Watch
- [watch](watch/watch.md)
+- [watch_debounced](watch/watch_debounced.md)
+- [watch_throttled](watch/watch_throttled.md)
# Utilities
diff --git a/docs/book/src/custom.css b/docs/book/src/custom.css
index 31d292b..7627d06 100644
--- a/docs/book/src/custom.css
+++ b/docs/book/src/custom.css
@@ -2,6 +2,7 @@
:root {
--brand-color: #EF3939;
+ --brand-color-outline: rgba(239, 57, 57, 0.1);
--brand-color-dark: #9c2525;
--background-color: #ffffff;
--text-color: #856464;
diff --git a/docs/book/src/demo.css b/docs/book/src/demo.css
index 94e43a0..e88253e 100644
--- a/docs/book/src/demo.css
+++ b/docs/book/src/demo.css
@@ -62,17 +62,20 @@
font-size: 1.4rem;
}
-.demo-container input[type="text"], .demo-container input[type="search"], .demo-container input[type="number"] {
+.demo-container input[type="text"],
+.demo-container input[type="search"],
+.demo-container input[type="number"] {
display: block;
font-size: 90%;
padding: .5em 1em .4em;
- border: 1px solid var(--divider-light-color);
+ border: 1px solid var(--theme-popup-border);
border-radius: 4px;
outline: none;
background: var(--background-color);
color: var(--text-color);
min-width: 20rem;
margin: .5rem 0;
+ appearance: none;
}
.demo-container textarea {
@@ -80,6 +83,24 @@
border: 1px solid var(--theme-popup-border);
}
-.demo-container input[type=range] {
+.demo-container input[type=range],
+.demo-container input[type=checkbox]{
accent-color: var(--brand-color);
+}
+
+.demo-container input[type="text"]:focus,
+.demo-container input[type="search"]:focus,
+.demo-container input[type="number"]:focus,
+.demo-container textarea:focus {
+ border-color: var(--brand-color);
+ outline: 4px solid var(--brand-color-outline);
+ outline-offset: 0;
+ box-shadow: none;
+}
+
+.demo-container input[type="text"]::placeholder,
+.demo-container input[type="search"]::placeholder,
+.demo-container input[type="number"]::placeholder,
+.demo-container textarea::placeholder {
+ opacity: 0.7;
}
\ No newline at end of file
diff --git a/docs/book/src/watch/watch_debounced.md b/docs/book/src/watch/watch_debounced.md
new file mode 100644
index 0000000..cb2b45f
--- /dev/null
+++ b/docs/book/src/watch/watch_debounced.md
@@ -0,0 +1,3 @@
+# watch_debounced
+
+
diff --git a/docs/book/src/watch/watch_throttled.md b/docs/book/src/watch/watch_throttled.md
new file mode 100644
index 0000000..062d941
--- /dev/null
+++ b/docs/book/src/watch/watch_throttled.md
@@ -0,0 +1,3 @@
+# watch_throttled
+
+
diff --git a/examples/watch_debounced/Cargo.toml b/examples/watch_debounced/Cargo.toml
new file mode 100644
index 0000000..d3df1b7
--- /dev/null
+++ b/examples/watch_debounced/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "watch_debounced"
+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/watch_debounced/README.md b/examples/watch_debounced/README.md
new file mode 100644
index 0000000..81a733a
--- /dev/null
+++ b/examples/watch_debounced/README.md
@@ -0,0 +1,23 @@
+A simple example for `watch_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
+```
\ No newline at end of file
diff --git a/examples/watch_debounced/Trunk.toml b/examples/watch_debounced/Trunk.toml
new file mode 100644
index 0000000..3e4be08
--- /dev/null
+++ b/examples/watch_debounced/Trunk.toml
@@ -0,0 +1,2 @@
+[build]
+public_url = "/demo/"
\ No newline at end of file
diff --git a/examples/watch_debounced/index.html b/examples/watch_debounced/index.html
new file mode 100644
index 0000000..ae249a6
--- /dev/null
+++ b/examples/watch_debounced/index.html
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
diff --git a/examples/watch_debounced/input.css b/examples/watch_debounced/input.css
new file mode 100644
index 0000000..bd6213e
--- /dev/null
+++ b/examples/watch_debounced/input.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
\ No newline at end of file
diff --git a/examples/watch_debounced/rust-toolchain.toml b/examples/watch_debounced/rust-toolchain.toml
new file mode 100644
index 0000000..271800c
--- /dev/null
+++ b/examples/watch_debounced/rust-toolchain.toml
@@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"
\ No newline at end of file
diff --git a/examples/watch_debounced/src/main.rs b/examples/watch_debounced/src/main.rs
new file mode 100644
index 0000000..a383b0f
--- /dev/null
+++ b/examples/watch_debounced/src/main.rs
@@ -0,0 +1,46 @@
+use leptos::*;
+use leptos_use::docs::{demo_or_body, Note};
+use leptos_use::{watch_debounced_with_options, WatchDebouncedOptions};
+
+#[component]
+fn Demo(cx: Scope) -> impl IntoView {
+ let (input, set_input) = create_signal(cx, "".to_string());
+ let (updated, set_updated) = create_signal(cx, 0);
+
+ let _ = watch_debounced_with_options(
+ cx,
+ input,
+ move |_, _, _| {
+ set_updated.update(|x| *x += 1);
+ },
+ 1000.0,
+ WatchDebouncedOptions::default().max_wait(Some(5000.0)),
+ );
+
+ view! { cx,
+
+
+ "ms"
+ " is set to 1000ms and "
+ "max_wait"
+ " is set to 5000ms for this demo."
+
+ "Input: " { input }
+ "Times Updated: " { updated }
+ }
+}
+
+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/watch_debounced/style/output.css b/examples/watch_debounced/style/output.css
new file mode 100644
index 0000000..ab5191f
--- /dev/null
+++ b/examples/watch_debounced/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/watch_debounced/tailwind.config.js b/examples/watch_debounced/tailwind.config.js
new file mode 100644
index 0000000..bc09f5e
--- /dev/null
+++ b/examples/watch_debounced/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_throttled/Cargo.toml b/examples/watch_throttled/Cargo.toml
new file mode 100644
index 0000000..dbc4789
--- /dev/null
+++ b/examples/watch_throttled/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "watch_throttled"
+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/watch_throttled/README.md b/examples/watch_throttled/README.md
new file mode 100644
index 0000000..54899d1
--- /dev/null
+++ b/examples/watch_throttled/README.md
@@ -0,0 +1,23 @@
+A simple example for `watch_throttled`.
+
+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/watch_throttled/Trunk.toml b/examples/watch_throttled/Trunk.toml
new file mode 100644
index 0000000..3e4be08
--- /dev/null
+++ b/examples/watch_throttled/Trunk.toml
@@ -0,0 +1,2 @@
+[build]
+public_url = "/demo/"
\ No newline at end of file
diff --git a/examples/watch_throttled/index.html b/examples/watch_throttled/index.html
new file mode 100644
index 0000000..ae249a6
--- /dev/null
+++ b/examples/watch_throttled/index.html
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
diff --git a/examples/watch_throttled/input.css b/examples/watch_throttled/input.css
new file mode 100644
index 0000000..bd6213e
--- /dev/null
+++ b/examples/watch_throttled/input.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
\ No newline at end of file
diff --git a/examples/watch_throttled/rust-toolchain.toml b/examples/watch_throttled/rust-toolchain.toml
new file mode 100644
index 0000000..271800c
--- /dev/null
+++ b/examples/watch_throttled/rust-toolchain.toml
@@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"
\ No newline at end of file
diff --git a/examples/watch_throttled/src/main.rs b/examples/watch_throttled/src/main.rs
new file mode 100644
index 0000000..6b86fc4
--- /dev/null
+++ b/examples/watch_throttled/src/main.rs
@@ -0,0 +1,43 @@
+use leptos::*;
+use leptos_use::docs::{demo_or_body, Note};
+use leptos_use::watch_throttled;
+
+#[component]
+fn Demo(cx: Scope) -> impl IntoView {
+ let (input, set_input) = create_signal(cx, "".to_string());
+ let (updated, set_updated) = create_signal(cx, 0);
+
+ let _ = watch_throttled(
+ cx,
+ input,
+ move |_, _, _| {
+ set_updated.update(|x| *x += 1);
+ },
+ 1000.0,
+ );
+
+ view! { cx,
+
+
+ "ms"
+ " is set to 1000ms for this demo."
+
+ "Input: " { input }
+ "Times Updated: " { updated }
+ }
+}
+
+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/watch_throttled/style/output.css b/examples/watch_throttled/style/output.css
new file mode 100644
index 0000000..ab5191f
--- /dev/null
+++ b/examples/watch_throttled/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/watch_throttled/tailwind.config.js b/examples/watch_throttled/tailwind.config.js
new file mode 100644
index 0000000..bc09f5e
--- /dev/null
+++ b/examples/watch_throttled/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 dc7589a..24f9df4 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -6,6 +6,8 @@ pub mod core;
pub mod docs;
#[cfg(feature = "math")]
pub mod math;
+#[cfg(feature = "storage")]
+pub mod storage;
mod use_debounce_fn;
#[cfg(web_sys_unstable_apis)]
mod use_element_size;
@@ -14,10 +16,14 @@ mod use_mouse;
#[cfg(web_sys_unstable_apis)]
mod use_resize_observer;
mod use_scroll;
+mod use_storage;
mod use_supported;
mod use_throttle_fn;
pub mod utils;
mod watch;
+mod watch_debounced;
+mod watch_pausable;
+mod watch_throttled;
pub use use_debounce_fn::*;
#[cfg(web_sys_unstable_apis)]
@@ -27,8 +33,12 @@ pub use use_mouse::*;
#[cfg(web_sys_unstable_apis)]
pub use use_resize_observer::*;
pub use use_scroll::*;
+pub use use_storage::*;
pub use use_supported::*;
pub use use_throttle_fn::*;
pub use watch::*;
+pub use watch_debounced::*;
+pub use watch_pausable::*;
+pub use watch_throttled::*;
extern crate self as leptos_use;
diff --git a/src/use_scroll.rs b/src/use_scroll.rs
index 7ae4e59..ff25e4c 100644
--- a/src/use_scroll.rs
+++ b/src/use_scroll.rs
@@ -9,6 +9,7 @@ use std::borrow::Cow;
use wasm_bindgen::JsCast;
/// Reactive scroll position and state.
+///
/// ## Demo
///
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_scroll)
diff --git a/src/use_storage.rs b/src/use_storage.rs
new file mode 100644
index 0000000..cb0ae0e
--- /dev/null
+++ b/src/use_storage.rs
@@ -0,0 +1,59 @@
+use default_struct_builder::DefaultBuilder;
+use leptos::*;
+use serde::{Deserialize, Serialize};
+use wasm_bindgen::JsValue;
+
+// pub fn use_storage_with_options(
+// cx: Scope,
+// key: &str,
+// defaults: D,
+// options: UseStorageOptions,
+// ) -> (ReadSignal, WriteSignal)
+// where
+// for<'de> T: Serialize + Deserialize<'de> + Clone + 'static,
+// D: Into>,
+// MergeFn: Fn(T, T) -> T,
+// ErrorFn: Fn(JsValue) + Clone,
+// {
+// let defaults = defaults.into();
+//
+// let (data, set_data) = create_signal(cx, defaults.get_untracked());
+//
+// let storage = match options.storage_type {
+// StorageType::Local => window().local_storage(),
+// StorageType::Session => window().session_storage(),
+// };
+//
+// match storage {
+// Ok(Some(storage)) => {}
+// Err(e) => options.on_error(e),
+// _ => {
+// // do nothing
+// }
+// }
+//
+// (data, set_data)
+// }
+
+#[derive(DefaultBuilder)]
+pub struct UseStorageOptions
+where
+ MergeFn: Fn(T, T) -> T,
+ ErrorFn: Fn(JsValue),
+ for<'de> T: Serialize + Deserialize<'de> + 'static,
+{
+ storage_type: StorageType,
+ listen_to_storage_changes: bool,
+ write_defaults: bool,
+ merge_defaults: MergeFn,
+ on_error: ErrorFn,
+
+ _marker: std::marker::PhantomData,
+}
+
+#[derive(Default)]
+pub enum StorageType {
+ #[default]
+ Local,
+ Session,
+}
diff --git a/src/utils/filters/debounce.rs b/src/utils/filters/debounce.rs
index 3c8f722..d196600 100644
--- a/src/utils/filters/debounce.rs
+++ b/src/utils/filters/debounce.rs
@@ -6,7 +6,7 @@ use std::cell::{Cell, RefCell};
use std::rc::Rc;
use std::time::Duration;
-#[derive(Copy, Clone, DefaultBuilder)]
+#[derive(Copy, Clone, DefaultBuilder, Default)]
pub struct DebounceOptions {
/// The maximum time allowed to be delayed before it's invoked.
/// In milliseconds.
@@ -14,14 +14,6 @@ pub struct DebounceOptions {
pub max_wait: MaybeSignal>,
}
-impl Default for DebounceOptions {
- fn default() -> Self {
- Self {
- max_wait: Default::default(),
- }
- }
-}
-
pub fn debounce_filter(
ms: impl Into>,
options: DebounceOptions,
diff --git a/src/utils/filters/mod.rs b/src/utils/filters/mod.rs
index a428845..679e721 100644
--- a/src/utils/filters/mod.rs
+++ b/src/utils/filters/mod.rs
@@ -1,9 +1,7 @@
mod debounce;
-mod pausable;
mod throttle;
pub use debounce::*;
-pub use pausable::*;
pub use throttle::*;
use crate::utils::{CloneableFnWithArgAndReturn, CloneableFnWithReturn};
@@ -11,26 +9,14 @@ use leptos::MaybeSignal;
use std::cell::RefCell;
use std::rc::Rc;
-pub trait FilterFn:
- CloneableFnWithArgAndReturn>, Rc>>>
-{
-}
-
-impl FilterFn for F
-where
- F: Fn(Box>) -> Rc>> + Clone + 'static,
- R: 'static,
-{
-}
-
-impl Clone for Box> {
- fn clone(&self) -> Self {
- (*self).clone()
+macro_rules! BoxFilterFn {
+ ($R:ident) => {
+ Box>, Rc>>>>
}
}
pub fn create_filter_wrapper(
- filter: Box>,
+ filter: BoxFilterFn!(R),
func: F,
) -> impl Fn() -> Rc>> + Clone
where
@@ -41,7 +27,7 @@ where
}
pub fn create_filter_wrapper_with_arg(
- filter: Box>,
+ filter: BoxFilterFn!(R),
func: F,
) -> impl Fn(Arg) -> Rc>> + Clone
where
@@ -55,6 +41,7 @@ where
}
}
+/// Specify a debounce or throttle filter with their respective options or no filter
#[derive(Default)]
pub enum FilterOptions {
#[default]
@@ -70,7 +57,7 @@ pub enum FilterOptions {
}
impl FilterOptions {
- pub fn filter_fn(&self) -> Box>
+ pub fn filter_fn(&self) -> BoxFilterFn!(R)
where
R: 'static,
{
@@ -88,6 +75,7 @@ impl FilterOptions {
}
}
+/// Defines builder methods to define filter options without having to use nested methods
#[macro_export]
macro_rules! filter_builder_methods {
(
diff --git a/src/utils/filters/throttle.rs b/src/utils/filters/throttle.rs
index 24eabd9..1b50400 100644
--- a/src/utils/filters/throttle.rs
+++ b/src/utils/filters/throttle.rs
@@ -10,7 +10,9 @@ use std::time::Duration;
#[derive(Copy, Clone, DefaultBuilder)]
pub struct ThrottleOptions {
+ /// Invoke on the trailing edge of the timeout. Defaults to `true`.
pub trailing: bool,
+ /// Invoke on the leading edge of the timeout. Defaults to `true`.
pub leading: bool,
}
diff --git a/src/watch.rs b/src/watch.rs
index 4800ff1..a184a79 100644
--- a/src/watch.rs
+++ b/src/watch.rs
@@ -1,4 +1,4 @@
-use crate::utils::{create_filter_wrapper, create_filter_wrapper_with_arg, FilterOptions};
+use crate::utils::{create_filter_wrapper, FilterOptions};
use crate::{filter_builder_methods, DebounceOptions, ThrottleOptions};
use default_struct_builder::DefaultBuilder;
use leptos::*;
@@ -10,7 +10,7 @@ use std::rc::Rc;
/// The return value of `deps` is passed into `callback` as an argument together with the previous value
/// and the previous value that the `callback` itself returned last time.
///
-/// # Usage
+/// ## Usage
///
/// ```
/// # use std::time::Duration;
@@ -26,7 +26,7 @@ use std::rc::Rc;
/// move |num, _, _| {
/// log!("number {}", num);
/// },
-/// ); // > "number 0"
+/// );
///
/// set_num(1); // > "number 1"
///
@@ -41,7 +41,8 @@ use std::rc::Rc;
///
/// ## Immediate
///
-/// If `immediate` is false, the `callback` will not run immediately but only after
+/// If `immediate` is true, the `callback` will run immediately.
+/// If it's `false, the `callback` will run only after
/// the first change is detected of any signal that is accessed in `deps`.
///
/// ```
@@ -57,8 +58,8 @@ use std::rc::Rc;
/// move |num, _, _| {
/// log!("number {}", num);
/// },
-/// WatchOptions::default().immediate(false),
-/// ); // nothing happens
+/// WatchOptions::default().immediate(true),
+/// ); // > "number 0"
///
/// set_num(1); // > "number 1"
/// # view! { cx, }
@@ -154,7 +155,8 @@ where
)
};
- let filtered_callback = create_filter_wrapper(options.filter.filter_fn(), wrapped_callback);
+ let filtered_callback =
+ create_filter_wrapper(options.filter.filter_fn(), wrapped_callback.clone());
create_effect(cx, move |did_run_before| {
if !is_active() {
@@ -170,7 +172,11 @@ where
cur_deps_value.replace(Some(deps_value.clone()));
- let callback_value = filtered_callback().take();
+ let callback_value = if options.immediate && did_run_before.is_none() {
+ Some(wrapped_callback())
+ } else {
+ filtered_callback().take()
+ };
prev_callback_value.replace(callback_value);
@@ -185,26 +191,17 @@ where
}
/// Options for `watch_with_options`
-#[derive(DefaultBuilder)]
+#[derive(DefaultBuilder, Default)]
pub struct WatchOptions {
- /// If `immediate` is false, the `callback` will not run immediately but only after
+ /// If `immediate` is true, the `callback` will run immediately.
+ /// If it's `false, the `callback` will run only after
/// the first change is detected of any signal that is accessed in `deps`.
- /// Defaults to `true`.
immediate: bool,
#[builder(skip)]
filter: FilterOptions,
}
-impl Default for WatchOptions {
- fn default() -> Self {
- Self {
- immediate: true,
- filter: Default::default(),
- }
- }
-}
-
impl WatchOptions {
filter_builder_methods!(
/// the watch callback
diff --git a/src/watch_debounced.rs b/src/watch_debounced.rs
new file mode 100644
index 0000000..f71338e
--- /dev/null
+++ b/src/watch_debounced.rs
@@ -0,0 +1,116 @@
+use default_struct_builder::DefaultBuilder;
+use leptos::*;
+use leptos_use::{watch_with_options, DebounceOptions, WatchOptions};
+
+/// A debounced version of [`watch`].
+///
+/// ## Demo
+///
+/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/watch_debounced)
+///
+/// ## Usage
+///
+/// ```
+/// # use std::time::Duration;
+/// # use leptos::*;
+/// # use leptos_use::watch_debounced;
+/// #
+/// # pub fn Demo(cx: Scope) -> impl IntoView {
+/// # let (source, set_source) = create_signal(cx, 0);
+/// #
+/// watch_debounced(
+/// cx,
+/// source,
+/// move |_, _, _| {
+/// log!("changed!");
+/// },
+/// 500.0,
+/// );
+///
+/// # view! { cx, }
+/// # }
+/// ```
+///
+/// This really is only shorthand shorthand for `watch_with_options(cx, deps, callback, WatchOptions::default().debounce(ms))`.
+///
+/// There's also `watch_debounced_with_options` where you can specify the other watch options (except `filter`).
+///
+/// ```
+/// # use std::time::Duration;
+/// # use leptos::*;
+/// # use leptos_use::{watch_debounced_with_options, WatchDebouncedOptions};
+/// #
+/// # pub fn Demo(cx: Scope) -> impl IntoView {
+/// # let (source, set_source) = create_signal(cx, 0);
+/// #
+/// watch_debounced_with_options(
+/// cx,
+/// source,
+/// move |_, _, _| {
+/// log!("changed!");
+/// },
+/// 500.0,
+/// WatchDebouncedOptions::default().max_wait(Some(1000.0)),
+/// );
+///
+/// # view! { cx, }
+/// # }
+/// ```
+///
+/// ## See also
+///
+/// * [`watch`]
+/// * [`watch_throttled`]
+pub fn watch_debounced(
+ cx: Scope,
+ deps: DFn,
+ callback: CFn,
+ ms: f64,
+) -> impl Fn() + Clone
+where
+ DFn: Fn() -> W + 'static,
+ CFn: Fn(&W, Option<&W>, Option) -> T + Clone + 'static,
+ W: Clone + 'static,
+ T: Clone + 'static,
+{
+ watch_with_options(cx, deps, callback, WatchOptions::default().debounce(ms))
+}
+
+/// Version of `watch_debounced` that accepts `WatchDebouncedOptions`. See [`watch_debounced`] for how to use.
+pub fn watch_debounced_with_options(
+ cx: Scope,
+ deps: DFn,
+ callback: CFn,
+ ms: f64,
+ options: WatchDebouncedOptions,
+) -> impl Fn() + Clone
+where
+ DFn: Fn() -> W + 'static,
+ CFn: Fn(&W, Option<&W>, Option) -> T + Clone + 'static,
+ W: Clone + 'static,
+ T: Clone + 'static,
+{
+ watch_with_options(
+ cx,
+ deps,
+ callback,
+ WatchOptions::default()
+ .debounce_with_options(ms, DebounceOptions::default().max_wait(options.max_wait))
+ .immediate(options.immediate),
+ )
+}
+
+/// Options for [`watch_debounced_with_options`].
+#[derive(DefaultBuilder, Default)]
+pub struct WatchDebouncedOptions {
+ /// If `immediate` is false, the `callback` will not run immediately but only after
+ /// the first change is detected of any signal that is accessed in `deps`.
+ /// Defaults to `true`.
+ immediate: bool,
+
+ /// The maximum time allowed to be delayed before the callback invoked.
+ /// In milliseconds.
+ /// Same as [`DebounceOptions::max_wait`]
+ #[builder(into)]
+ pub max_wait: MaybeSignal>,
+}
diff --git a/src/watch_throttled.rs b/src/watch_throttled.rs
new file mode 100644
index 0000000..bb4857e
--- /dev/null
+++ b/src/watch_throttled.rs
@@ -0,0 +1,130 @@
+use default_struct_builder::DefaultBuilder;
+use leptos::*;
+use leptos_use::{watch_with_options, ThrottleOptions, WatchOptions};
+
+/// A throttled version of [`watch`].
+///
+/// ## Demo
+///
+/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/watch_throttled)
+///
+/// ## Usage
+///
+/// ```
+/// # use std::time::Duration;
+/// # use leptos::*;
+/// # use leptos_use::watch_throttled;
+/// #
+/// # pub fn Demo(cx: Scope) -> impl IntoView {
+/// # let (source, set_source) = create_signal(cx, 0);
+/// #
+/// watch_throttled(
+/// cx,
+/// source,
+/// move |_, _, _| {
+/// log!("changed!");
+/// },
+/// 500.0,
+/// );
+///
+/// # view! { cx, }
+/// # }
+/// ```
+///
+/// This really is only shorthand shorthand for `watch_with_options(cx, deps, callback, WatchOptions::default().throttle(ms))`.
+///
+/// There's also `watch_throttled_with_options` where you can specify the other watch options (except `filter`).
+///
+/// ```
+/// # use std::time::Duration;
+/// # use leptos::*;
+/// # use leptos_use::{watch_throttled_with_options, WatchThrottledOptions};
+/// #
+/// # pub fn Demo(cx: Scope) -> impl IntoView {
+/// # let (source, set_source) = create_signal(cx, 0);
+/// #
+/// watch_throttled_with_options(
+/// cx,
+/// source,
+/// move |_, _, _| {
+/// log!("changed!");
+/// },
+/// 500.0,
+/// WatchThrottledOptions::default().leading(true).trailing(false),
+/// );
+///
+/// # view! { cx, }
+/// # }
+/// ```
+///
+/// ## See also
+///
+/// * [`watch`]
+/// * [`watch_debounced`]
+pub fn watch_throttled(
+ cx: Scope,
+ deps: DFn,
+ callback: CFn,
+ ms: f64,
+) -> impl Fn() + Clone
+where
+ DFn: Fn() -> W + 'static,
+ CFn: Fn(&W, Option<&W>, Option) -> T + Clone + 'static,
+ W: Clone + 'static,
+ T: Clone + 'static,
+{
+ watch_with_options(cx, deps, callback, WatchOptions::default().throttle(ms))
+}
+
+/// Version of `watch_throttled` that accepts `WatchThrottledOptions`. See [`watch_throttled`] for how to use.
+pub fn watch_throttled_with_options(
+ cx: Scope,
+ deps: DFn,
+ callback: CFn,
+ ms: f64,
+ options: WatchThrottledOptions,
+) -> impl Fn() + Clone
+where
+ DFn: Fn() -> W + 'static,
+ CFn: Fn(&W, Option<&W>, Option) -> T + Clone + 'static,
+ W: Clone + 'static,
+ T: Clone + 'static,
+{
+ watch_with_options(
+ cx,
+ deps,
+ callback,
+ WatchOptions::default()
+ .throttle_with_options(
+ ms,
+ ThrottleOptions::default()
+ .leading(options.leading)
+ .trailing(options.trailing),
+ )
+ .immediate(options.immediate),
+ )
+}
+
+/// Options for [`watch_throttled_with_options`].
+#[derive(DefaultBuilder)]
+pub struct WatchThrottledOptions {
+ /// If `immediate` is false, the `callback` will not run immediately but only after
+ /// the first change is detected of any signal that is accessed in `deps`.
+ /// Defaults to `true`.
+ immediate: bool,
+
+ /// Invoke on the trailing edge of the timeout. Defaults to `true`.
+ pub trailing: bool,
+ /// Invoke on the leading edge of the timeout. Defaults to `true`.
+ pub leading: bool,
+}
+
+impl Default for WatchThrottledOptions {
+ fn default() -> Self {
+ Self {
+ immediate: false,
+ trailing: true,
+ leading: true,
+ }
+ }
+}