Struct ScrollableContext 

pub struct ScrollableContext {
    pub scrollable_ref: Signal<Option<Rc<MountedData>>>,
    pub scroll_state: Signal<Option<ScrollState>>,
}

Context provided by the ScrollableView component.

It contains reactive signals for the scroll state and a reference to the underlying DOM element, along with methods to programmatically control scrolling.

Fields

scrollable_ref: Signal<Option<Rc<MountedData>>>

A reactive signal containing the MountedData of the scrollable container.

scroll_state: Signal<Option<ScrollState>>

A reactive signal containing the current ScrollState (dimensions, offset, etc.).

Implementations

impl ScrollableContext

pub async fn reload(&mut self)

Forces a re-calculation of the scroll content size and current offset. Useful when the content inside changes but the container’s outer bounds remain the same.

pub async fn scroll( &self, coordinates: PixelsVector2D, behavior: ScrollBehavior, )

Programmatically scrolls the container by a given offset.

Example

use dioxus::prelude::*;
use dioxus::html::geometry::PixelsVector2D;
use dioxus_floating::use_scroll_context;

#[component]
fn MyComponent() -> Element {
    let ctx = use_scroll_context();
    use_effect(move || {
        spawn(async move {
            ctx.scroll(PixelsVector2D::new(0.0, 100.0), ScrollBehavior::Smooth).await;
        });
    });
    rsx! {}
}

pub async fn scroll_to(&self, behavior: ScrollBehavior)

Scrolls to a specific position (e.g., top or bottom) based on the behavior.

pub async fn scroll_to_with_options(&self, options: ScrollToOptions)

Scrolls the container using advanced options (like specific element alignment).

Trait Implementations

impl Clone for ScrollableContext

fn clone(&self) -> ScrollableContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollableContext

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

Formats the value using the given formatter.

impl Copy for ScrollableContext