leptos_use

Struct UseMouseOptions

Source 
pub struct UseMouseOptions<El, M, Ex>
where
    El: IntoElementMaybeSignal<EventTarget, M>,
    Ex: UseMouseEventExtractor + Clone,
{ /* private fields */ }
Expand description

Options for use_mouse_with_options.

Implementations§

Source§

impl<El, M, Ex> UseMouseOptions<El, M, Ex>
where El: IntoElementMaybeSignal<EventTarget, M>, Ex: UseMouseEventExtractor + Clone,

Source

pub fn coord_type<New__Ex>( self, value: UseMouseCoordType<New__Ex>, ) -> UseMouseOptions<El, M, New__Ex>
where El: IntoElementMaybeSignal<EventTarget, M>, New__Ex: UseMouseEventExtractor + Clone,

How to extract the x, y coordinates from mouse events or touches

Source

pub fn target<New__El, New__M>( self, value: New__El, ) -> UseMouseOptions<New__El, New__M, Ex>
where New__El: IntoElementMaybeSignal<EventTarget, New__M>, Ex: UseMouseEventExtractor + Clone,

Listen events on target element. Defaults to window

Source

pub fn touch(self, value: bool) -> Self

Listen to touchmove events. Defaults to true.

Source

pub fn reset_on_touch_ends(self, value: bool) -> Self

Reset to initial value when touchend event fired. Defaults to false

Source

pub fn initial_value(self, value: Position) -> Self

Initial values. Defaults to {x: 0.0, y: 0.0}.

Trait Implementations§

Source§

impl<M> Default for UseMouseOptions<UseWindow, M, Infallible>
where UseWindow: IntoElementMaybeSignal<EventTarget, M>,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<El, M, Ex> Freeze for UseMouseOptions<El, M, Ex>
where El: Freeze, Ex: Freeze,

§

impl<El, M, Ex> RefUnwindSafe for UseMouseOptions<El, M, Ex>
where El: RefUnwindSafe, Ex: RefUnwindSafe, M: RefUnwindSafe,

§

impl<El, M, Ex> Send for UseMouseOptions<El, M, Ex>
where El: Send, Ex: Send, M: Send,

§

impl<El, M, Ex> Sync for UseMouseOptions<El, M, Ex>
where El: Sync, Ex: Sync, M: Sync,

§

impl<El, M, Ex> Unpin for UseMouseOptions<El, M, Ex>
where El: Unpin, Ex: Unpin, M: Unpin,

§

impl<El, M, Ex> UnwindSafe for UseMouseOptions<El, M, Ex>
where El: UnwindSafe, Ex: UnwindSafe, M: UnwindSafe,

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, 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<El, T, Marker> IntoElementMaybeSignal<T, Marker> for El
where El: IntoElementMaybeSignalType<T, Marker>, Marker: ?Sized,

Source§

fn into_element_maybe_signal(self) -> ElementMaybeSignal<T>

Source§

impl<T, Js> IntoElementMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

fn into_element_maybe_signal_type(self) -> ElementMaybeSignalType<T>

Source§

impl<El, T, Marker> IntoElementsMaybeSignal<T, Marker> for El
where El: IntoElementsMaybeSignalType<T, Marker>, Marker: ?Sized,

Source§

fn into_elements_maybe_signal(self) -> ElementsMaybeSignal<T>

Source§

impl<T, Js> IntoElementsMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

fn into_elements_maybe_signal_type(self) -> ElementsMaybeSignalType<T>

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

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

Source§

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>,

Source§

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T