diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml
index 1e82568..3a00786 100644
--- a/.idea/leptos-use.iml
+++ b/.idea/leptos-use.iml
@@ -24,6 +24,7 @@
+
@@ -45,6 +46,7 @@
+
diff --git a/Cargo.toml b/Cargo.toml
index 84da7d2..ca8e34a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "leptos-use"
-version = "0.2.0"
+version = "0.2.1"
edition = "2021"
authors = ["Marc-Stefan Cassola"]
categories = ["gui", "web-programming"]
diff --git a/README.md b/README.md
index 8a45845..0c602b6 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@
- 
+ 
diff --git a/docs/book/src/demo.css b/docs/book/src/demo.css
index c5cc0f0..d5ce85a 100644
--- a/docs/book/src/demo.css
+++ b/docs/book/src/demo.css
@@ -93,7 +93,7 @@
}
.demo-container input[type=range],
-.demo-container input[type=checkbox]{
+.demo-container input[type=checkbox] {
accent-color: var(--brand-color);
}
@@ -112,4 +112,20 @@
.demo-container input[type="number"]::placeholder,
.demo-container textarea::placeholder {
opacity: 0.7;
+}
+
+.demo-container .float {
+ position: fixed;
+ bottom: 0;
+ right: 0;
+ border: 1px solid var(--theme-popup-border);
+ background: var(--bg);
+ z-index: 100;
+ min-width: 100px;
+}
+
+.demo-container .area {
+ border-width: 2px;
+ border-style: dashed;
+ padding: 1.5rem;
}
\ No newline at end of file
diff --git a/docs/book/src/introduction.md b/docs/book/src/introduction.md
index 19a7406..6548d3d 100644
--- a/docs/book/src/introduction.md
+++ b/docs/book/src/introduction.md
@@ -11,6 +11,6 @@
-
+
\ No newline at end of file
diff --git a/examples/use_element_visibility/Cargo.toml b/examples/use_element_visibility/Cargo.toml
new file mode 100644
index 0000000..0d31009
--- /dev/null
+++ b/examples/use_element_visibility/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "use_element_visibility"
+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/use_element_visibility/README.md b/examples/use_element_visibility/README.md
new file mode 100644
index 0000000..13d615d
--- /dev/null
+++ b/examples/use_element_visibility/README.md
@@ -0,0 +1,23 @@
+A simple example for `use_element_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_element_visibility/Trunk.toml b/examples/use_element_visibility/Trunk.toml
new file mode 100644
index 0000000..3e4be08
--- /dev/null
+++ b/examples/use_element_visibility/Trunk.toml
@@ -0,0 +1,2 @@
+[build]
+public_url = "/demo/"
\ No newline at end of file
diff --git a/examples/use_element_visibility/index.html b/examples/use_element_visibility/index.html
new file mode 100644
index 0000000..ae249a6
--- /dev/null
+++ b/examples/use_element_visibility/index.html
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
diff --git a/examples/use_element_visibility/input.css b/examples/use_element_visibility/input.css
new file mode 100644
index 0000000..bd6213e
--- /dev/null
+++ b/examples/use_element_visibility/input.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
\ No newline at end of file
diff --git a/examples/use_element_visibility/rust-toolchain.toml b/examples/use_element_visibility/rust-toolchain.toml
new file mode 100644
index 0000000..271800c
--- /dev/null
+++ b/examples/use_element_visibility/rust-toolchain.toml
@@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"
\ No newline at end of file
diff --git a/examples/use_element_visibility/src/main.rs b/examples/use_element_visibility/src/main.rs
new file mode 100644
index 0000000..2edb668
--- /dev/null
+++ b/examples/use_element_visibility/src/main.rs
@@ -0,0 +1,33 @@
+use leptos::*;
+use leptos_use::docs::{demo_or_body, BooleanDisplay, Note};
+use leptos_use::use_element_visibility;
+
+#[component]
+fn Demo(cx: Scope) -> impl IntoView {
+ let el = create_node_ref(cx);
+
+ let is_visible = use_element_visibility(cx, el);
+
+ view! { cx,
+
+
"Info on the right bottom corner"
+
+ "Target Element (scroll down)"
+
+
+ "Element "
+
+ " the viewport"
+
+ }
+}
+
+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_element_visibility/style/output.css b/examples/use_element_visibility/style/output.css
new file mode 100644
index 0000000..8a77e45
--- /dev/null
+++ b/examples/use_element_visibility/style/output.css
@@ -0,0 +1,320 @@
+[type='text'],[type='email'],[type='url'],[type='password'],[type='number'],[type='date'],[type='datetime-local'],[type='month'],[type='search'],[type='tel'],[type='time'],[type='week'],[multiple],textarea,select {
+ -webkit-appearance: none;
+ -moz-appearance: none;
+ appearance: none;
+ background-color: #fff;
+ border-color: #6b7280;
+ border-width: 1px;
+ border-radius: 0px;
+ padding-top: 0.5rem;
+ padding-right: 0.75rem;
+ padding-bottom: 0.5rem;
+ padding-left: 0.75rem;
+ font-size: 1rem;
+ line-height: 1.5rem;
+ --tw-shadow: 0 0 #0000;
+}
+
+[type='text']:focus, [type='email']:focus, [type='url']:focus, [type='password']:focus, [type='number']:focus, [type='date']:focus, [type='datetime-local']:focus, [type='month']:focus, [type='search']:focus, [type='tel']:focus, [type='time']:focus, [type='week']:focus, [multiple]:focus, textarea:focus, select:focus {
+ outline: 2px solid transparent;
+ outline-offset: 2px;
+ --tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
+ --tw-ring-offset-width: 0px;
+ --tw-ring-offset-color: #fff;
+ --tw-ring-color: #2563eb;
+ --tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
+ --tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color);
+ box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
+ border-color: #2563eb;
+}
+
+input::-moz-placeholder, textarea::-moz-placeholder {
+ color: #6b7280;
+ opacity: 1;
+}
+
+input::placeholder,textarea::placeholder {
+ color: #6b7280;
+ opacity: 1;
+}
+
+::-webkit-datetime-edit-fields-wrapper {
+ padding: 0;
+}
+
+::-webkit-date-and-time-value {
+ min-height: 1.5em;
+}
+
+::-webkit-datetime-edit,::-webkit-datetime-edit-year-field,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute-field,::-webkit-datetime-edit-second-field,::-webkit-datetime-edit-millisecond-field,::-webkit-datetime-edit-meridiem-field {
+ padding-top: 0;
+ padding-bottom: 0;
+}
+
+select {
+ background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e");
+ background-position: right 0.5rem center;
+ background-repeat: no-repeat;
+ background-size: 1.5em 1.5em;
+ padding-right: 2.5rem;
+ -webkit-print-color-adjust: exact;
+ print-color-adjust: exact;
+}
+
+[multiple] {
+ background-image: initial;
+ background-position: initial;
+ background-repeat: unset;
+ background-size: initial;
+ padding-right: 0.75rem;
+ -webkit-print-color-adjust: unset;
+ print-color-adjust: unset;
+}
+
+[type='checkbox'],[type='radio'] {
+ -webkit-appearance: none;
+ -moz-appearance: none;
+ appearance: none;
+ padding: 0;
+ -webkit-print-color-adjust: exact;
+ print-color-adjust: exact;
+ display: inline-block;
+ vertical-align: middle;
+ background-origin: border-box;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ user-select: none;
+ flex-shrink: 0;
+ height: 1rem;
+ width: 1rem;
+ color: #2563eb;
+ background-color: #fff;
+ border-color: #6b7280;
+ border-width: 1px;
+ --tw-shadow: 0 0 #0000;
+}
+
+[type='checkbox'] {
+ border-radius: 0px;
+}
+
+[type='radio'] {
+ border-radius: 100%;
+}
+
+[type='checkbox']:focus,[type='radio']:focus {
+ outline: 2px solid transparent;
+ outline-offset: 2px;
+ --tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
+ --tw-ring-offset-width: 2px;
+ --tw-ring-offset-color: #fff;
+ --tw-ring-color: #2563eb;
+ --tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
+ --tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);
+ box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
+}
+
+[type='checkbox']:checked,[type='radio']:checked {
+ border-color: transparent;
+ background-color: currentColor;
+ background-size: 100% 100%;
+ background-position: center;
+ background-repeat: no-repeat;
+}
+
+[type='checkbox']:checked {
+ background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3e%3c/svg%3e");
+}
+
+[type='radio']:checked {
+ background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3ccircle cx='8' cy='8' r='3'/%3e%3c/svg%3e");
+}
+
+[type='checkbox']:checked:hover,[type='checkbox']:checked:focus,[type='radio']:checked:hover,[type='radio']:checked:focus {
+ border-color: transparent;
+ background-color: currentColor;
+}
+
+[type='checkbox']:indeterminate {
+ background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3e%3cpath stroke='white' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M4 8h8'/%3e%3c/svg%3e");
+ border-color: transparent;
+ background-color: currentColor;
+ background-size: 100% 100%;
+ background-position: center;
+ background-repeat: no-repeat;
+}
+
+[type='checkbox']:indeterminate:hover,[type='checkbox']:indeterminate:focus {
+ border-color: transparent;
+ background-color: currentColor;
+}
+
+[type='file'] {
+ background: unset;
+ border-color: inherit;
+ border-width: 0;
+ border-radius: 0;
+ padding: 0;
+ font-size: unset;
+ line-height: inherit;
+}
+
+[type='file']:focus {
+ outline: 1px solid ButtonText;
+ outline: 1px auto -webkit-focus-ring-color;
+}
+
+*, ::before, ::after {
+ --tw-border-spacing-x: 0;
+ --tw-border-spacing-y: 0;
+ --tw-translate-x: 0;
+ --tw-translate-y: 0;
+ --tw-rotate: 0;
+ --tw-skew-x: 0;
+ --tw-skew-y: 0;
+ --tw-scale-x: 1;
+ --tw-scale-y: 1;
+ --tw-pan-x: ;
+ --tw-pan-y: ;
+ --tw-pinch-zoom: ;
+ --tw-scroll-snap-strictness: proximity;
+ --tw-gradient-from-position: ;
+ --tw-gradient-via-position: ;
+ --tw-gradient-to-position: ;
+ --tw-ordinal: ;
+ --tw-slashed-zero: ;
+ --tw-numeric-figure: ;
+ --tw-numeric-spacing: ;
+ --tw-numeric-fraction: ;
+ --tw-ring-inset: ;
+ --tw-ring-offset-width: 0px;
+ --tw-ring-offset-color: #fff;
+ --tw-ring-color: rgb(59 130 246 / 0.5);
+ --tw-ring-offset-shadow: 0 0 #0000;
+ --tw-ring-shadow: 0 0 #0000;
+ --tw-shadow: 0 0 #0000;
+ --tw-shadow-colored: 0 0 #0000;
+ --tw-blur: ;
+ --tw-brightness: ;
+ --tw-contrast: ;
+ --tw-grayscale: ;
+ --tw-hue-rotate: ;
+ --tw-invert: ;
+ --tw-saturate: ;
+ --tw-sepia: ;
+ --tw-drop-shadow: ;
+ --tw-backdrop-blur: ;
+ --tw-backdrop-brightness: ;
+ --tw-backdrop-contrast: ;
+ --tw-backdrop-grayscale: ;
+ --tw-backdrop-hue-rotate: ;
+ --tw-backdrop-invert: ;
+ --tw-backdrop-opacity: ;
+ --tw-backdrop-saturate: ;
+ --tw-backdrop-sepia: ;
+}
+
+::backdrop {
+ --tw-border-spacing-x: 0;
+ --tw-border-spacing-y: 0;
+ --tw-translate-x: 0;
+ --tw-translate-y: 0;
+ --tw-rotate: 0;
+ --tw-skew-x: 0;
+ --tw-skew-y: 0;
+ --tw-scale-x: 1;
+ --tw-scale-y: 1;
+ --tw-pan-x: ;
+ --tw-pan-y: ;
+ --tw-pinch-zoom: ;
+ --tw-scroll-snap-strictness: proximity;
+ --tw-gradient-from-position: ;
+ --tw-gradient-via-position: ;
+ --tw-gradient-to-position: ;
+ --tw-ordinal: ;
+ --tw-slashed-zero: ;
+ --tw-numeric-figure: ;
+ --tw-numeric-spacing: ;
+ --tw-numeric-fraction: ;
+ --tw-ring-inset: ;
+ --tw-ring-offset-width: 0px;
+ --tw-ring-offset-color: #fff;
+ --tw-ring-color: rgb(59 130 246 / 0.5);
+ --tw-ring-offset-shadow: 0 0 #0000;
+ --tw-ring-shadow: 0 0 #0000;
+ --tw-shadow: 0 0 #0000;
+ --tw-shadow-colored: 0 0 #0000;
+ --tw-blur: ;
+ --tw-brightness: ;
+ --tw-contrast: ;
+ --tw-grayscale: ;
+ --tw-hue-rotate: ;
+ --tw-invert: ;
+ --tw-saturate: ;
+ --tw-sepia: ;
+ --tw-drop-shadow: ;
+ --tw-backdrop-blur: ;
+ --tw-backdrop-brightness: ;
+ --tw-backdrop-contrast: ;
+ --tw-backdrop-grayscale: ;
+ --tw-backdrop-hue-rotate: ;
+ --tw-backdrop-invert: ;
+ --tw-backdrop-opacity: ;
+ --tw-backdrop-saturate: ;
+ --tw-backdrop-sepia: ;
+}
+
+.static {
+ position: static;
+}
+
+.relative {
+ position: relative;
+}
+
+.m-5 {
+ margin: 1.25rem;
+}
+
+.mb-4 {
+ margin-bottom: 1rem;
+}
+
+.max-w-lg {
+ max-width: 32rem;
+}
+
+.font-bold {
+ font-weight: 700;
+}
+
+.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;
+}
+
+.shadow-lg {
+ --tw-shadow: 0 10px 15px -3px rgb(0 0 0 / 0.1), 0 4px 6px -4px rgb(0 0 0 / 0.1);
+ --tw-shadow-colored: 0 10px 15px -3px var(--tw-shadow-color), 0 4px 6px -4px var(--tw-shadow-color);
+ box-shadow: var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow);
+}
+
+@media (prefers-color-scheme: dark) {
+ .dark\:bg-gray-800 {
+ --tw-bg-opacity: 1;
+ background-color: rgb(31 41 55 / var(--tw-bg-opacity));
+ }
+
+ .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_element_visibility/tailwind.config.js b/examples/use_element_visibility/tailwind.config.js
new file mode 100644
index 0000000..bc09f5e
--- /dev/null
+++ b/examples/use_element_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/examples/use_intersection_observer/src/main.rs b/examples/use_intersection_observer/src/main.rs
index 7b79ddb..19ec4f6 100644
--- a/examples/use_intersection_observer/src/main.rs
+++ b/examples/use_intersection_observer/src/main.rs
@@ -67,10 +67,10 @@ fn Demo(cx: Scope) -> impl IntoView {
.notice {
text-align: center;
- padding: 2em 0;
+ padding: 3em 0;
margin-bottom: 300px;
font-style: italic;
- font-size: 1.2rem;
+ font-size: 1.8rem;
opacity: 0.8;
}
diff --git a/src/lib.rs b/src/lib.rs
index ddd9a7f..ebfaa3d 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -22,6 +22,7 @@ pub use use_resize_observer::*;
mod use_breakpoints;
mod use_debounce_fn;
+mod use_element_visibility;
mod use_event_listener;
mod use_favicon;
mod use_intersection_observer;
@@ -39,6 +40,7 @@ mod watch_throttled;
pub use use_breakpoints::*;
pub use use_debounce_fn::*;
+pub use use_element_visibility::*;
pub use use_event_listener::*;
pub use use_favicon::*;
pub use use_intersection_observer::*;
diff --git a/src/use_element_visibility.rs b/src/use_element_visibility.rs
new file mode 100644
index 0000000..4efd67e
--- /dev/null
+++ b/src/use_element_visibility.rs
@@ -0,0 +1,100 @@
+use crate::core::ElementMaybeSignal;
+use crate::{use_intersection_observer_with_options, UseIntersectionObserverOptions};
+use default_struct_builder::DefaultBuilder;
+use leptos::*;
+use std::marker::PhantomData;
+
+/// Tracks the visibility of an element within the viewport.
+///
+/// ## Demo
+///
+/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_element_visibility)
+///
+/// ## Usage
+///
+/// ```
+/// # use leptos::*;
+/// # use leptos_use::use_element_visibility;
+/// #
+/// # #[component]
+/// # fn Demo(cx: Scope) -> impl IntoView {
+/// let el = create_node_ref(cx);
+///
+/// let is_visible = use_element_visibility(cx, el);
+///
+/// view! { cx,
+///
+///
{is_visible}
+///
+/// }
+/// # }
+/// ```
+///
+/// ## See also
+///
+/// * [`use_intersection_observer`]
+pub fn use_element_visibility(cx: Scope, target: El) -> Signal
+where
+ El: Clone,
+ (Scope, El): Into>,
+ T: Into + Clone + 'static,
+{
+ use_element_visibility_with_options::(
+ cx,
+ target,
+ UseElementVisibilityOptions::default(),
+ )
+}
+
+pub fn use_element_visibility_with_options(
+ cx: Scope,
+ target: El,
+ options: UseElementVisibilityOptions,
+) -> Signal
+where
+ (Scope, El): Into>,
+ T: Into + Clone + 'static,
+ (Scope, ContainerEl): Into>,
+ ContainerT: Into + Clone + 'static,
+{
+ let (is_visible, set_visible) = create_signal(cx, false);
+
+ use_intersection_observer_with_options(
+ cx,
+ target,
+ move |entries, _| {
+ set_visible(entries[0].is_intersecting());
+ },
+ UseIntersectionObserverOptions::default().root(options.viewport),
+ );
+
+ is_visible.into()
+}
+
+/// Options for [`use_element_visibility_with_options`].
+#[derive(DefaultBuilder)]
+pub struct UseElementVisibilityOptions
+where
+ (Scope, El): Into>,
+ T: Into + Clone + 'static,
+{
+ /// A `web_sys::Element` or `web_sys::Document` object which is an ancestor of the intended `target`,
+ /// whose bounding rectangle will be considered the viewport.
+ /// Any part of the target not visible in the visible area of the `root` is not considered visible.
+ /// Defaults to `None` (which means the root `document` will be used).
+ /// Please note that setting this to a `Some(document)` may not be supported by all browsers.
+ /// See [Browser Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/IntersectionObserver#browser_compatibility)
+ viewport: Option,
+
+ #[builder(skip)]
+ _marker: PhantomData,
+}
+
+impl Default for UseElementVisibilityOptions {
+ fn default() -> Self {
+ Self {
+ viewport: None,
+ _marker: PhantomData,
+ }
+ }
+}