From 44aaa14cd6829f80a9cc09e2e0a2f19e7e69631d Mon Sep 17 00:00:00 2001 From: Maccesch Date: Fri, 7 Jul 2023 23:34:50 +0100 Subject: [PATCH] added use_document_visibility --- .idea/leptos-use.iml | 2 + CHANGELOG.md | 3 +- Cargo.toml | 3 +- README.md | 2 +- docs/book/src/SUMMARY.md | 1 + .../src/elements/use_document_visibility.md | 3 + docs/book/src/introduction.md | 2 +- examples/Cargo.toml | 1 + examples/use_document_visibility/Cargo.toml | 16 + examples/use_document_visibility/README.md | 23 ++ examples/use_document_visibility/Trunk.toml | 2 + examples/use_document_visibility/index.html | 7 + examples/use_document_visibility/input.css | 3 + .../rust-toolchain.toml | 2 + examples/use_document_visibility/src/main.rs | 41 +++ .../use_document_visibility/style/output.css | 289 ++++++++++++++++++ .../tailwind.config.js | 15 + src/lib.rs | 2 + src/use_document_visibility.rs | 32 ++ src/use_window_scroll.rs | 2 +- 20 files changed, 446 insertions(+), 5 deletions(-) create mode 100644 docs/book/src/elements/use_document_visibility.md create mode 100644 examples/use_document_visibility/Cargo.toml create mode 100644 examples/use_document_visibility/README.md create mode 100644 examples/use_document_visibility/Trunk.toml create mode 100644 examples/use_document_visibility/index.html create mode 100644 examples/use_document_visibility/input.css create mode 100644 examples/use_document_visibility/rust-toolchain.toml create mode 100644 examples/use_document_visibility/src/main.rs create mode 100644 examples/use_document_visibility/style/output.css create mode 100644 examples/use_document_visibility/tailwind.config.js create mode 100644 src/use_document_visibility.rs diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml index c317cb1..24a8946 100644 --- a/.idea/leptos-use.iml +++ b/.idea/leptos-use.iml @@ -40,7 +40,9 @@ + + diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b350bb..e6a98bf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,12 +3,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [0.4.1] - 2023-07-07 ### New Functions 🚀 - `use_window_focus` - `use_window_scroll` +- `use_document_visibility` ## [0.4.0] - 2023-07-03 diff --git a/Cargo.toml b/Cargo.toml index 0eab610..1e77af5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "leptos-use" -version = "0.4.0" +version = "0.4.1" edition = "2021" authors = ["Marc-Stefan Cassola"] categories = ["gui", "web-programming"] @@ -55,6 +55,7 @@ features = [ "Touch", "TouchEvent", "TouchList", + "VisibilityState", "Window", ] diff --git a/README.md b/README.md index c1d8883..8d97917 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@

Crates.io Docs & Demos - 38 Functions + 41 Functions


diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 0f3b420..9941910 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -14,6 +14,7 @@ # Elements - [use_active_element](elements/use_active_element.md) +- [use_document_visibility](elements/use_document_visibility.md) - [use_element_size](elements/use_element_size.md) - [use_element_visibility](elements/use_element_visibility.md) - [use_intersection_observer](elements/use_intersection_observer.md) diff --git a/docs/book/src/elements/use_document_visibility.md b/docs/book/src/elements/use_document_visibility.md new file mode 100644 index 0000000..9bba161 --- /dev/null +++ b/docs/book/src/elements/use_document_visibility.md @@ -0,0 +1,3 @@ +# use_document_visibility + + diff --git a/docs/book/src/introduction.md b/docs/book/src/introduction.md index 529d56c..5220748 100644 --- a/docs/book/src/introduction.md +++ b/docs/book/src/introduction.md @@ -11,6 +11,6 @@

Crates.io Docs & Demos - 38 Functions + 41 Functions

