HTML Drag and Drop
In this article, we will know the HTML Drag & Drop, also understand its implementation with the help of examples.
Drag and Drop is a very interactive and user-friendly concept that makes it easier to move an object to a different location by grabbing it. This allows the user to click and hold the mouse button over an element, drag it to another location, and release the mouse button to drop the element there. In HTML 5 Drag and Drop are much easier to code and any element in it is draggable.
Drag and Drop Events: There are various Drag and Drop events, some of them are listed below:
- ondrag: It is used to use when the element or text selection is being dragged in HTML.
- ondragstart: It is used to call a function, drag(event), that specifies what data to be dragged.
- ondragenter: It is used to determine whether or not the drop target is to accept the drop. If the drop is to be accepted, then this event has to be canceled.
- ondragleave: It occurs when the mouse leaves an element before a valid drop target while the drag is occurring.
- ondragover: It specifies where the dragged data can be dropped.
- ondrop: It specifies where the drop has occurred at the end of the drag operation.
- ondragend: It occurs when the user has finished dragging an element.
Procedure for Drag and Drop:
- Step 1: Make an object draggable
- First set the draggable attribute to true for that element to be draggable <img draggable = “true”>
- Then, specify what should happen when the element is dragged. The ondragstart attribute calls a function, drag(event), that specifies what data to be dragged. The dataTransfer.setData() method sets the data type and the value of the dragged data
- The event listener ondragstart will set the allowed effects (copy, move, link, or some combination).
- Step 2: Dropping the Object
- The ondragover event specifies where the dragged data can be dropped. By default, data/elements cannot be dropped in other elements. To allow a drop, it must prevent the default handling of the element. This is done by calling the event.preventDefault() method
- Finally, the drop event, which allows the actual drop to be performed
Example 1: This example shows the drag & drop of an image in HTML.
The Data Transfer Object: The data transfer property is used when the whole process of Drag and Drop happens. It is used to hold the dragged data from the source and drop it to the desired location. These are the properties associated with it:
- dataTransfer.setData(format, data): It is used to set the data to be dragged.
- dataTransfer.clearData(format): It is used for calling this function with no argument that clears all the data. Calling it with a format argument removes only that specific data.
- dataTransfer.getData(format): It returns the data of the specified format. If there is no such data, returns the empty string.
- dataTransfer.types: This property returns an array of all the formats that were set in the dragstart event.
- dataTransfer.files: It is used to return all the files that are to be dropped.
- dataTransfer.setDragImage(element, x, y): It is used to display an existing image as the drag image instead of the default image alongside the cursor. The coordinates specify the drop location.
- dataTransfer.addElement(element): It is used to add the specified element to be drawn as a drag feedback image.
- dataTransfer.effectAllowed(value): It will tell the browser that only the listed type(s) of operations are allowed for the user. The property can be set to the following values: none, copy, copyLink, copyMove, link, linkMove, move, all, and uninitialized.
- dataTransfer.dropEffect(value): It is used to control the feedback that the user is given during the dragenter and dragover events. When the user hovers over a target element, the browser’s cursor will indicate what type of operation is going to take place (e.g. a copy, a move, etc.). The effect can take on one of the following values: none, copy, link, move.
Example 2: This example illustrates the use of the draggable property of the element.
- Start the drag by setting the draggable property of the element to be dragged to true.
- Get the dragged data with the dataTransfer.getData() method. This method will return any data that was set to the same type in the setData() method.
- Call event.preventDefault() method to allow the dropping of elements in other elements by preventing the default handling of the element.
- The element is stored in the variable data which we append into the drop element.
Example 3: This example illustrates the image drag and drop.
Example 4: This example demonstrates dragging the text in the rectangular box in HTML.
- Google Chrome 93.0
- Microsoft Edge 93.0
- Firefox 92.0
- Opera 78.0
- Safari 14.1