API Reference > ui-components > DragDrop > DropTargetArguments

DropTargetArguments<DragDropObject> Interface

Beta  

Interface for arguments supplied to DropTarget callbacks, including onDropTargetOver, onDropTargetDrop, and canDropTargetDrop.

Extends

Properties

Name Type Description
dropLocation undefined | DragDropObject Object that is being dropped onto, using the data structure relevant to object being used.  

Inherited properties

Name Type Inherited from Description
clientOffset { x: number, y: number } DragDropArguments<DragDropObject> Current mouse position.
col undefined | number DragDropArguments<DragDropObject> specifies the col to be dropped onto.
dataObject DragDropObject DragDropArguments<DragDropObject> Arbitrary data being transferred.
defaultDragLayer undefined | React.ComponentType<DragLayerProps<DragDropObject>> DragSourceArguments<DragDropObject>  
dragRect undefined | ClientRect DragDropArguments<DragDropObject> ClientRect object of dragSource.
dropEffect DropEffects DragDropArguments<DragDropObject> Drop Effect of current drag
dropRect undefined | ClientRect DragDropArguments<DragDropObject> ClientRect object of current dropTarget, if available.
dropStatus DropStatus DragDropArguments<DragDropObject> Status of current drop
initialClientOffset { x: number, y: number } DragDropArguments<DragDropObject> Mouse position at beginning of drag.
initialSourceClientOffset undefined | { x: number, y: number } DragDropArguments<DragDropObject> Position of top left corner of current dragSource, measured at beginning of drag.
local undefined | false | true DragDropArguments<DragDropObject> determines whether item is dropped on same structure as the drag source, or a different structure.
parentObject undefined | DragDropObject DragSourceArguments<DragDropObject> Parent object, using the data structure relevant to object being used.
row undefined | number DragDropArguments<DragDropObject> specifies the row to be dropped onto.
sourceClientOffset undefined | { x: number, y: number } DragDropArguments<DragDropObject> Current mouse position, offset by the difference between initial mouse position and initial dragSource offset.

Defined in

Last Updated: 13 June, 2024