Skip to main content

DndContext

dioxus_dnd_kit::prelude

Struct DndContext

pub struct DndContext<T: DndItem> {
    pub render: Callback<T, Element>,
    pub placeholder_render: Option<Callback<(f64, f64), Element>>,
    pub active: Signal<Option<T>>,
    pub active_rect: Signal<Option<PixelsRect>>,
    pub active_mounted: Signal<Option<Rc<MountedData>>>,
    pub is_floating_ready: Signal<bool>,
    pub mouse_pos: Signal<ClientPoint>,
    pub start_pos: Signal<ClientPoint>,
    pub grab_offset: Signal<OffsetOptions>,
    pub key_gen: Callback<T, String>,
    pub recalculate_rects: Signal<u64>,
}

Expand description

State management for a Drag-and-Drop session.

Fields§

§render: Callback<T, Element>

How to render the item in the list and overlay.

§placeholder_render: Option<Callback<(f64, f64), Element>>

Optional placeholder renderer used when an item is lifted.

§active: Signal<Option<T>>

Current active (dragged) item data.

§active_rect: Signal<Option<PixelsRect>>

Rect of the active item before it was lifted.

§active_mounted: Signal<Option<Rc<MountedData>>>

Internal: Reference to the mounted data of the active element.

§is_floating_ready: Signal<bool>

Flag indicating that the floating overlay is ready for display.

§mouse_pos: Signal<ClientPoint>

Current mouse coordinates relative to the viewport.

§start_pos: Signal<ClientPoint>

Mouse coordinates at the start of the drag operation.

§grab_offset: Signal<OffsetOptions>

Distance between the grab point and the element’s top-left corner.

§key_gen: Callback<T, String>

Key generator for DOM stability.

§recalculate_rects: Signal<u64>

Global trigger to force recalculation of element rectangles.

Trait Implementations§

impl<T: Clone + DndItem> Clone for DndContext<T>

fn clone(&self) -> DndContext<T>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug + DndItem> Debug for DndContext<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<T: PartialEq + DndItem> PartialEq for DndContext<T>

fn eq(&self, other: &DndContext<T>) -> bool

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

1.0.0 (const: unstable) · Source§

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: Copy + DndItem> Copy for DndContext<T>

impl<T: DndItem> StructuralPartialEq for DndContext<T>

Auto Trait Implementations§

impl<T> Freeze for DndContext<T>

impl<T> !RefUnwindSafe for DndContext<T>

impl<T> !Send for DndContext<T>

impl<T> !Sync for DndContext<T>

impl<T> Unpin for DndContext<T>
where T: Unpin,

impl<T> UnsafeUnpin for DndContext<T>

impl<T> !UnwindSafe for DndContext<T>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> InitializeFromFunction<T> for T

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<Ret> SpawnIfAsync<(), Ret> for Ret

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block

impl<T, O> SuperFrom<T> for O
where O: From<T>,

fn super_from(input: T) -> O

Convert from a type to another type.

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

fn super_into(self) -> O

Convert from a type to another type.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,

impl<T> DndItem for T
where T: PartialEq + Clone + 'static,