HTML5 tutorial on implementing drag-and-drop sorting through API

HTML5 provides a direct drag-and-drop API, which greatly facilitates us to achieve drag-and-drop effects. We do not need to write a lot of js. We only need to listen to the drag-and-drop events of elements to achieve various drag-and-drop functions. .

Preface

HTML5 provides a direct drag-and-drop API, which greatly facilitates us to achieve the drag-and-drop effect. We don’t need to write a lot of js, just Various drag-and-drop functions can be implemented by listening to the drag-and-drop events of elements.

If you want to drag and drop an element, you must set the draggable attribute of the element to true. When this attribute is false, drag and drop will not be allowed. Both the img element and the a element have the draggable attribute set to true by default, so they can be dragged and dropped directly. If you do not want to drag and drop these two elements, just set the attribute to false.

Drag and drop events

Drag and drop events are generated by different elements. When an element is dragged and dropped, it may pass through many elements before finally reaching the element you want to place. Here, I temporarily call the dragged element the source object, the passed element the process object, and the arrived element the target object. Different objects generate different drag and drop events.

Source object:

1. dragstart: The source object starts dragging and dropping.

2. drag: During the drag and drop process of the source object.

3. dragend: The drag and drop of the source object ends.

Process object:

1. dragenter: The source object begins to enter the scope of the process object.

2. dragover: The source object moves within the scope of the process object.

3. dragleave: The source object leaves the scope of the process object.

Target object:

1. drop: The source object is dragged and dropped into the target object.

<p id="source" draggable="true">a元素</p>
<p id="process">b元素</p>
<p id="target">c元素</p>

<script>
    var source = document.getElementById(&#39;source&#39;),     // a元素
        process = document.getElementById(&#39;process&#39;),   // b元素
        target = document.getElementById(&#39;target&#39;);     // c元素
    
    source.addEventListener(&#39;dragstart&#39;,function(ev){   // dragstart事件由a元素产生
        console.log(&#39;a元素开始被拖动&#39;);
    },false)

    process.addEventListener(&#39;dragenter&#39;,function(ev){  // dragenter事件由b元素产生
        console.log(&#39;a元素开始进入b元素&#39;);
    },false)
    process.addEventListener(&#39;dragleave&#39;,function(ev){  // dragleave事件由b元素产生
        console.log(&#39;a元素离开b元素&#39;);
    },false)

    target.addEventListener(&#39;drop&#39;,function(ev){        // drop事件由c元素产生
        console.log(&#39;a元素拖放到c元素了&#39;);
        ev.preventDefault();
    },false)
    document.ondragover = function(e){e.preventDefault();}
</script>

dataTransfer object

Provides a data transfer object dataTransfer in all drag and drop events. Used to transfer data between source and target objects. Next, let's get to know the methods and properties of this object to understand how it transfers data.

setData()

This method stores data into the dataTransfer object. Receives two parameters. The first one is a string indicating the type of data to be stored. Currently, the following types are supported:

1. text/plain: text text.

2. text/html: HTML text.

3. text/xml: XML text.

4. text/uri-list: URL list, each URL is one line.

The second parameter is the data to be stored. For example:

event.dataTransfer.setData('text/plain','Hello World');

getData()

This method reads data from the dataTransfer object. The parameter is the data type specified in setData. For example:

event.dataTransfer.getData('text/plain');

clearData()

This method clears the data stored in the dataTransfer object. The parameter is optional and is the data type. If the parameter is empty, all types of data will be cleared. For example:

event.dataTransfer.clearData();

setDragImage()

This method sets the drag and drop icon by using the img element. Receives three parameters, the first is the icon element, the second is the X-axis displacement of the icon element from the mouse pointer, and the third is the Y-axis displacement of the icon element from the mouse pointer. For example:

var source = document.getElementById('source'),
    icon = document.createElement('img');

icon.src = 'img.png';

source.addEventListener('dragstart',function(ev){
    ev.dataTransfer.setDragImage(icon,-10,-10)
},false)

effectAllowed and dropEffect properties

These two properties are combined to set the visual effect of drag and drop.

It is worth noting: IE does not support dataTransfer objects. Yes, it is not supported regardless of IE version.

Implement drag-and-drop sorting

We are already familiar with the use of drag-and-drop API. Let’s implement a simple drag-and-drop sorting, which is also common in projects. . Let’s sort out the idea first:

1. In a list, each element can be dragged and dropped. Then you must first set the draggable attribute to true for each element.

2. Listen to the dragstart event of each element and style the source object to distinguish it.

3. Listen to the dragenter event of each element. When the source object enters the current element, add the source object before the element. In this way, the following elements will be squeezed out by the source object, achieving a sorting effect.

4. But you will find that the source object cannot be ranked last, but can only be ranked second to last. At this time, you need to listen to the dragleave event. When the process object is the last element, the source object leaves the process object, and then the source object is added to the end.

The main code is as follows:

var source = document.querySelectorAll('.list'),
    dragElement = null;

for(var i = 0; i < source.length; i++){
    source[i].addEventListener(&#39;dragstart&#39;,function(ev){
        dragElement = this;
    },false);

    source[i].addEventListener(&#39;dragenter&#39;, function(ev){
        if(dragElement != this){
            this.parentNode.insertBefore(dragElement,this);
        }
    }, false)

    source[i].addEventListener(&#39;dragleave&#39;, function(ev){
        if(dragElement != this){
            if(this == this.parentNode.lastElementChild || this == this.parentNode.lastChild){
                this.parentNode.appendChild(dragElement);
            }
        }
    }, false)
};

document.ondragover = function(e){e.preventDefault();}
document.ondrop = function(e){e.preventDefault();}

Complete code address: drag-demo

Compatible

Mainly because the compatibility in IE is not very good, but at least it is compatible with the above drag sorting in IE10.

And in my simple experiment, I found that when the height of the element is not set in IE, the dragleave event will not be triggered.

The more important point is that they are completely incompatible on ios and Android. Fortunately, there is a plug-in that makes it perfectly compatible with mobile devices.

Plug-in address: ios-html5-drag-drop-shim

只需要在原有的代码中引入该插件，即可在移动端上实现拖动了。

<script>
var iosDragDropShim = { enableEnterLeave: true }
</script>
<script src="vendor/ios-drag-drop.js"></script>

The above is the detailed content of HTML5 tutorial on implementing drag-and-drop sorting through API. For more information, please follow other related articles on the PHP Chinese website!