Skip to content

Interface: DndService

Defined in: packages/sdk/src/dnd-service.ts:137

The drag-and-drop domain, exposed as ExtensionContext.dnd. Be a drag source with DndService.beginDrag and a drop target with DndService.registerDropTarget; payloads are typed via DND_MIME.

Methods

beginDrag()

ts
beginDrag(event, init): void;

Defined in: packages/sdk/src/dnd-service.ts:144

Begin a drag from inside a dragstart handler: writes the typed DragInit.items onto the native dataTransfer, hides the native drag preview, and starts the floating chip + paste-mode overlay affordance. Must be called synchronously within the dragstart event.

Parameters

event

DragEvent | DragEvent<Element>

init

DragInit

Returns

void


registerDropTarget()

ts
registerDropTarget(el, handlers): Disposable;

Defined in: packages/sdk/src/dnd-service.ts:150

Register el as a drop target. The host attaches the drag listeners, resolves the modifier DndMode, and delivers a DropContext. Returns a Disposable that removes the listeners.

Parameters

el

HTMLElement

handlers

DropTargetHandlers

Returns

Disposable