Struct UseDraggableOptions

pub struct UseDraggableOptions<DragEl, DragT, HandleEl, HandleT>
where
    DragEl: Into<ElementMaybeSignal<DragT, EventTarget>>,
    DragT: Into<EventTarget> + Clone + 'static,
    HandleEl: Into<ElementMaybeSignal<HandleT, EventTarget>>,
    HandleT: Into<EventTarget> + Clone + 'static,
{ /* private fields */ }

Options for use_draggable_with_options.

Implementations

impl<DragEl, DragT, HandleEl, HandleT> UseDraggableOptions<DragEl, DragT, HandleEl, HandleT>

where DragEl: Into<ElementMaybeSignal<DragT, EventTarget>>, DragT: Into<EventTarget> + Clone + 'static, HandleEl: Into<ElementMaybeSignal<HandleT, EventTarget>>, HandleT: Into<EventTarget> + Clone + 'static,

pub fn exact(self, value: impl Into<MaybeSignal<bool>>) -> Self

Only start the dragging when click on the element directly. Defaults to false.

pub fn prevent_default(self, value: impl Into<MaybeSignal<bool>>) -> Self

Prevent events defaults. Defaults to false.

pub fn stop_propagation(self, value: impl Into<MaybeSignal<bool>>) -> Self

Prevent events propagation. Defaults to false.

pub fn dragging_element<New__DragEl, New__DragT>( self, value: New__DragEl, ) -> UseDraggableOptions<New__DragEl, New__DragT, HandleEl, HandleT>

where New__DragEl: Into<ElementMaybeSignal<New__DragT, EventTarget>>, New__DragT: Into<EventTarget> + Clone + 'static, HandleEl: Into<ElementMaybeSignal<HandleT, EventTarget>>, HandleT: Into<EventTarget> + Clone + 'static,

Element to attach pointermove and pointerup events to. Defaults to window.

pub fn handle<New__HandleEl, New__HandleT>( self, value: Option<New__HandleEl>, ) -> UseDraggableOptions<DragEl, DragT, New__HandleEl, New__HandleT>

where DragEl: Into<ElementMaybeSignal<DragT, EventTarget>>, DragT: Into<EventTarget> + Clone + 'static, New__HandleEl: Into<ElementMaybeSignal<New__HandleT, EventTarget>>, New__HandleT: Into<EventTarget> + Clone + 'static,

Handle that triggers the drag event. Defaults to target.

pub fn pointer_types(self, value: Vec<PointerType>) -> Self

Pointer types that listen to. Defaults to [Mouse, Touch, Pen].

pub fn initial_value(self, value: impl Into<MaybeRwSignal<Position>>) -> Self

Initial position of the element. Defaults to { x: 0, y: 0 }.

pub fn on_start( self, value: impl Fn(UseDraggableCallbackArgs) -> bool + 'static, ) -> Self

Callback when the dragging starts. Return false to prevent dragging.

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

Callback during dragging.

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

Callback when dragging end.

Trait Implementations

impl Default for UseDraggableOptions<UseWindow, Window, EventTarget, EventTarget>

fn default() -> Self

Returns the “default value” for a type.