Struct DndContext 

pub struct DndContext<T: Clone + 'static> { /* private fields */ }

Handle to the shared drag state. Cheap to copy - it’s just a store key.

Implementations

impl<T: Clone + 'static> DndContext<T>

pub fn from_parts( state: Store<DragState<T>>, announcement: Signal<String>, ) -> Self

Wrap existing state. Prefer crate::core::hooks::use_dnd_provider.

pub fn start( &mut self, payload: T, source: Option<ZoneId>, pointer: Point, grab: Point, effect: DropEffect, mode: DragMode, )

Begin a drag. Notifies all fields (state transition).

pub fn update_pointer(&mut self, pointer: Point)

Update the tracked pointer position (drives DragOverlay). Granular: only pointer subscribers rerun.

pub fn enter(&mut self, zone: ZoneId)

Mark zone as hovered. Granular: only over subscribers rerun.

pub fn leave(&mut self, zone: ZoneId)

Clear hover, but only if zone is still the hovered one (avoids enter/leave races between adjacent zones).

pub fn take(&mut self) -> Option<(T, Option<ZoneId>)>

Consume the payload on a successful drop. Returns (payload, source). After this, dragging() is false.

pub fn cancel(&mut self)

Abort the drag and reset all state.

pub fn dragging(&self) -> bool

Is a drag currently in flight?

pub fn payload(&self) -> Option<T>

Clone of the current payload, if dragging.

pub fn over(&self) -> Option<ZoneId>

Zone currently hovered.

pub fn source(&self) -> Option<ZoneId>

Zone the drag started from.

pub fn pointer(&self) -> Point

Last known pointer position.

pub fn grab(&self) -> Point

Grab offset inside the dragged element.

pub fn effect(&self) -> DropEffect

Effect the drag was started with.

pub fn mode(&self) -> DragMode

How the current drag is being driven.

pub fn announce(&mut self, msg: impl Into<String>)

Push a screen-reader announcement (rendered by crate::a11y::LiveRegion). Called automatically by the built-in keyboard interaction; call it yourself for custom flows.

pub fn announcement(&self) -> String

The current announcement text.

Trait Implementations

impl<T: Clone + 'static> Clone for DndContext<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 + 'static> Copy for DndContext<T>

impl<T: Clone + 'static> PartialEq for DndContext<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.