1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
use crate::core::{Direction, Directions, ElementMaybeSignal};
use crate::UseEventListenerOptions;
use cfg_if::cfg_if;
use default_struct_builder::DefaultBuilder;
use leptos::*;
use std::rc::Rc;
cfg_if! { if #[cfg(not(feature = "ssr"))] {
use crate::use_event_listener::use_event_listener_with_options;
use crate::{
use_debounce_fn_with_arg, use_throttle_fn_with_arg_and_options, ThrottleOptions,
};
use leptos::ev::scrollend;
use wasm_bindgen::JsCast;
/// We have to check if the scroll amount is close enough to some threshold in order to
/// more accurately calculate arrivedState. This is because scrollTop/scrollLeft are non-rounded
/// numbers, while scrollHeight/scrollWidth and clientHeight/clientWidth are rounded.
/// https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollHeight#determine_if_an_element_has_been_totally_scrolled
const ARRIVED_STATE_THRESHOLD_PIXELS: f64 = 1.0;
}}
/// Reactive scroll position and state.
///
/// ## Demo
///
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_scroll)
///
/// ## Usage
///
/// ```
/// # use leptos::*;
/// # use leptos::ev::resize;
/// # use leptos::html::Div;
/// # use leptos_use::{use_scroll, UseScrollReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let element = create_node_ref::<Div>();
///
/// let UseScrollReturn {
/// x, y, set_x, set_y, is_scrolling, arrived_state, directions, ..
/// } = use_scroll(element);
///
/// view! {
/// <div node_ref=element>"..."</div>
/// }
/// # }
/// ```
///
/// ### With Offsets
///
/// You can provide offsets when you use [`use_scroll_with_options`].
/// These offsets are thresholds in pixels when a side is considered to have arrived. This is reflected in the return field `arrived_state`.
///
/// ```
/// # use leptos::*;
/// # use leptos::html::Div;
/// # use leptos::ev::resize;
/// # use leptos_use::{use_scroll_with_options, UseScrollReturn, UseScrollOptions, ScrollOffset};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// # let element = create_node_ref::<Div>();
/// #
/// let UseScrollReturn {
/// x,
/// y,
/// set_x,
/// set_y,
/// is_scrolling,
/// arrived_state,
/// directions,
/// ..
/// } = use_scroll_with_options(
/// element,
/// UseScrollOptions::default().offset(ScrollOffset {
/// top: 30.0,
/// bottom: 30.0,
/// right: 30.0,
/// left: 30.0,
/// }),
/// );
/// #
/// # view! { /// # <div node_ref=element>"..."</div>
/// # }
/// # }
/// ```
///
/// ### Setting Scroll Position
///
/// Set the `x` and `y` values to make the element scroll to that position.
///
/// ```
/// # use leptos::*;
/// # use leptos::html::Div;
/// # use leptos::ev::resize;
/// # use leptos_use::{use_scroll, UseScrollReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let element = create_node_ref::<Div>();
///
/// let UseScrollReturn {
/// x, y, set_x, set_y, ..
/// } = use_scroll(element);
///
/// view! {
/// <div node_ref=element>"..."</div>
/// <button on:click=move |_| set_x(x.get_untracked() + 10.0)>"Scroll right 10px"</button>
/// <button on:click=move |_| set_y(y.get_untracked() + 10.0)>"Scroll down 10px"</button>
/// }
/// # }
/// ```
///
/// ### Smooth Scrolling
///
/// Set `behavior: smooth` to enable smooth scrolling. The `behavior` option defaults to `auto`,
/// which means no smooth scrolling. See the `behavior` option on
/// [Element.scrollTo](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollTo) for more information.
///
/// ```
/// # use leptos::*;
/// # use leptos::ev::resize;
/// # use leptos::html::Div;
/// # use leptos_use::{use_scroll_with_options, UseScrollReturn, UseScrollOptions, ScrollBehavior};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// # let element = create_node_ref::<Div>();
/// #
/// let UseScrollReturn {
/// x, y, set_x, set_y, ..
/// } = use_scroll_with_options(
/// element,
/// UseScrollOptions::default().behavior(ScrollBehavior::Smooth),
/// );
/// #
/// # view! { /// # <div node_ref=element>"..."</div>
/// # }
/// # }
/// ```
///
/// or as a `Signal`:
///
/// ```
/// # use leptos::*;
/// # use leptos::ev::resize;
/// # use leptos::html::Div;
/// # use leptos_use::{use_scroll_with_options, UseScrollReturn, UseScrollOptions, ScrollBehavior};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// # let element = create_node_ref::<Div>();
/// #
/// let (smooth, set_smooth) = create_signal(false);
///
/// let behavior = Signal::derive(move || {
/// if smooth.get() { ScrollBehavior::Smooth } else { ScrollBehavior::Auto }
/// });
///
/// let UseScrollReturn {
/// x, y, set_x, set_y, ..
/// } = use_scroll_with_options(
/// element,
/// UseScrollOptions::default().behavior(behavior),
/// );
/// #
/// # view! { /// # <div node_ref=element>"..."</div>
/// # }
/// # }
/// ```
///
/// ## Server-Side Rendering
///
/// On the server this returns signals that don't change and setters that are noops.
pub fn use_scroll<El, T>(
element: El,
) -> UseScrollReturn<impl Fn(f64) + Clone, impl Fn(f64) + Clone, impl Fn() + Clone>
where
El: Clone,
El: Into<ElementMaybeSignal<T, web_sys::Element>>,
T: Into<web_sys::Element> + Clone + 'static,
{
use_scroll_with_options(element, Default::default())
}
/// Version of [`use_scroll`] with options. See [`use_scroll`] for how to use.
#[cfg_attr(feature = "ssr", allow(unused_variables))]
pub fn use_scroll_with_options<El, T>(
element: El,
options: UseScrollOptions,
) -> UseScrollReturn<impl Fn(f64) + Clone, impl Fn(f64) + Clone, impl Fn() + Clone>
where
El: Clone,
El: Into<ElementMaybeSignal<T, web_sys::Element>>,
T: Into<web_sys::Element> + Clone + 'static,
{
let (internal_x, set_internal_x) = create_signal(0.0);
let (internal_y, set_internal_y) = create_signal(0.0);
let (is_scrolling, set_is_scrolling) = create_signal(false);
let arrived_state = create_rw_signal(Directions {
left: true,
right: false,
top: true,
bottom: false,
});
let directions = create_rw_signal(Directions {
left: false,
right: false,
top: false,
bottom: false,
});
cfg_if! { if #[cfg(feature = "ssr")] {
let set_x = |_| {};
let set_y = |_| {};
let measure = || {};
} else {
let signal = element.into();
let behavior = options.behavior;
let scroll_to = {
let signal = signal.clone();
move |x: Option<f64>, y: Option<f64>| {
let element = signal.get_untracked();
if let Some(element) = element {
let element = element.into();
let scroll_options = web_sys::ScrollToOptions::new();
scroll_options.set_behavior(behavior.get_untracked().into());
if let Some(x) = x {
scroll_options.set_left(x);
}
if let Some(y) = y {
scroll_options.set_top(y);
}
element.scroll_to_with_scroll_to_options(&scroll_options);
}
}
};
let set_x = {
let scroll_to = scroll_to.clone();
move |x| scroll_to(Some(x), None)
};
let set_y = move |y| scroll_to(None, Some(y));
let on_scroll_end = {
let on_stop = Rc::clone(&options.on_stop);
move |e| {
if !is_scrolling.try_get_untracked().unwrap_or_default() {
return;
}
set_is_scrolling.set(false);
directions.update(|directions| {
directions.left = false;
directions.right = false;
directions.top = false;
directions.bottom = false;
on_stop.clone()(e);
});
}
};
let throttle = options.throttle;
let on_scroll_end_debounced =
use_debounce_fn_with_arg(on_scroll_end.clone(), throttle + options.idle);
let offset = options.offset;
let set_arrived_state = move |target: web_sys::Element| {
let style = window()
.get_computed_style(&target)
.expect("failed to get computed style");
if let Some(style) = style {
let display = style
.get_property_value("display")
.expect("failed to get display");
let flex_direction = style
.get_property_value("flex-direction")
.expect("failed to get flex-direction");
let scroll_left = target.scroll_left() as f64;
let scroll_left_abs = scroll_left.abs();
directions.update(|directions| {
directions.left = scroll_left < internal_x.get_untracked();
directions.right = scroll_left > internal_x.get_untracked();
});
let left = scroll_left_abs <= offset.left;
let right = scroll_left_abs + target.client_width() as f64
>= target.scroll_width() as f64 - offset.right - ARRIVED_STATE_THRESHOLD_PIXELS;
arrived_state.update(|arrived_state| {
if display == "flex" && flex_direction == "row-reverse" {
arrived_state.left = right;
arrived_state.right = left;
} else {
arrived_state.left = left;
arrived_state.right = right;
}
});
set_internal_x.set(scroll_left);
let mut scroll_top = target.scroll_top() as f64;
// patch for mobile compatibility
if target == document().unchecked_into::<web_sys::Element>() && scroll_top == 0.0 {
scroll_top = document().body().expect("failed to get body").scroll_top() as f64;
}
let scroll_top_abs = scroll_top.abs();
directions.update(|directions| {
directions.top = scroll_top < internal_y.get_untracked();
directions.bottom = scroll_top > internal_y.get_untracked();
});
let top = scroll_top_abs <= offset.top;
let bottom = scroll_top_abs + target.client_height() as f64
>= target.scroll_height() as f64
- offset.bottom
- ARRIVED_STATE_THRESHOLD_PIXELS;
// reverse columns and rows behave exactly the other way around,
// bottom is treated as top and top is treated as the negative version of bottom
arrived_state.update(|arrived_state| {
if display == "flex" && flex_direction == "column-reverse" {
arrived_state.top = bottom;
arrived_state.bottom = top;
} else {
arrived_state.top = top;
arrived_state.bottom = bottom;
}
});
set_internal_y.set(scroll_top);
}
};
let on_scroll_handler = {
let on_scroll = Rc::clone(&options.on_scroll);
move |e: web_sys::Event| {
let target: web_sys::Element = event_target(&e);
set_arrived_state(target);
set_is_scrolling.set(true);
on_scroll_end_debounced.clone()(e.clone());
on_scroll.clone()(e);
}
};
let target = {
let signal = signal.clone();
Signal::derive(move || {
let element = signal.get();
element.map(|element| element.into().unchecked_into::<web_sys::EventTarget>())
})
};
if throttle >= 0.0 {
let throttled_scroll_handler = use_throttle_fn_with_arg_and_options(
on_scroll_handler.clone(),
throttle,
ThrottleOptions {
trailing: true,
leading: false,
},
);
let handler = move |e: web_sys::Event| {
throttled_scroll_handler.clone()(e);
};
let _ = use_event_listener_with_options::<
_,
Signal<Option<web_sys::EventTarget>>,
web_sys::EventTarget,
_,
>(target, ev::scroll, handler, options.event_listener_options);
} else {
let _ = use_event_listener_with_options::<
_,
Signal<Option<web_sys::EventTarget>>,
web_sys::EventTarget,
_,
>(
target,
ev::scroll,
on_scroll_handler,
options.event_listener_options,
);
}
let _ = use_event_listener_with_options::<
_,
Signal<Option<web_sys::EventTarget>>,
web_sys::EventTarget,
_,
>(
target,
scrollend,
on_scroll_end,
options.event_listener_options,
);
let measure = move || {
if let Some(el) = signal.try_get_untracked().flatten() {
let el = el.into();
set_arrived_state(el);
}
};
}}
UseScrollReturn {
x: internal_x.into(),
set_x,
y: internal_y.into(),
set_y,
is_scrolling: is_scrolling.into(),
arrived_state: arrived_state.into(),
directions: directions.into(),
measure,
}
}
/// Options for [`use_scroll`].
#[derive(DefaultBuilder)]
/// Options for [`use_scroll_with_options`].
#[cfg_attr(feature = "ssr", allow(dead_code))]
pub struct UseScrollOptions {
/// Throttle time in milliseconds for the scroll events. Defaults to 0 (disabled).
throttle: f64,
/// After scrolling ends we wait idle + throttle milliseconds before we consider scrolling to have stopped.
/// Defaults to 200.
idle: f64,
/// Threshold in pixels when we consider a side to have arrived (`UseScrollReturn::arrived_state`).
offset: ScrollOffset,
/// Callback when scrolling is happening.
on_scroll: Rc<dyn Fn(web_sys::Event)>,
/// Callback when scrolling stops (after `idle` + `throttle` milliseconds have passed).
on_stop: Rc<dyn Fn(web_sys::Event)>,
/// Options passed to the `addEventListener("scroll", ...)` call
event_listener_options: UseEventListenerOptions,
/// When changing the `x` or `y` signals this specifies the scroll behaviour.
/// Can be `Auto` (= not smooth) or `Smooth`. Defaults to `Auto`.
#[builder(into)]
behavior: MaybeSignal<ScrollBehavior>,
}
impl Default for UseScrollOptions {
fn default() -> Self {
Self {
throttle: 0.0,
idle: 200.0,
offset: ScrollOffset::default(),
on_scroll: Rc::new(|_| {}),
on_stop: Rc::new(|_| {}),
event_listener_options: Default::default(),
behavior: Default::default(),
}
}
}
/// The scroll behavior.
/// Can be `Auto` (= not smooth) or `Smooth`. Defaults to `Auto`.
#[derive(Default, Copy, Clone)]
pub enum ScrollBehavior {
#[default]
Auto,
Smooth,
}
impl From<ScrollBehavior> for web_sys::ScrollBehavior {
fn from(val: ScrollBehavior) -> Self {
match val {
ScrollBehavior::Auto => web_sys::ScrollBehavior::Auto,
ScrollBehavior::Smooth => web_sys::ScrollBehavior::Smooth,
}
}
}
/// The return value of [`use_scroll`].
pub struct UseScrollReturn<SetXFn, SetYFn, MFn>
where
SetXFn: Fn(f64) + Clone,
SetYFn: Fn(f64) + Clone,
MFn: Fn() + Clone,
{
/// X coordinate of scroll position
pub x: Signal<f64>,
/// Sets the value of `x`. This does also scroll the element.
pub set_x: SetXFn,
/// Y coordinate of scroll position
pub y: Signal<f64>,
/// Sets the value of `y`. This does also scroll the element.
pub set_y: SetYFn,
/// Is true while the element is being scrolled.
pub is_scrolling: Signal<bool>,
/// Sets the field that represents a direction to true if the
/// element is scrolled all the way to that side.
pub arrived_state: Signal<Directions>,
/// The directions in which the element is being scrolled are set to true.
pub directions: Signal<Directions>,
/// Re-evaluates the `arrived_state`.
pub measure: MFn,
}
#[derive(Default, Copy, Clone, Debug)]
/// Threshold in pixels when we consider a side to have arrived (`UseScrollReturn::arrived_state`).
pub struct ScrollOffset {
pub left: f64,
pub top: f64,
pub right: f64,
pub bottom: f64,
}
impl ScrollOffset {
/// Sets the value of the provided direction
pub fn set_direction(mut self, direction: Direction, value: f64) -> Self {
match direction {
Direction::Top => self.top = value,
Direction::Bottom => self.bottom = value,
Direction::Left => self.left = value,
Direction::Right => self.right = value,
}
self
}
}