Struct dragula::Drake

#[repr(transparent)]pub struct Drake { /* fields omitted */ }

Interface provided by Dragula to interact with active drag-and-drop system

Example:

 use dragula::*;

 let doc = web_sys::window().unwrap().document().unwrap();
 let element_1 = doc.get_element_by_id("drag-container-1").unwrap();
 let element_2 = doc.get_element_by_id("drag-container-2").unwrap();

 let mut drake = dragula(&[element_1]);

 drake.add_container(element_2);

Implementations

impl Drake

pub fn dragging(&self) -> bool

This property will be true whenever an element is being dragged.

impl Drake

pub fn end(&self)

Gracefully end the drag event as if using the last position marked by the preview shadow as the drop target. The proper cancel or drop event will be fired, depending on whether the item was dropped back where it was originally lifted from (which is essentially a no-op that's treated as a cancel event).

impl Drake

pub fn remove(&self)

If an element managed by Drake is currently being dragged, this method will gracefully remove it from the DOM.

impl Drake

pub fn destroy(&self)

Removes all drag and drop events used by dragula to manage drag and drop between the containers. If destroy is called while an element is being dragged, the drag will be effectively cancelled.

impl Drake

pub fn cancel(&self)

If an element managed by Drake is currently being dragged, this method will gracefully cancel the drag action.

Note that a "cancellation" will result in a cancel event only in the following scenarios.

• revert_on_spill is true
• Drop target (as previewed by the feedback shadow) is the source container and the item is dropped in the same position where it was originally dragged from

impl Drake

pub fn cancel_with_revert(&self, revert: bool)

If an element managed by Drake is currently being dragged, this method will gracefully cancel the drag action. If true is passed to this function, it will effectively produce the same result as if revert_on_spill is true.

• revert_on_spill is true
• Drop target (as previewed by the feedback shadow) is the source container and the item is dropped in the same position where it was originally dragged from

impl Drake

pub fn containers(&self) -> Vec<JsValue>

Gets the active containers currently allowing dragging

Requires that feature js-sys be turned on (it is on by default)

pub fn set_containers<T>(&mut self, objs: &[T]) where
    T: JsCast + Clone, 

Sets the list of active containers for dragging. This overrides the list that is currently there.

pub fn add_container<T>(&mut self, obj: T) where
    T: JsCast, 

Adds to the list of active containers for dragging

Requires that feature js-sys be turned on (it is on by default)

pub fn start<T>(&mut self, item: &T) where
    T: JsCast, 

Enter drag mode without a shadow. This function is most useful when providing complementary keyboard shortcuts to an existing drag and drop solution. Even though a shadow won't be created at first, the user will get one as soon as they click on item and start dragging it around. Note that if they click and drag something else, end will be called before picking up the new item.

pub fn can_move<T>(&self, item: &T) -> bool where
    T: JsCast, 

Returns whether the Drake instance can accept drags for a DOM element item. This function returns true when all the conditions outlined below are met, and false otherwise.

• item is a child of one of the specified containers for Drake
• item passes the pertinent invalid checks
• item passes a moves check

pub fn on_drag<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue, JsValue), 

Sets callback for drag event. Callback will be passed arguments (el, source) The drag event implies that el was lifted from source.

pub fn on_dragend<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue), 

Sets callback for dragend event. Callback will be passed argument (el) The dragend event implies that dragging event for el ended with either cancel, remove, or drop.

pub fn on_drop<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue, JsValue, JsValue, JsValue), 

Sets callback for drop event. Callback will be passed arguments (el, target, source, sibling) The drop event implies that el was dropped into target before a sibling element, and originally came from source.

pub fn on_cancel<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue, JsValue, JsValue), 

Sets callback for cancel event. Callback will be passed argument (el, container, source) The cancel event implies that el was being dragged but it got nowhere and went back into container, its last stable parent; el originally came from source.

pub fn on_remove<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue, JsValue, JsValue), 

Sets callback for remove event. Callback will be passed argument (el, container, source) The remove event implies that el was being dragged but it got nowhere and it was removed from the DOM. Its last stable parent was container, and originally came from source.

pub fn on_shadow<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue, JsValue, JsValue), 

Sets callback for shadow event. Callback will be passed argument (el, container, source) The shadow event implies that el, the visual aid shadow, was moved into container. May trigger many times as the position of el changes, even within the same container; el originally came from source.

pub fn on_over<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue, JsValue, JsValue), 

Sets callback for over event. Callback will be passed argument (el, container, source) The over event implies that el is over container, and originally came from source.

pub fn on_out<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue, JsValue, JsValue), 

Sets callback for out event. Callback will be passed argument (el, container, source) The out event implies that el was dragged out of container or dropped, and originally came from source.

pub fn on_cloned<F: 'static>(&mut self, listener: F) where
    F: FnMut(JsValue, JsValue, JsValue), 

Sets callback for cloned event. Callback will be passed argument (clone, original, type) The cloned event implies that DOM element original was cloned as clone, of type ('mirror' or 'copy'). Fired for mirror images and when copy: true.

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it's an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it's not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it's an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool

Tests whether the value is "truthy".

pub fn is_falsy(&self) -> bool

Tests whether the value is "falsy".

Trait Implementations

impl AsRef<Drake> for Drake

pub fn as_ref(&self) -> &Drake

Performs the conversion.

impl AsRef<JsValue> for Drake

pub fn as_ref(&self) -> &JsValue

Performs the conversion.

impl Deref for Drake

type Target = JsValue

The resulting type after dereferencing.

pub fn deref(&self) -> &JsValue

Dereferences the value.

impl From<Drake> for JsValue

pub fn from(obj: Drake) -> JsValue

Performs the conversion.

impl From<JsValue> for Drake

pub fn from(obj: JsValue) -> Drake

Performs the conversion.

impl FromWasmAbi for Drake

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

pub unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Drake

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

pub fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<'a> IntoWasmAbi for &'a Drake

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

pub fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Drake

pub fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

pub fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

pub fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

pub fn has_type<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value has a type T.

pub fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

pub fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

pub fn unchecked_into<T>(self) -> T where
    T: JsCast, 

Performs a zero-cost unchecked cast into the specified type.

pub fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

Performs a zero-cost unchecked cast into a reference to the specified type.

pub fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the type T.

pub fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl OptionFromWasmAbi for Drake

pub fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Drake

pub fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl<'a> OptionIntoWasmAbi for &'a Drake

pub fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Drake

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Drake>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

pub unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for Drake

pub fn describe()