Struct UseScrollOptions

pub struct UseScrollOptions { /* private fields */ }

Options for use_scroll. Options for use_scroll_with_options.

Implementations

impl UseScrollOptions

pub fn throttle(self, value: f64) -> Self

Throttle time in milliseconds for the scroll events. Defaults to 0 (disabled).

pub fn idle(self, value: f64) -> Self

After scrolling ends we wait idle + throttle milliseconds before we consider scrolling to have stopped. Defaults to 200.

pub fn offset(self, value: ScrollOffset) -> Self

Threshold in pixels when we consider a side to have arrived (UseScrollReturn::arrived_state).

pub fn on_scroll(self, value: impl Fn(Event) + 'static) -> Self

Callback when scrolling is happening.

pub fn on_stop(self, value: impl Fn(Event) + 'static) -> Self

Callback when scrolling stops (after idle + throttle milliseconds have passed).

pub fn event_listener_options(self, value: UseEventListenerOptions) -> Self

Options passed to the addEventListener("scroll", ...) call

pub fn behavior(self, value: impl Into<MaybeSignal<ScrollBehavior>>) -> Self

When changing the x or y signals this specifies the scroll behaviour. Can be Auto (= not smooth) or Smooth. Defaults to Auto.

Trait Implementations

impl Default for UseScrollOptions

fn default() -> Self

Returns the “default value” for a type.