diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml
index 4513a60..ad25f2d 100644
--- a/.idea/leptos-use.iml
+++ b/.idea/leptos-use.iml
@@ -54,6 +54,8 @@
+
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6b24ab9..4ae15db 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### New Functions 🚀
+- `use_timestamp`
+- `use_idle`
- `use_document`
- `use_window`
- `use_geolocation`
diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
index 2beba1e..cd0e45c 100644
--- a/docs/book/src/SUMMARY.md
+++ b/docs/book/src/SUMMARY.md
@@ -44,6 +44,7 @@
- [on_click_outside](sensors/on_click_outside.md)
- [use_element_hover](sensors/use_element_hover.md)
- [use_geolocation](sensors/use_geolocation.md)
+- [use_idle](sensors/use_idle.md)
- [use_mouse](sensors/use_mouse.md)
- [use_scroll](sensors/use_scroll.md)
@@ -56,6 +57,7 @@
- [use_interval](animation/use_interval.md)
- [use_interval_fn](animation/use_interval_fn.md)
- [use_raf_fn](animation/use_raf_fn.md)
+- [use_timestamp](animation/use_timestamp.md)
# Watch
diff --git a/examples/Cargo.toml b/examples/Cargo.toml
index ee3b98e..f7c5a5d 100644
--- a/examples/Cargo.toml
+++ b/examples/Cargo.toml
@@ -23,6 +23,7 @@ members = [
"use_favicon",
"use_floor",
"use_geolocation",
+ "use_idle",
"use_intersection_observer",
"use_interval",
"use_interval_fn",
@@ -36,6 +37,7 @@ members = [
"use_scroll",
"use_storage",
"use_throttle_fn",
+ "use_timestamp",
"use_websocket",
"use_window_focus",
"use_window_scroll",
diff --git a/examples/use_idle/Cargo.toml b/examples/use_idle/Cargo.toml
new file mode 100644
index 0000000..e26dce6
--- /dev/null
+++ b/examples/use_idle/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "use_idle"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+leptos = { version = "0.5.0-rc1", 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_idle/README.md b/examples/use_idle/README.md
new file mode 100644
index 0000000..98829be
--- /dev/null
+++ b/examples/use_idle/README.md
@@ -0,0 +1,23 @@
+A simple example for `use_idle`.
+
+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_idle/Trunk.toml b/examples/use_idle/Trunk.toml
new file mode 100644
index 0000000..3e4be08
--- /dev/null
+++ b/examples/use_idle/Trunk.toml
@@ -0,0 +1,2 @@
+[build]
+public_url = "/demo/"
\ No newline at end of file
diff --git a/examples/use_idle/index.html b/examples/use_idle/index.html
new file mode 100644
index 0000000..ae249a6
--- /dev/null
+++ b/examples/use_idle/index.html
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
diff --git a/examples/use_idle/input.css b/examples/use_idle/input.css
new file mode 100644
index 0000000..bd6213e
--- /dev/null
+++ b/examples/use_idle/input.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
\ No newline at end of file
diff --git a/examples/use_idle/rust-toolchain.toml b/examples/use_idle/rust-toolchain.toml
new file mode 100644
index 0000000..271800c
--- /dev/null
+++ b/examples/use_idle/rust-toolchain.toml
@@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"
\ No newline at end of file
diff --git a/examples/use_idle/src/main.rs b/examples/use_idle/src/main.rs
new file mode 100644
index 0000000..bd56b53
--- /dev/null
+++ b/examples/use_idle/src/main.rs
@@ -0,0 +1,35 @@
+use leptos::*;
+use leptos_use::docs::{demo_or_body, BooleanDisplay, Note};
+use leptos_use::{use_idle, use_timestamp_with_options, UseIdleReturn, UseTimestampOptions};
+
+#[component]
+fn Demo() -> impl IntoView {
+ let UseIdleReturn {
+ idle, last_active, ..
+ } = use_idle(5000);
+
+ let now = use_timestamp_with_options(UseTimestampOptions::default().interval(1000));
+
+ let idled_for = move || ((now() - last_active()) / 1000.0).ceil() as u64;
+
+ view! {
+
+ For demonstration purpose, the idle timeout is set to 5s in this demo (default 1min).
+
+
+ Idle:
+
+
+ Inactive: {idled_for}s
+
+ }
+}
+
+fn main() {
+ _ = console_log::init_with_level(log::Level::Debug);
+ console_error_panic_hook::set_once();
+
+ mount_to(demo_or_body(), || {
+ view! { }
+ })
+}
diff --git a/examples/use_idle/style/output.css b/examples/use_idle/style/output.css
new file mode 100644
index 0000000..ab5191f
--- /dev/null
+++ b/examples/use_idle/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_idle/tailwind.config.js b/examples/use_idle/tailwind.config.js
new file mode 100644
index 0000000..bc09f5e
--- /dev/null
+++ b/examples/use_idle/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/use_timestamp/Cargo.toml b/examples/use_timestamp/Cargo.toml
new file mode 100644
index 0000000..b70cb73
--- /dev/null
+++ b/examples/use_timestamp/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "use_timestamp"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+leptos = { version = "0.5.0-rc1", 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_timestamp/README.md b/examples/use_timestamp/README.md
new file mode 100644
index 0000000..3b61241
--- /dev/null
+++ b/examples/use_timestamp/README.md
@@ -0,0 +1,23 @@
+A simple example for `use_timestamp`.
+
+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_timestamp/Trunk.toml b/examples/use_timestamp/Trunk.toml
new file mode 100644
index 0000000..3e4be08
--- /dev/null
+++ b/examples/use_timestamp/Trunk.toml
@@ -0,0 +1,2 @@
+[build]
+public_url = "/demo/"
\ No newline at end of file
diff --git a/examples/use_timestamp/index.html b/examples/use_timestamp/index.html
new file mode 100644
index 0000000..ae249a6
--- /dev/null
+++ b/examples/use_timestamp/index.html
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
diff --git a/examples/use_timestamp/input.css b/examples/use_timestamp/input.css
new file mode 100644
index 0000000..bd6213e
--- /dev/null
+++ b/examples/use_timestamp/input.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
\ No newline at end of file
diff --git a/examples/use_timestamp/rust-toolchain.toml b/examples/use_timestamp/rust-toolchain.toml
new file mode 100644
index 0000000..271800c
--- /dev/null
+++ b/examples/use_timestamp/rust-toolchain.toml
@@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"
\ No newline at end of file
diff --git a/examples/use_timestamp/src/main.rs b/examples/use_timestamp/src/main.rs
new file mode 100644
index 0000000..093ffe3
--- /dev/null
+++ b/examples/use_timestamp/src/main.rs
@@ -0,0 +1,21 @@
+use leptos::*;
+use leptos_use::docs::demo_or_body;
+use leptos_use::use_timestamp;
+
+#[component]
+fn Demo() -> impl IntoView {
+ let timestamp = use_timestamp();
+
+ view! {
+ Timestamp: {timestamp}
+ }
+}
+
+fn main() {
+ _ = console_log::init_with_level(log::Level::Debug);
+ console_error_panic_hook::set_once();
+
+ mount_to(demo_or_body(), || {
+ view! { }
+ })
+}
diff --git a/examples/use_timestamp/style/output.css b/examples/use_timestamp/style/output.css
new file mode 100644
index 0000000..ab5191f
--- /dev/null
+++ b/examples/use_timestamp/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_timestamp/tailwind.config.js b/examples/use_timestamp/tailwind.config.js
new file mode 100644
index 0000000..bc09f5e
--- /dev/null
+++ b/examples/use_timestamp/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 3fde831..e71c5e8 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -25,6 +25,8 @@ mod is_none;
mod is_ok;
mod is_some;
mod on_click_outside;
+mod use_timestamp;
+mod use_idle;
mod use_document;
mod use_window;
mod use_geolocation;
@@ -71,6 +73,8 @@ pub use is_none::*;
pub use is_ok::*;
pub use is_some::*;
pub use on_click_outside::*;
+pub use use_timestamp::*;
+pub use use_idle::*;
pub use use_document::*;
pub use use_window::*;
pub use use_geolocation::*;
diff --git a/src/use_idle.rs b/src/use_idle.rs
new file mode 100644
index 0000000..247c867
--- /dev/null
+++ b/src/use_idle.rs
@@ -0,0 +1,191 @@
+use crate::utils::{create_filter_wrapper, DebounceOptions, FilterOptions, ThrottleOptions};
+use crate::{
+ filter_builder_methods, use_document, use_event_listener, use_event_listener_with_options,
+ UseEventListenerOptions,
+};
+use default_struct_builder::DefaultBuilder;
+use leptos::ev::{visibilitychange, Custom};
+use leptos::leptos_dom::helpers::TimeoutHandle;
+use leptos::*;
+use std::cell::Cell;
+use std::time::Duration;
+
+///
+///
+/// ## Demo
+///
+/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_idle)
+///
+/// ## Usage
+///
+/// ```
+/// # use leptos::*;
+/// # use leptos::logging::log;
+/// # use leptos_use::{use_idle, UseIdleReturn};
+/// #
+/// # #[component]
+/// # fn Demo() -> impl IntoView {
+/// let UseIdleReturn {
+/// idle, last_active, ..
+/// } = use_idle(5 * 60 * 1000); // 5 minutes
+///
+/// log!("{}", idle.get()); // true or false
+/// #
+/// # view! { }
+/// # }
+/// ```
+///
+/// Programatically resetting:
+///
+/// ```
+/// # use std::time::Duration;
+/// use leptos::*;
+/// # use leptos::logging::log;
+/// # use leptos_use::{use_idle, UseIdleReturn};
+/// #
+/// # #[component]
+/// # fn Demo() -> impl IntoView {
+/// let UseIdleReturn {
+/// idle, last_active, reset
+/// } = use_idle(5 * 60 * 1000); // 5 minutes
+///
+/// reset(); // restarts the idle timer. Does not change the `last_active` value.
+/// #
+/// # view! { }
+/// # }
+/// ```
+pub fn use_idle(timeout: u64) -> UseIdleReturn {
+ use_idle_with_options(timeout, UseIdleOptions::default())
+}
+
+/// Version of [`use_idle`] that takes a `UseIdleOptions`. See [`use_idle`] for how to use.
+pub fn use_idle_with_options(
+ timeout: u64,
+ options: UseIdleOptions,
+) -> UseIdleReturn {
+ let UseIdleOptions {
+ events,
+ listen_for_visibility_change,
+ initial_state,
+ filter,
+ } = options;
+
+ let (idle, set_idle) = create_signal(initial_state);
+ let (last_active, set_last_active) = create_signal(js_sys::Date::now());
+
+ let reset = {
+ let timer = Cell::new(None::);
+
+ move || {
+ set_idle.set(false);
+ if let Some(timer) = timer.take() {
+ timer.clear();
+ }
+ timer.replace(
+ set_timeout_with_handle(move || set_idle.set(true), Duration::from_millis(timeout))
+ .ok(),
+ );
+ }
+ };
+
+ let on_event = {
+ let reset = reset.clone();
+
+ let filtered_callback = create_filter_wrapper(filter.filter_fn(), move || {
+ set_last_active.set(js_sys::Date::now());
+ reset();
+ });
+
+ move |_: web_sys::Event| {
+ filtered_callback();
+ }
+ };
+
+ let listener_options = UseEventListenerOptions::default().passive(true);
+ for event in events {
+ let _ = use_event_listener_with_options(
+ use_document(),
+ Custom::new(event),
+ on_event.clone(),
+ listener_options,
+ );
+ }
+
+ if listen_for_visibility_change {
+ let on_event = on_event.clone();
+
+ let _ = use_event_listener(use_document(), visibilitychange, move |evt| {
+ if !document().hidden() {
+ on_event(evt);
+ }
+ });
+ }
+
+ reset.clone()();
+
+ UseIdleReturn {
+ idle: idle.into(),
+ last_active: last_active.into(),
+ reset,
+ }
+}
+
+/// Options for [`use_idle_with_options`].
+#[derive(DefaultBuilder)]
+pub struct UseIdleOptions {
+ /// Event names to listen to for detected user activity.
+ /// Default: `vec!["mousemove", "mousedown", "resize", "keydown", "touchstart", "wheel"]`.
+ events: Vec,
+
+ /// Whether to listen for document visibility change.
+ /// Defaults to `true`.
+ listen_for_visibility_change: bool,
+
+ /// Initial state of the returned `idle`.
+ /// Defaults to `false`.
+ initial_state: bool,
+
+ /// Allows to debounce or throttle the event listener that is called for
+ /// every event (from `events`). Defaults to a throttle by 50ms.
+ filter: FilterOptions,
+}
+
+impl Default for UseIdleOptions {
+ fn default() -> Self {
+ Self {
+ events: vec![
+ "mousemove".to_string(),
+ "mousedown".to_string(),
+ "resize".to_string(),
+ "keydown".to_string(),
+ "touchstart".to_string(),
+ "wheel".to_string(),
+ ],
+ listen_for_visibility_change: true,
+ initial_state: false,
+ filter: FilterOptions::throttle(50.0),
+ }
+ }
+}
+
+impl UseIdleOptions {
+ filter_builder_methods!(
+ /// the event listener
+ filter
+ );
+}
+
+/// Return type of [`use_idle`].
+pub struct UseIdleReturn
+where
+ F: Fn() + Clone,
+{
+ /// Wether the use has been inactive for at least `timeout` milliseconds.
+ pub idle: Signal,
+
+ /// Timestamp of last user activity.
+ pub last_active: Signal,
+
+ /// Reset function. Sets the idle state to `false`.
+ pub reset: F,
+}
diff --git a/src/use_timestamp.rs b/src/use_timestamp.rs
new file mode 100644
index 0000000..1718e4f
--- /dev/null
+++ b/src/use_timestamp.rs
@@ -0,0 +1,186 @@
+use crate::utils::Pausable;
+use crate::{
+ use_interval_fn_with_options, use_raf_fn_with_options, UseIntervalFnOptions, UseRafFnOptions,
+};
+use default_struct_builder::DefaultBuilder;
+use leptos::*;
+use std::rc::Rc;
+
+/// Reactive current timestamp.
+///
+/// ## Demo
+///
+/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_timestamp)
+///
+/// ## Usage
+///
+/// ```
+/// # use leptos::*;
+/// # use leptos_use::use_timestamp;
+/// #
+/// # #[component]
+/// # fn Demo() -> impl IntoView {
+/// let timestamp = use_timestamp();
+/// #
+/// # view! { }
+/// # }
+/// ```
+///
+/// With controls:
+///
+/// ```
+/// # use leptos::*;
+/// # use leptos_use::{use_timestamp_with_controls, UseTimestampReturn};
+/// #
+/// # #[component]
+/// # fn Demo() -> impl IntoView {
+/// let UseTimestampReturn {
+/// timestamp,
+/// is_active,
+/// pause,
+/// resume,
+/// } = use_timestamp_with_controls();
+/// #
+/// # view! { }
+/// # }
+/// ```
+///
+/// ## Server-Side Rendering
+///
+/// On the server this function will simply be ignored.
+pub fn use_timestamp() -> Signal {
+ use_timestamp_with_controls().timestamp
+}
+
+/// Version of [`use_timestamp`] that takes a `UseTimestampOptions`. See [`use_timestamp`] for how to use.
+pub fn use_timestamp_with_options(options: UseTimestampOptions) -> Signal {
+ use_timestamp_with_controls_and_options(options).timestamp
+}
+
+/// Version of [`use_timestamp`] that returns controls. See [`use_timestamp`] for how to use.
+pub fn use_timestamp_with_controls() -> UseTimestampReturn {
+ use_timestamp_with_controls_and_options(UseTimestampOptions::default())
+}
+
+/// Version of [`use_timestamp`] that takes a `UseTimestampOptions` and returns controls. See [`use_timestamp`] for how to use.
+pub fn use_timestamp_with_controls_and_options(options: UseTimestampOptions) -> UseTimestampReturn {
+ let UseTimestampOptions {
+ offset,
+ immediate,
+ interval,
+ callback,
+ } = options;
+
+ let (ts, set_ts) = create_signal(js_sys::Date::now() + offset);
+
+ let update = move || {
+ set_ts.set(js_sys::Date::now() + offset);
+ };
+
+ let cb = {
+ let callback = Rc::clone(&callback);
+
+ move || {
+ update();
+ callback(ts.get());
+ }
+ };
+
+ match interval {
+ TimestampInterval::RequestAnimationFrame => {
+ let Pausable {
+ pause,
+ resume,
+ is_active,
+ } = use_raf_fn_with_options(
+ move |_| cb(),
+ UseRafFnOptions::default().immediate(immediate),
+ );
+
+ UseTimestampReturn {
+ timestamp: ts.into(),
+ is_active,
+ pause: Rc::new(pause),
+ resume: Rc::new(resume),
+ }
+ }
+
+ TimestampInterval::Interval(interval) => {
+ let Pausable {
+ pause,
+ resume,
+ is_active,
+ } = use_interval_fn_with_options(
+ cb,
+ interval,
+ UseIntervalFnOptions::default().immediate(immediate),
+ );
+
+ UseTimestampReturn {
+ timestamp: ts.into(),
+ is_active,
+ pause: Rc::new(pause),
+ resume: Rc::new(resume),
+ }
+ }
+ }
+}
+
+/// Options for [`use_timestamp_with_controls_and_options`].
+#[derive(DefaultBuilder)]
+pub struct UseTimestampOptions {
+ /// Offset value in milliseconds that is added to the returned timestamp. Defaults to `0.0`.
+ offset: f64,
+
+ /// Whether to update the timestamp immediately. Defaults to `true`.
+ immediate: bool,
+
+ /// Update interval in milliseconds or `RequestAnimationFrame`. Defaults to `RequestAnimationFrame`.
+ #[builder(into)]
+ interval: TimestampInterval,
+
+ /// Callback to be called whenever the timestamp is updated.
+ callback: Rc,
+}
+
+/// Interval type for [`UseTimestampOptions`].
+#[derive(Copy, Clone, Eq, PartialEq, Debug)]
+pub enum TimestampInterval {
+ /// use [`use_raf_fn`] for updating the timestamp
+ RequestAnimationFrame,
+
+ /// use [`use_interval_fn`] for updating the timestamp
+ Interval(u64),
+}
+
+impl From for TimestampInterval {
+ fn from(value: u64) -> Self {
+ Self::Interval(value)
+ }
+}
+
+impl Default for UseTimestampOptions {
+ fn default() -> Self {
+ Self {
+ offset: 0.0,
+ immediate: true,
+ interval: TimestampInterval::RequestAnimationFrame,
+ callback: Rc::new(|_| {}),
+ }
+ }
+}
+
+/// Return type of [`use_timestamp_with_controls`].
+pub struct UseTimestampReturn {
+ /// The current timestamp
+ pub timestamp: Signal,
+
+ /// A Signal that indicates whether the timestamp updating is active. `false` when paused.
+ pub is_active: Signal,
+
+ /// Temporarily pause the timestamp from updating
+ pub pause: Rc,
+
+ /// Resume the timestamp updating
+ pub resume: Rc,
+}
diff --git a/src/utils/filters/mod.rs b/src/utils/filters/mod.rs
index 7607d33..4a8e5d3 100644
--- a/src/utils/filters/mod.rs
+++ b/src/utils/filters/mod.rs
@@ -56,6 +56,20 @@ pub enum FilterOptions {
}
impl FilterOptions {
+ pub fn debounce(ms: impl Into>) -> Self {
+ Self::Debounce {
+ ms: ms.into(),
+ options: DebounceOptions::default(),
+ }
+ }
+
+ pub fn throttle(ms: impl Into>) -> Self {
+ Self::Throttle {
+ ms: ms.into(),
+ options: ThrottleOptions::default(),
+ }
+ }
+
pub fn filter_fn(&self) -> RcFilterFn!(R)
where
R: 'static,