IDragAndDropOptions<T>

Defined in: ui.ts:779

Options for makeDroppable. All callbacks are optional; pass only what you need.

Type Parameters

Type Parameter	Default type
T	any

Properties

Property	Type	Description	Defined in
acceptDrag?	(args) => boolean	Predicate called with the full DragDropArgs — veto by returning false or setting args.handled = true.	ui.ts:783
acceptDrop?	(dragObject) => boolean	Fast predicate used to decide whether to show a drop zone for dragObject.	ui.ts:781
doDrop?	(args) => void	Handles the drop. Read args.dragObject, args.copying, args.link, etc.	ui.ts:785
dropIndication?	boolean	When false, suppresses the default d4-drop-zone element. Defaults to true.	ui.ts:803
dropSuggestion?	string	Text shown inside the default drop zone.	ui.ts:801
dropZoneRectTransformation?	(r) => Rect	Transforms the default rectangle used to position the drop zone over the host.	ui.ts:799
getDropElement?	() => Element	Returns the element that should receive the d4-drop class during the drag.	ui.ts:795
makeDropZone?	() => Element	Returns a custom drop-zone element, replacing the default .d4-drop-zone.	ui.ts:797
onBeginDrag?	(args) => void	Fires when a drag session starts and this zone is eligible.	ui.ts:787
onEndDrag?	(args) => void	Fires when a drag session ends (whether it landed here or not).	ui.ts:789
onMouseEnter?	(e, args) => void	-	ui.ts:790
onMouseLeave?	(e, args) => void	-	ui.ts:792
onMouseOut?	(e, args) => void	-	ui.ts:793
onMouseOver?	(e, args) => void	-	ui.ts:791