\ No newline at end of file diff --git a/examples/Cargo.toml b/examples/Cargo.toml index acf29c4..3e8bfcd 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -11,6 +11,7 @@ members = [ "use_css_var", "use_cycle_list", "use_debounce_fn", + "use_document_visibility", "use_element_hover", "use_element_size", "use_element_visibility", diff --git a/examples/use_document_visibility/Cargo.toml b/examples/use_document_visibility/Cargo.toml new file mode 100644 index 0000000..66c39d0 --- /dev/null +++ b/examples/use_document_visibility/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_document_visibility" +version = "0.1.0" +edition = "2021" + +[dependencies] +leptos = { version = "0.4", features = ["nightly", "csr"] } +console_error_panic_hook = "0.1" +console_log = "1" +log = "0.4" +leptos-use = { path = "../..", features = ["docs"] } +web-sys = "0.3" + +[dev-dependencies] +wasm-bindgen = "0.2" +wasm-bindgen-test = "0.3.0" diff --git a/examples/use_document_visibility/README.md b/examples/use_document_visibility/README.md new file mode 100644 index 0000000..5476a30 --- /dev/null +++ b/examples/use_document_visibility/README.md @@ -0,0 +1,23 @@ +A simple example for `use_document_visibility`. + +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_document_visibility/Trunk.toml b/examples/use_document_visibility/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_document_visibility/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_document_visibility/index.html b/examples/use_document_visibility/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_document_visibility/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_document_visibility/input.css b/examples/use_document_visibility/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_document_visibility/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_document_visibility/rust-toolchain.toml b/examples/use_document_visibility/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_document_visibility/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_document_visibility/src/main.rs b/examples/use_document_visibility/src/main.rs new file mode 100644 index 0000000..cc6166a --- /dev/null +++ b/examples/use_document_visibility/src/main.rs @@ -0,0 +1,41 @@ +use leptos::*; +use leptos_use::docs::demo_or_body; +use leptos_use::{use_document_visibility, watch}; +use std::time::Duration; + +#[component] +fn Demo(cx: Scope) -> impl IntoView { + let start_message = "💡 Minimize the page or switch tab then return"; + let (message, set_message) = create_signal(cx, start_message); + let visibility = use_document_visibility(cx); + + let _ = watch(cx, visibility, move |cur, prev, _| { + if let Some(prev) = prev { + if *cur == web_sys::VisibilityState::Visible + && *prev == web_sys::VisibilityState::Hidden + { + set_message("🎉 Welcome back!"); + + set_timeout( + move || { + set_message(start_message); + }, + Duration::from_millis(3000), + ) + } + } + }); + + view! { cx, +
{ message }
+ } +} + +fn main() { + _ = console_log::init_with_level(log::Level::Debug); + console_error_panic_hook::set_once(); + + mount_to(demo_or_body(), |cx| { + view! { cx, } + }) +} diff --git a/examples/use_document_visibility/style/output.css b/examples/use_document_visibility/style/output.css new file mode 100644 index 0000000..ab5191f --- /dev/null +++ b/examples/use_document_visibility/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_document_visibility/tailwind.config.js b/examples/use_document_visibility/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_document_visibility/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 5062315..c33af1e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -21,6 +21,7 @@ pub use use_element_size::*; pub use use_resize_observer::*; mod on_click_outside; +mod use_document_visibility; mod use_window_scroll; mod use_window_focus; mod use_active_element; @@ -51,6 +52,7 @@ mod watch_throttled; mod whenever; pub use on_click_outside::*; +pub use use_document_visibility::*; pub use use_window_scroll::*; pub use use_window_focus::*; pub use use_active_element::*; diff --git a/src/use_document_visibility.rs b/src/use_document_visibility.rs new file mode 100644 index 0000000..18a6895 --- /dev/null +++ b/src/use_document_visibility.rs @@ -0,0 +1,32 @@ +use crate::use_event_listener; +use leptos::ev::visibilitychange; +use leptos::*; + +/// Reactively track `document.visibilityState` +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_document_visibility) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::use_document_visibility; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// let visibility = use_document_visibility(cx); +/// # +/// # view! { cx, } +/// # } +/// ``` +pub fn use_document_visibility(cx: Scope) -> Signal { + let (visibility, set_visibility) = create_signal(cx, document().visibility_state()); + + let _ = use_event_listener(cx, document(), visibilitychange, move |_| { + set_visibility.set(document().visibility_state()); + }); + + visibility.into() +} diff --git a/src/use_window_scroll.rs b/src/use_window_scroll.rs index 6418f30..c037c09 100644 --- a/src/use_window_scroll.rs +++ b/src/use_window_scroll.rs @@ -13,7 +13,7 @@ use web_sys::AddEventListenerOptions; /// /// ``` /// # use leptos::*; -/// use leptos_use::use_window_scroll; +/// # use leptos_use::use_window_scroll; /// # /// # #[component] /// # fn Demo(cx: Scope) -> impl IntoView {