Struct DraggableProps 

pub struct DraggableProps<T: Clone + PartialEq + 'static> {
    pub payload: T,
    pub zone: Option<ZoneId>,
    pub effect: DropEffect,
    pub disabled: bool,
    pub threshold: f64,
    pub label: Option<String>,
    pub on_drag_start: Option<EventHandler<()>>,
    pub on_drag_end: Option<EventHandler<bool>>,
    pub attributes: Vec<Attribute>,
    pub children: Element,
}

Properties for the Draggable component.

Fields

payload: T

The value delivered to whichever DropZone receives this drag.

zone: Option<ZoneId>

The zone this item currently lives in (reported in DropOutcome::from).

effect: DropEffect

Drop effect. Defaults to Move.

disabled: bool

Disable dragging without unmounting.

threshold: f64

Movement in CSS px before a pointer press becomes a drag.

label: Option<String>

Human label used in screen-reader announcements (“Picked up {label}”).

on_drag_start: Option<EventHandler<()>>

Fired when a drag begins.

on_drag_end: Option<EventHandler<bool>>

Fired when the drag ends; true if a zone consumed the payload, false if it was cancelled.

attributes: Vec<Attribute>

children: Element

Implementations

impl<T: Clone + PartialEq + 'static> DraggableProps<T>

pub fn builder() -> DraggablePropsBuilder<((), (), (), (), (), (), (), (), (), ()), T>

Create a builder for building DraggableProps. On the builder, call .payload(...), .zone(...)(optional), .effect(...)(optional), .disabled(...)(optional), .threshold(...)(optional), .label(...)(optional), .on_drag_start(...)(optional), .on_drag_end(...)(optional), .attributes(...)(optional), .children(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of DraggableProps.

Trait Implementations

impl<T: Clone + PartialEq + 'static> Clone for DraggableProps<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Clone + PartialEq + 'static> PartialEq for DraggableProps<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Clone + PartialEq + 'static> Properties for DraggableProps<T>

where Self: Clone,

type Builder = DraggablePropsBuilder<((), (), (), (), (), (), (), (), (), ()), T>

The type of the builder for this component. Used to create “in-progress” versions of the props.

fn builder() -> Self::Builder

Create a builder for this component.

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent

where M: 'static,

Create a component from the props.