Struct UseDraggableOptions

pub struct UseDraggableOptions<DragEl, DragM, HandleEl, HandleM>
where
    DragEl: IntoElementMaybeSignal<EventTarget, DragM>,
    HandleEl: IntoElementMaybeSignal<EventTarget, HandleM>,
{ /* private fields */ }

Options for use_draggable_with_options.

Implementations

impl<DragEl, DragM, HandleEl, HandleM> UseDraggableOptions<DragEl, DragM, HandleEl, HandleM>

where DragEl: IntoElementMaybeSignal<EventTarget, DragM>, HandleEl: IntoElementMaybeSignal<EventTarget, HandleM>,

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

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

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

Prevent events defaults. Defaults to false.

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

Prevent events propagation. Defaults to false.

pub fn dragging_element<New__DragEl, New__DragM>( self, value: New__DragEl, ) -> UseDraggableOptions<New__DragEl, New__DragM, HandleEl, HandleM>

where New__DragEl: IntoElementMaybeSignal<EventTarget, New__DragM>, HandleEl: IntoElementMaybeSignal<EventTarget, HandleM>,

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

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

where DragEl: IntoElementMaybeSignal<EventTarget, DragM>, New__HandleEl: IntoElementMaybeSignal<EventTarget, New__HandleM>,

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 + Send + Sync + 'static, ) -> Self

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

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

Callback during dragging.

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

Callback when dragging end.

Trait Implementations

impl<DragM, HandleM> Default for UseDraggableOptions<UseWindow, DragM, Option<EventTarget>, HandleM>

where UseWindow: IntoElementMaybeSignal<EventTarget, DragM>, Option<EventTarget>: IntoElementMaybeSignal<EventTarget, HandleM>,

fn default() -> Self

Returns the “default value” for a type.