Struct UseScroll 

pub struct UseScroll {
    pub x: Signal<f64>,
    pub y: Signal<f64>,
    /* private fields */
}

Reactive state for the window’s scroll position.

The handle carries the horizontal and vertical scroll offsets and the teardown that removes the window listener.

The offsets are Signal<f64>: a render closure that reads them re-renders when the page scrolls.

Fields

x: Signal<f64>

The horizontal scroll offset in CSS pixels.

y: Signal<f64>

The vertical scroll offset in CSS pixels.

Implementations

impl UseScroll

Inherent implementation of UseScroll.

pub fn current_y(&self) -> f64

Returns the vertical offset as a snapshot.

Returns

• f64 - The vertical scroll offset in CSS pixels.

pub fn current_x(&self) -> f64

Returns the horizontal offset as a snapshot.

Returns

• f64 - The horizontal scroll offset in CSS pixels.

pub fn scroll_to_top(&self)

Scrolls the page back to the top.

The scroll is smooth when the browser supports it, so the reader sees the page travel rather than jump.

On a host without a browser this is a no-op.

impl UseScroll

pub fn get_x(&self) -> Signal<f64>

pub fn get_mut_x(&mut self) -> &mut Signal<f64>

pub fn set_x(&mut self, val: Signal<f64>) -> &mut Self

pub fn get_y(&self) -> Signal<f64>

pub fn get_mut_y(&mut self) -> &mut Signal<f64>

pub fn set_y(&mut self, val: Signal<f64>) -> &mut Self

pub fn get_mut_teardown(&mut self) -> &mut Rc<RefCell<Option<Box<dyn Fn()>>>>

pub fn set_teardown( &mut self, val: Rc<RefCell<Option<Box<dyn Fn()>>>>, ) -> &mut Self

Trait Implementations

impl Clone for UseScroll

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UseScroll

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the struct fields as a debug struct, skipping excluded fields.

Arguments

• &mut std::fmt::Formatter<'_> - The formatter to write the representation into.

Returns

• std::fmt::Result - Success or failure of the formatting operation.