Struct leptos_use::UseScrollReturn

source · 
pub struct UseScrollReturn<SetXFn, SetYFn, MFn>
where
    SetXFn: Fn(f64) + Clone,
    SetYFn: Fn(f64) + Clone,
    MFn: Fn() + Clone,
{
    pub x: Signal<f64>,
    pub set_x: SetXFn,
    pub y: Signal<f64>,
    pub set_y: SetYFn,
    pub is_scrolling: Signal<bool>,
    pub arrived_state: Signal<Directions>,
    pub directions: Signal<Directions>,
    pub measure: MFn,
}
Expand description

The return value of use_scroll.

Fields§

§x: Signal<f64>

X coordinate of scroll position

§set_x: SetXFn

Sets the value of x. This does also scroll the element.

§y: Signal<f64>

Y coordinate of scroll position

§set_y: SetYFn

Sets the value of y. This does also scroll the element.

§is_scrolling: Signal<bool>

Is true while the element is being scrolled.

§arrived_state: Signal<Directions>

Sets the field that represents a direction to true if the element is scrolled all the way to that side.

§directions: Signal<Directions>

The directions in which the element is being scrolled are set to true.

§measure: MFn

Re-evaluates the arrived_state.

Auto Trait Implementations§

§

impl<SetXFn, SetYFn, MFn> Freeze for UseScrollReturn<SetXFn, SetYFn, MFn>
where SetXFn: Freeze, SetYFn: Freeze, MFn: Freeze,

§

impl<SetXFn, SetYFn, MFn> !RefUnwindSafe for UseScrollReturn<SetXFn, SetYFn, MFn>

§

impl<SetXFn, SetYFn, MFn> !Send for UseScrollReturn<SetXFn, SetYFn, MFn>

§

impl<SetXFn, SetYFn, MFn> !Sync for UseScrollReturn<SetXFn, SetYFn, MFn>

§

impl<SetXFn, SetYFn, MFn> Unpin for UseScrollReturn<SetXFn, SetYFn, MFn>
where SetXFn: Unpin, SetYFn: Unpin, MFn: Unpin,

§

impl<SetXFn, SetYFn, MFn> !UnwindSafe for UseScrollReturn<SetXFn, SetYFn, MFn>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more