mirror of
https://github.com/adoyle0/leptos-use.git
synced 2025-01-23 09:09:21 -05:00
added use_intersection_observer
This commit is contained in:
Maccesch
parent
35c8b0f40e
commit
ded00a4887
19 changed files with 775 additions and 16 deletions
11
.github/workflows/ci.yml
vendored
11
.github/workflows/ci.yml
vendored
|
|
@ -30,11 +30,12 @@ jobs:
|
||||||
run: python3 docs/generate_count_badge.py --check
|
run: python3 docs/generate_count_badge.py --check
|
||||||
- name: Check formatting
|
- name: Check formatting
|
||||||
run: cargo fmt --check
|
run: cargo fmt --check
|
||||||
- name: Clippy check
|
# TODO: this action doesn't seem to work
|
||||||
uses: auguwu/clippy-action@1.1.2
|
# - name: Clippy check
|
||||||
with:
|
# uses: auguwu/clippy-action@1.1.2
|
||||||
args: --all-features --tests
|
# with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
# args: --all-features --tests
|
||||||
|
# token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: cargo test --all-features
|
run: cargo test --all-features
|
||||||
|
|
||||||
|
|
|
||||||
2
.idea/leptos-use.iml
generated
2
.idea/leptos-use.iml
generated
|
|
@ -24,6 +24,7 @@
|
||||||
<sourceFolder url="file://$MODULE_DIR$/examples/use_media_query/src" isTestSource="false" />
|
<sourceFolder url="file://$MODULE_DIR$/examples/use_media_query/src" isTestSource="false" />
|
||||||
<sourceFolder url="file://$MODULE_DIR$/examples/use_storage/src" isTestSource="false" />
|
<sourceFolder url="file://$MODULE_DIR$/examples/use_storage/src" isTestSource="false" />
|
||||||
<sourceFolder url="file://$MODULE_DIR$/examples/use_breakpoints/src" isTestSource="false" />
|
<sourceFolder url="file://$MODULE_DIR$/examples/use_breakpoints/src" isTestSource="false" />
|
||||||
|
<sourceFolder url="file://$MODULE_DIR$/examples/use_intersection_observer/src" isTestSource="false" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/examples/use_event_listener/target" />
|
<excludeFolder url="file://$MODULE_DIR$/examples/use_event_listener/target" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/target" />
|
<excludeFolder url="file://$MODULE_DIR$/target" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/docs/book/book" />
|
<excludeFolder url="file://$MODULE_DIR$/docs/book/book" />
|
||||||
|
|
@ -44,6 +45,7 @@
|
||||||
<excludeFolder url="file://$MODULE_DIR$/examples/use_media_query/target" />
|
<excludeFolder url="file://$MODULE_DIR$/examples/use_media_query/target" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/examples/use_storage/target" />
|
<excludeFolder url="file://$MODULE_DIR$/examples/use_storage/target" />
|
||||||
<excludeFolder url="file://$MODULE_DIR$/examples/use_breakpoints/target" />
|
<excludeFolder url="file://$MODULE_DIR$/examples/use_breakpoints/target" />
|
||||||
|
<excludeFolder url="file://$MODULE_DIR$/examples/use_intersection_observer/target" />
|
||||||
</content>
|
</content>
|
||||||
<orderEntry type="inheritedJdk" />
|
<orderEntry type="inheritedJdk" />
|
||||||
<orderEntry type="sourceFolder" forTests="false" />
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,12 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 0.2.1
|
||||||
|
|
||||||
|
### New Functions
|
||||||
|
|
||||||
|
- `use_intersection_observer`
|
||||||
|
- `use_element_visibility`
|
||||||
|
|
||||||
## 0.2.0
|
## 0.2.0
|
||||||
|
|
||||||
#### Braking Changes
|
#### Braking Changes
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,9 @@ features = [
|
||||||
"DomRectReadOnly",
|
"DomRectReadOnly",
|
||||||
"Element",
|
"Element",
|
||||||
"HtmlLinkElement",
|
"HtmlLinkElement",
|
||||||
|
"IntersectionObserver",
|
||||||
|
"IntersectionObserverInit",
|
||||||
|
"IntersectionObserverEntry",
|
||||||
"MediaQueryList",
|
"MediaQueryList",
|
||||||
"MouseEvent",
|
"MouseEvent",
|
||||||
"Navigator",
|
"Navigator",
|
||||||
|
|
|
||||||
|
|
@ -14,6 +14,8 @@
|
||||||
# Elements
|
# Elements
|
||||||
|
|
||||||
- [use_element_size](elements/use_element_size.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)
|
||||||
- [use_resize_observer](elements/use_resize_observer.md)
|
- [use_resize_observer](elements/use_resize_observer.md)
|
||||||
|
|
||||||
# Browser
|
# Browser
|
||||||
|
|
|
||||||
3
docs/book/src/elements/use_element_visibility.md
Normal file
3
docs/book/src/elements/use_element_visibility.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# use_element_visibility
|
||||||
|
|
||||||
|
<!-- cmdrun python3 ../extract_doc_comment.py use_element_visibility -->
|
||||||
3
docs/book/src/elements/use_intersection_observer.md
Normal file
3
docs/book/src/elements/use_intersection_observer.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# use_intersection_observer
|
||||||
|
|
||||||
|
<!-- cmdrun python3 ../extract_doc_comment.py use_intersection_observer -->
|
||||||
16
examples/use_intersection_observer/Cargo.toml
Normal file
16
examples/use_intersection_observer/Cargo.toml
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
[package]
|
||||||
|
name = "use_intersection_observer"
|
||||||
|
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"
|
||||||
23
examples/use_intersection_observer/README.md
Normal file
23
examples/use_intersection_observer/README.md
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
A simple example for `use_intersection_observer`.
|
||||||
|
|
||||||
|
If you don't have it installed already, install [Trunk](https://trunkrs.dev/) and [Tailwind](https://tailwindcss.com/docs/installation)
|
||||||
|
as well as the nightly toolchain for Rust and the wasm32-unknown-unknown target:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo install trunk
|
||||||
|
npm install -D tailwindcss @tailwindcss/forms
|
||||||
|
rustup toolchain install nightly
|
||||||
|
rustup target add wasm32-unknown-unknown
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, open two terminals. In the first one, run:
|
||||||
|
|
||||||
|
```
|
||||||
|
npx tailwindcss -i ./input.css -o ./style/output.css --watch
|
||||||
|
```
|
||||||
|
|
||||||
|
In the second one, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
trunk serve --open
|
||||||
|
```
|
||||||
2
examples/use_intersection_observer/Trunk.toml
Normal file
2
examples/use_intersection_observer/Trunk.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
[build]
|
||||||
|
public_url = "/demo/"
|
||||||
7
examples/use_intersection_observer/index.html
Normal file
7
examples/use_intersection_observer/index.html
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link data-trunk rel="css" href="style/output.css">
|
||||||
|
</head>
|
||||||
|
<body></body>
|
||||||
|
</html>
|
||||||
3
examples/use_intersection_observer/input.css
Normal file
3
examples/use_intersection_observer/input.css
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
@tailwind base;
|
||||||
|
@tailwind components;
|
||||||
|
@tailwind utilities;
|
||||||
2
examples/use_intersection_observer/rust-toolchain.toml
Normal file
2
examples/use_intersection_observer/rust-toolchain.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
[toolchain]
|
||||||
|
channel = "nightly"
|
||||||
94
examples/use_intersection_observer/src/main.rs
Normal file
94
examples/use_intersection_observer/src/main.rs
Normal file
|
|
@ -0,0 +1,94 @@
|
||||||
|
use leptos::*;
|
||||||
|
use leptos_use::docs::{demo_or_body, BooleanDisplay};
|
||||||
|
use leptos_use::{
|
||||||
|
use_intersection_observer_with_options, UseIntersectionObserverOptions,
|
||||||
|
UseIntersectionObserverReturn,
|
||||||
|
};
|
||||||
|
|
||||||
|
#[component]
|
||||||
|
fn Demo(cx: Scope) -> impl IntoView {
|
||||||
|
let root = create_node_ref(cx);
|
||||||
|
let target = create_node_ref(cx);
|
||||||
|
let (is_visible, set_visible) = create_signal(cx, false);
|
||||||
|
|
||||||
|
let UseIntersectionObserverReturn {
|
||||||
|
is_active,
|
||||||
|
pause,
|
||||||
|
resume,
|
||||||
|
..
|
||||||
|
} = use_intersection_observer_with_options(
|
||||||
|
cx,
|
||||||
|
target,
|
||||||
|
move |entries, _| {
|
||||||
|
set_visible(entries[0].is_intersecting());
|
||||||
|
},
|
||||||
|
UseIntersectionObserverOptions::default().root(Some(root)),
|
||||||
|
);
|
||||||
|
|
||||||
|
view! { cx,
|
||||||
|
<div class="text-center">
|
||||||
|
<label class="checkbox">
|
||||||
|
<input
|
||||||
|
type="checkbox"
|
||||||
|
prop:checked=is_active
|
||||||
|
name="enabled"
|
||||||
|
on:input=move |e| {
|
||||||
|
if event_target_checked(&e) {
|
||||||
|
resume();
|
||||||
|
} else {
|
||||||
|
pause();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
<span>"Enabled"</span>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div node_ref=root class="root">
|
||||||
|
<p class="notice">"Scroll me down!"</p>
|
||||||
|
<div node_ref=target class="target">
|
||||||
|
<p>"Hello world!"</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="text-center">
|
||||||
|
"Element "
|
||||||
|
<BooleanDisplay value=is_visible true_str="inside" false_str="outside" class="font-bold"/>
|
||||||
|
" the viewport"
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<style>"
|
||||||
|
.root {
|
||||||
|
border: 2px dashed #ccc;
|
||||||
|
height: 200px;
|
||||||
|
margin: 2rem 1rem;
|
||||||
|
overflow-y: scroll;
|
||||||
|
}
|
||||||
|
|
||||||
|
.notice {
|
||||||
|
text-align: center;
|
||||||
|
padding: 2em 0;
|
||||||
|
margin-bottom: 300px;
|
||||||
|
font-style: italic;
|
||||||
|
font-size: 1.2rem;
|
||||||
|
opacity: 0.8;
|
||||||
|
}
|
||||||
|
|
||||||
|
.target {
|
||||||
|
border: 2px dashed var(--brand-color);
|
||||||
|
padding: 10px;
|
||||||
|
max-height: 150px;
|
||||||
|
margin: 0 2rem 400px;
|
||||||
|
}
|
||||||
|
"</style>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
_ = console_log::init_with_level(log::Level::Debug);
|
||||||
|
console_error_panic_hook::set_once();
|
||||||
|
|
||||||
|
mount_to(demo_or_body(), |cx| {
|
||||||
|
view! { cx, <Demo /> }
|
||||||
|
})
|
||||||
|
}
|
||||||
305
examples/use_intersection_observer/style/output.css
Normal file
305
examples/use_intersection_observer/style/output.css
Normal file
|
|
@ -0,0 +1,305 @@
|
||||||
|
[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;
|
||||||
|
}
|
||||||
|
|
||||||
|
.border {
|
||||||
|
border-width: 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.text-center {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.font-bold {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
|
||||||
|
.italic {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.text-\[--brand-color\] {
|
||||||
|
color: var(--brand-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.text-green-600 {
|
||||||
|
--tw-text-opacity: 1;
|
||||||
|
color: rgb(22 163 74 / var(--tw-text-opacity));
|
||||||
|
}
|
||||||
|
|
||||||
|
.opacity-75 {
|
||||||
|
opacity: 0.75;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
.dark\:text-green-500 {
|
||||||
|
--tw-text-opacity: 1;
|
||||||
|
color: rgb(34 197 94 / var(--tw-text-opacity));
|
||||||
|
}
|
||||||
|
}
|
||||||
15
examples/use_intersection_observer/tailwind.config.js
Normal file
15
examples/use_intersection_observer/tailwind.config.js
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
/** @type {import('tailwindcss').Config} */
|
||||||
|
module.exports = {
|
||||||
|
content: {
|
||||||
|
files: ["*.html", "./src/**/*.rs", "../../src/docs/**/*.rs"],
|
||||||
|
},
|
||||||
|
theme: {
|
||||||
|
extend: {},
|
||||||
|
},
|
||||||
|
corePlugins: {
|
||||||
|
preflight: false,
|
||||||
|
},
|
||||||
|
plugins: [
|
||||||
|
require('@tailwindcss/forms'),
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
@ -4,12 +4,12 @@ use leptos::*;
|
||||||
pub fn BooleanDisplay(
|
pub fn BooleanDisplay(
|
||||||
cx: Scope,
|
cx: Scope,
|
||||||
#[prop(into)] value: MaybeSignal<bool>,
|
#[prop(into)] value: MaybeSignal<bool>,
|
||||||
#[prop(optional)] class: String,
|
#[prop(optional, into)] class: String,
|
||||||
|
#[prop(default = "true")] true_str: &'static str,
|
||||||
|
#[prop(default = "false")] false_str: &'static str,
|
||||||
) -> impl IntoView {
|
) -> impl IntoView {
|
||||||
let true_class = "text-green-600 dark:text-green-500";
|
let true_class = "text-green-600 dark:text-green-500";
|
||||||
let false_class = "text-[--brand-color]";
|
let false_class = "text-[--brand-color]";
|
||||||
let true_str = "true";
|
|
||||||
let false_str = "false";
|
|
||||||
|
|
||||||
let class = move || {
|
let class = move || {
|
||||||
format!(
|
format!(
|
||||||
|
|
|
||||||
20
src/lib.rs
20
src/lib.rs
|
|
@ -10,18 +10,25 @@ pub mod math;
|
||||||
pub mod storage;
|
pub mod storage;
|
||||||
pub mod utils;
|
pub mod utils;
|
||||||
|
|
||||||
mod use_breakpoints;
|
|
||||||
mod use_debounce_fn;
|
|
||||||
#[cfg(web_sys_unstable_apis)]
|
#[cfg(web_sys_unstable_apis)]
|
||||||
mod use_element_size;
|
mod use_element_size;
|
||||||
|
#[cfg(web_sys_unstable_apis)]
|
||||||
|
mod use_resize_observer;
|
||||||
|
|
||||||
|
#[cfg(web_sys_unstable_apis)]
|
||||||
|
pub use use_element_size::*;
|
||||||
|
#[cfg(web_sys_unstable_apis)]
|
||||||
|
pub use use_resize_observer::*;
|
||||||
|
|
||||||
|
mod use_breakpoints;
|
||||||
|
mod use_debounce_fn;
|
||||||
mod use_event_listener;
|
mod use_event_listener;
|
||||||
mod use_favicon;
|
mod use_favicon;
|
||||||
|
mod use_intersection_observer;
|
||||||
mod use_media_query;
|
mod use_media_query;
|
||||||
mod use_mouse;
|
mod use_mouse;
|
||||||
mod use_preferred_contrast;
|
mod use_preferred_contrast;
|
||||||
mod use_preferred_dark;
|
mod use_preferred_dark;
|
||||||
#[cfg(web_sys_unstable_apis)]
|
|
||||||
mod use_resize_observer;
|
|
||||||
mod use_scroll;
|
mod use_scroll;
|
||||||
mod use_supported;
|
mod use_supported;
|
||||||
mod use_throttle_fn;
|
mod use_throttle_fn;
|
||||||
|
|
@ -32,16 +39,13 @@ mod watch_throttled;
|
||||||
|
|
||||||
pub use use_breakpoints::*;
|
pub use use_breakpoints::*;
|
||||||
pub use use_debounce_fn::*;
|
pub use use_debounce_fn::*;
|
||||||
#[cfg(web_sys_unstable_apis)]
|
|
||||||
pub use use_element_size::*;
|
|
||||||
pub use use_event_listener::*;
|
pub use use_event_listener::*;
|
||||||
pub use use_favicon::*;
|
pub use use_favicon::*;
|
||||||
|
pub use use_intersection_observer::*;
|
||||||
pub use use_media_query::*;
|
pub use use_media_query::*;
|
||||||
pub use use_mouse::*;
|
pub use use_mouse::*;
|
||||||
pub use use_preferred_contrast::*;
|
pub use use_preferred_contrast::*;
|
||||||
pub use use_preferred_dark::*;
|
pub use use_preferred_dark::*;
|
||||||
#[cfg(web_sys_unstable_apis)]
|
|
||||||
pub use use_resize_observer::*;
|
|
||||||
pub use use_scroll::*;
|
pub use use_scroll::*;
|
||||||
pub use use_supported::*;
|
pub use use_supported::*;
|
||||||
pub use use_throttle_fn::*;
|
pub use use_throttle_fn::*;
|
||||||
|
|
|
||||||
267
src/use_intersection_observer.rs
Normal file
267
src/use_intersection_observer.rs
Normal file
|
|
@ -0,0 +1,267 @@
|
||||||
|
use crate::core::ElementMaybeSignal;
|
||||||
|
use crate::{watch_with_options, WatchOptions};
|
||||||
|
use default_struct_builder::DefaultBuilder;
|
||||||
|
use leptos::*;
|
||||||
|
use std::cell::RefCell;
|
||||||
|
use std::marker::PhantomData;
|
||||||
|
use std::rc::Rc;
|
||||||
|
use wasm_bindgen::prelude::*;
|
||||||
|
|
||||||
|
/// Reactive [IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver).
|
||||||
|
///
|
||||||
|
/// Detects that a target element's visibility inside the viewport.
|
||||||
|
///
|
||||||
|
/// ## Demo
|
||||||
|
///
|
||||||
|
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_intersection_observer)
|
||||||
|
///
|
||||||
|
/// ## Usage
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// # use leptos::*;
|
||||||
|
/// # use leptos_use::use_intersection_observer;
|
||||||
|
/// #
|
||||||
|
/// # #[component]
|
||||||
|
/// # fn Demo(cx: Scope) -> impl IntoView {
|
||||||
|
/// let el = create_node_ref(cx);
|
||||||
|
/// let (is_visible, set_visible) = create_signal(cx, false);
|
||||||
|
///
|
||||||
|
/// use_intersection_observer(
|
||||||
|
/// cx,
|
||||||
|
/// el,
|
||||||
|
/// move |entries, _| {
|
||||||
|
/// set_visible(entries[0].is_intersecting());
|
||||||
|
/// },
|
||||||
|
/// );
|
||||||
|
///
|
||||||
|
/// view! { cx,
|
||||||
|
/// <div node_ref=el>
|
||||||
|
/// <h1>"Hello World"</h1>
|
||||||
|
/// </div>
|
||||||
|
/// }
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// ## See also
|
||||||
|
///
|
||||||
|
/// * [`use_element_visibility`]
|
||||||
|
pub fn use_intersection_observer<El, T, F>(
|
||||||
|
cx: Scope,
|
||||||
|
target: El,
|
||||||
|
callback: F,
|
||||||
|
) -> UseIntersectionObserverReturn<impl Fn() + Clone, impl Fn() + Clone, impl Fn() + Clone>
|
||||||
|
where
|
||||||
|
(Scope, El): Into<ElementMaybeSignal<T, web_sys::Element>>,
|
||||||
|
T: Into<web_sys::Element> + Clone + 'static,
|
||||||
|
F: FnMut(Vec<web_sys::IntersectionObserverEntry>, web_sys::IntersectionObserver)
|
||||||
|
+ Clone
|
||||||
|
+ 'static,
|
||||||
|
{
|
||||||
|
use_intersection_observer_with_options::<El, T, web_sys::Element, web_sys::Element, F>(
|
||||||
|
cx,
|
||||||
|
target,
|
||||||
|
callback,
|
||||||
|
UseIntersectionObserverOptions::default(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Version of [`use_intersection_observer`] that takes a [`UseIntersectionObserverOptions`]. See [`use_intersection_observer`] for how to use.
|
||||||
|
pub fn use_intersection_observer_with_options<El, T, RootEl, RootT, F>(
|
||||||
|
cx: Scope,
|
||||||
|
target: El,
|
||||||
|
callback: F,
|
||||||
|
options: UseIntersectionObserverOptions<RootEl, RootT>,
|
||||||
|
) -> UseIntersectionObserverReturn<impl Fn() + Clone, impl Fn() + Clone, impl Fn() + Clone>
|
||||||
|
where
|
||||||
|
(Scope, El): Into<ElementMaybeSignal<T, web_sys::Element>>,
|
||||||
|
T: Into<web_sys::Element> + Clone + 'static,
|
||||||
|
(Scope, RootEl): Into<ElementMaybeSignal<RootT, web_sys::Element>>,
|
||||||
|
RootT: Into<web_sys::Element> + Clone + 'static,
|
||||||
|
F: FnMut(Vec<web_sys::IntersectionObserverEntry>, web_sys::IntersectionObserver)
|
||||||
|
+ Clone
|
||||||
|
+ 'static,
|
||||||
|
{
|
||||||
|
let UseIntersectionObserverOptions {
|
||||||
|
immediate,
|
||||||
|
root,
|
||||||
|
root_margin,
|
||||||
|
thresholds,
|
||||||
|
..
|
||||||
|
} = options;
|
||||||
|
|
||||||
|
let (is_active, set_active) = create_signal(cx, immediate);
|
||||||
|
|
||||||
|
let observer: Rc<RefCell<Option<web_sys::IntersectionObserver>>> = Rc::new(RefCell::new(None));
|
||||||
|
|
||||||
|
let obs = Rc::clone(&observer);
|
||||||
|
let cleanup = move || {
|
||||||
|
if let Some(o) = obs.take() {
|
||||||
|
o.disconnect();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let target = (cx, target).into();
|
||||||
|
let root = root.map(|root| (cx, root).into());
|
||||||
|
let clean = cleanup.clone();
|
||||||
|
|
||||||
|
let stop_watch = watch_with_options(
|
||||||
|
cx,
|
||||||
|
move || {
|
||||||
|
(
|
||||||
|
target.get(),
|
||||||
|
root.as_ref().map(|root| root.get()),
|
||||||
|
is_active.get(),
|
||||||
|
)
|
||||||
|
},
|
||||||
|
move |values, _, _| {
|
||||||
|
let (target, root, is_active) = values;
|
||||||
|
|
||||||
|
clean();
|
||||||
|
|
||||||
|
if !is_active {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(target) = target {
|
||||||
|
let mut callback = callback.clone();
|
||||||
|
let closure =
|
||||||
|
Closure::<dyn FnMut(js_sys::Array, web_sys::IntersectionObserver)>::new(
|
||||||
|
move |entries: js_sys::Array, observer| {
|
||||||
|
callback(
|
||||||
|
entries
|
||||||
|
.to_vec()
|
||||||
|
.into_iter()
|
||||||
|
.map(|v| {
|
||||||
|
v.unchecked_into::<web_sys::IntersectionObserverEntry>()
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
observer,
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut options = web_sys::IntersectionObserverInit::new();
|
||||||
|
options.root_margin(&root_margin).threshold(
|
||||||
|
&thresholds
|
||||||
|
.iter()
|
||||||
|
.copied()
|
||||||
|
.map(JsValue::from)
|
||||||
|
.collect::<js_sys::Array>(),
|
||||||
|
);
|
||||||
|
|
||||||
|
if let Some(Some(root)) = root {
|
||||||
|
let root: web_sys::Element = root.clone().into();
|
||||||
|
options.root(Some(&root));
|
||||||
|
}
|
||||||
|
|
||||||
|
let obs = web_sys::IntersectionObserver::new_with_options(
|
||||||
|
closure.as_ref().unchecked_ref(),
|
||||||
|
&options,
|
||||||
|
)
|
||||||
|
.expect("failed to create IntersectionObserver");
|
||||||
|
|
||||||
|
closure.forget();
|
||||||
|
|
||||||
|
let target: web_sys::Element = target.clone().into();
|
||||||
|
obs.observe(&target);
|
||||||
|
|
||||||
|
observer.replace(Some(obs));
|
||||||
|
}
|
||||||
|
},
|
||||||
|
WatchOptions::default().immediate(immediate),
|
||||||
|
);
|
||||||
|
|
||||||
|
let clean = cleanup.clone();
|
||||||
|
|
||||||
|
let stop = move || {
|
||||||
|
clean();
|
||||||
|
stop_watch();
|
||||||
|
};
|
||||||
|
|
||||||
|
on_cleanup(cx, stop.clone());
|
||||||
|
|
||||||
|
let clean = cleanup.clone();
|
||||||
|
|
||||||
|
UseIntersectionObserverReturn {
|
||||||
|
is_active: is_active.into(),
|
||||||
|
pause: move || {
|
||||||
|
clean();
|
||||||
|
set_active(false);
|
||||||
|
},
|
||||||
|
resume: move || {
|
||||||
|
cleanup();
|
||||||
|
set_active(true);
|
||||||
|
},
|
||||||
|
stop,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Options for [`use_intersection_observer_with_options`].
|
||||||
|
#[derive(DefaultBuilder)]
|
||||||
|
pub struct UseIntersectionObserverOptions<El, T>
|
||||||
|
where
|
||||||
|
(Scope, El): Into<ElementMaybeSignal<T, web_sys::Element>>,
|
||||||
|
T: Into<web_sys::Element> + Clone + 'static,
|
||||||
|
{
|
||||||
|
/// If `true`, the `IntersectionObserver` will be attached immediately. Otherwise it
|
||||||
|
/// will only be attached after the returned `resume` closure is called. That is
|
||||||
|
/// `use_intersections_observer` will be started "paused".
|
||||||
|
immediate: bool,
|
||||||
|
|
||||||
|
/// 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)
|
||||||
|
root: Option<El>,
|
||||||
|
|
||||||
|
/// A string which specifies a set of offsets to add to the root's [bounding box](https://developer.mozilla.org/en-US/docs/Glossary/Bounding_box)
|
||||||
|
/// when calculating intersections, effectively shrinking or growing the root for calculation purposes. The syntax is approximately the same as that for the CSS
|
||||||
|
/// [`margin`](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) property; see
|
||||||
|
/// [The intersection root and root margin](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#the_intersection_root_and_root_margin)
|
||||||
|
/// for more information on how the margin works and the syntax. The default is `"0px"`.
|
||||||
|
#[builder(into)]
|
||||||
|
root_margin: String,
|
||||||
|
|
||||||
|
// TODO : validate that each number is between 0 and 1 ?
|
||||||
|
/// A `Vec` of numbers between 0.0 and 1.0, specifying a ratio of intersection area to total
|
||||||
|
/// bounding box area for the observed target. A value of 0.0 means that even a single
|
||||||
|
/// visible pixel counts as the target being visible. 1.0 means that the entire target
|
||||||
|
/// element is visible. See [Thresholds](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#thresholds)
|
||||||
|
/// for a more in-depth description of how thresholds are used.
|
||||||
|
/// The default is a single threshold of `[0.0]`.
|
||||||
|
thresholds: Vec<f64>,
|
||||||
|
|
||||||
|
#[builder(skip)]
|
||||||
|
_marker: PhantomData<T>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for UseIntersectionObserverOptions<web_sys::Element, web_sys::Element> {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self {
|
||||||
|
immediate: true,
|
||||||
|
root: None,
|
||||||
|
root_margin: "0px".into(),
|
||||||
|
thresholds: vec![0.0],
|
||||||
|
_marker: PhantomData,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The return value of [`use_intersection_observer`].
|
||||||
|
pub struct UseIntersectionObserverReturn<StopFn, PauseFn, ResumeFn>
|
||||||
|
where
|
||||||
|
StopFn: Fn() + Clone,
|
||||||
|
PauseFn: Fn() + Clone,
|
||||||
|
ResumeFn: Fn() + Clone,
|
||||||
|
{
|
||||||
|
/// Pauses the `IntersectionObserver` observations. Will cause `is_active = false`.
|
||||||
|
pub pause: PauseFn,
|
||||||
|
/// Resumes the `IntersectionObserver` observations. Will cause `is_active = true`.
|
||||||
|
pub resume: ResumeFn,
|
||||||
|
/// Stops the `IntersectionObserver` observations altogether.
|
||||||
|
pub stop: StopFn,
|
||||||
|
/// A signal which is `true` when the `IntersectionObserver` is active, and `false` when paused or stopped.
|
||||||
|
pub is_active: Signal<bool>,
|
||||||
|
}
|
||||||
Loading…
Add table
Reference in a new issue