Struct leptos_use::UseMouseInElementOptions

pub struct UseMouseInElementOptions<El, T, Ex>
where
    El: Clone + Into<ElementMaybeSignal<T, EventTarget>>,
    T: Into<EventTarget> + Clone + 'static,
    Ex: UseMouseEventExtractor + Clone,
{ /* private fields */ }

Options for use_mouse_in_element_with_options.

Implementations

impl<El, T, Ex> UseMouseInElementOptions<El, T, Ex>

where El: Clone + Into<ElementMaybeSignal<T, EventTarget>>, T: Into<EventTarget> + Clone + 'static, Ex: UseMouseEventExtractor + Clone,

pub fn coord_type<New__Ex>( self, value: UseMouseCoordType<New__Ex> ) -> UseMouseInElementOptions<El, T, New__Ex>

where El: Clone + Into<ElementMaybeSignal<T, EventTarget>>, T: Into<EventTarget> + Clone + 'static, New__Ex: UseMouseEventExtractor + Clone,

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

pub fn target<New__El, New__T>( self, value: New__El ) -> UseMouseInElementOptions<New__El, New__T, Ex>

where New__El: Clone + Into<ElementMaybeSignal<New__T, EventTarget>>, New__T: Into<EventTarget> + Clone + 'static, Ex: UseMouseEventExtractor + Clone,

Listen events on target element. Defaults to window

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

Listen to touchmove events. Defaults to true.

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

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

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

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

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

If true updates the element_x and element_y signals even if the mouse is outside of the element. If false it doesn’t update them when outside. Defaults to true.

Trait Implementations

impl Default for UseMouseInElementOptions<UseWindow, Window, UseMouseEventExtractorDefault>

fn default() -> Self

Returns the “default value” for a type.