IDragAndDropOptions<T>

Defined in: js-api/ui.ts:803

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.	js-api/ui.ts:807
acceptDrop?	(dragObject) => boolean	Fast predicate used to decide whether to show a drop zone for dragObject.	js-api/ui.ts:805
doDrop?	(args) => void	Handles the drop. Read args.dragObject, args.copying, args.link, etc.	js-api/ui.ts:809
dropIndication?	boolean	When false, suppresses the default d4-drop-zone element. Defaults to true.	js-api/ui.ts:827
dropSuggestion?	string	Text shown inside the default drop zone.	js-api/ui.ts:825
dropZoneRectTransformation?	(r) => Rect	Transforms the default rectangle used to position the drop zone over the host.	js-api/ui.ts:823
getDropElement?	() => Element	Returns the element that should receive the d4-drop class during the drag.	js-api/ui.ts:819
makeDropZone?	() => Element	Returns a custom drop-zone element, replacing the default .d4-drop-zone.	js-api/ui.ts:821
onBeginDrag?	(args) => void	Fires when a drag session starts and this zone is eligible.	js-api/ui.ts:811
onEndDrag?	(args) => void	Fires when a drag session ends (whether it landed here or not).	js-api/ui.ts:813
onMouseEnter?	(e, args) => void	-	js-api/ui.ts:814
onMouseLeave?	(e, args) => void	-	js-api/ui.ts:816
onMouseOut?	(e, args) => void	-	js-api/ui.ts:817
onMouseOver?	(e, args) => void	-	js-api/ui.ts:815