如何实现页面元素的拖拽——JavaScript拖拽插件SortableJS

介绍

SortableJS是一款用于在现代浏览器和触摸设备上的拖拽插件，不需要jQuery，但支持jQuery,支持Meteor，AngularJS，React，Polymer，Vue，Knockout和任何CSS库，例如Bootstrap。

特性

• 支持触屏设备和大部分浏览器，不支持IE9以下
• 可以从一个列表容器中拖拽一个列表单元到其他容器或本列表容器中进行排序
• 拖拽列表有动画效果
• 支持拖动手柄（小手）和可选文本
• 智能自动滚动
• 高级交换检测
• 使用原生HTML5拖放API构建
• 支持Meter、Angular、React、Knockout、Polymer、Vue
• 支持任意CSS库，如BootStrap
• 简单的API
• CDN服务
• 不依赖jQuery(但支持jQuery)

安装

通过npm

npm install sortablejs --save

通过bower

bower install --save sortablejs

用法

<ul id=\"items\">

<li>item 1</li>

<li>item 2</li>

<li>item 3</li>

</ul>

var el = document.getElementById(\'items\');

var sortable = Sortable.create(el);

备注：不仅仅是可以使用ul/li，比如div等

官方配置

根据官网文档简单介绍下：

• group：字符串或对象

string：命名，个人建议用元素id就行,用处是为了设置可以拖放容器时使用

array：[name,pull,put]

name：同string的方法，

pull：pull用来定义从这个列表容器移动出去的设置，true/false/\'clone\'/function

true:列表容器内的列表单元可以被移出；

false：列表容器内的列表单元不可以被移出；

\'clone\'：列表单元移出，移动的为该元素的副本；

function：用来进行pull的函数判断，可以进行复杂逻辑，在函数中return false/true来判断是否移出；

put：put用来定义往这个列表容器放置列表单元的的设置，true/false/[\'foo\',\'bar\']/function

true:列表容器可以从其他列表容器内放入列表单元；

false：与true相反；

[\'foo\',\'bar\']：这个可以是一个字符串或者是字符串的数组，代表的是group配置项里定义的name值；

function：用来进行put的函数判断，可以进行复杂逻辑，在函数中return false/true来判断是否放入；

• sort：boolean 定义是否列表单元是否可以在列表容器内进行拖拽排序
• delay：number 定义鼠标选中列表单元可以开始拖动的延迟时间；
• disabled：boolean 定义是否此sortable对象是否可用，为true时sortable对象不能拖放排序等功能，为false时为可以进行排序，相当于一个开关；
• animation：number 单位：ms，定义排序动画的时间；
• handle：selector 格式为简单css选择器的字符串，使列表单元中符合选择器的元素成为拖动的手柄，只有按住拖动手柄才能使列表单元进行拖动；
• filter：selector 格式为简单css选择器的字符串，定义哪些列表单元不能进行拖放，可设置为多个选择器，中间用“，”分隔；
• draggable：selector 格式为简单css选择器的字符串，定义哪些列表单元可以进行拖放
• ghostClass：selector 格式为简单css选择器的字符串，当拖动列表单元时会生成一个副本作为影子单元来模拟被拖动单元排序的情况，此配置项就是来给这个影子单元添加一个class，我们可以通过这种方式来给影子元素进行编辑样式；
• chosenClass：selector 格式为简单css选择器的字符串，当选中列表单元时会给该单元增加一个class；
• forceFallback：boolean 如果设置为true时，将不使用原生的html5的拖放，可以修改一些拖放中元素的样式等；
• fallbackClass：string 当forceFallback设置为true时，拖放过程中鼠标附着单元的样式；
• scroll：boolean 默认为true，当排序的容器是个可滚动的区域，拖放可以引起区域滚动
• 事件：
• onChoose：function 列表单元被选中的回调函数
• onStart：function 列表单元拖动开始的回调函数
• onEnd：function 列表单元拖放结束后的回调函数
• onAdd：function 列表单元添加到本列表容器的回调函数
• onUpdate：function 列表单元在列表容器中的排序发生变化后的回调函数
• onRemove：function 列表元素移到另一个列表容器的回调函数
• onFilter：function 试图选中一个被filter过滤的列表单元的回调函数
• onMove：function 当移动列表单元在一个列表容器中或者多个列表容器中的回调函数
• onClone：function 当创建一个列表单元副本的时候的回调函数

事件对象

• to：HTMLElement–移动到列表容器
• from：HTMLElement–来源的列表容器
• item：HTMLElement–被移动的列表单元
• clone：HTMLElement–副本的列表单元
• oldIndex：number/undefined–在列表容器中的原序号
• newIndex：number/undefined–在列表容器中的新序号

move 事件对象：

• to:HTMLElement
• from:HTMLElement
• dragged:HTMLElement
• draggedRect:DOMRect
• related:HTMLElement — element on which have guided
• relatedRect:DOMRect
• willInsertAfter:Boolean — true if will element be inserted after target (or false if before)

方法

• option(name[,value])

获取或设置选项

• closest

对于集合中的每个元素，通过测试元素本身并遍历DOM树中的祖先来获取与选择器匹配的第一个元素

• toArray()

序列化可排序的列表单元的data-id（可通过配置项中dataIdAttr修改）放入一个数组，并返回这个数组中

• sort()

通过自定义列表单元的data-id的数组对列表单元进行排序

• save()

保存当前排序

• destroy()

完全销毁可拖拽功能

总结以下

SortableJS在某些场景下非常有用，它是一个很好用的前端拖拽解决方案，合理的使用将会带来某些意想不到的惊喜，比如让某些不可拖拽模态框，变成可拖拽模态（没有实践过），喜欢折腾的小伙伴可以收藏学习了，本人翻译功底实在有限，如果对你有帮助，请点个关注吧！谢谢！

js事件中拖拉事件JavaScript教程

今天小编为大家分享一下js事件中拖拉事件JavaScript教程。

1、拖拉事件的种类

拖拉（drag）指的是，用户在某个对象上按下鼠标键不放，拖动它到另一个位置，然后释放鼠标键，将该对象放在那里。

拖拉的对象有好几种，包括元素节点、图片、链接、选中的文字等等。在网页中，除了元素节点默认不可以拖拉，其他（图片、链接、选中的文字）都是可以直接拖拉的。为了让元素节点可拖拉，可以将该节点的draggable属性设为true。

<divdraggable=\"true\">

此区域可拖拉

</div>

draggable属性可用于任何元素节点，但是图片（<img>）和链接（<a>）不加这个属性，就可以拖拉。对于它们，用到这个属性的时候，往往是将其设为false，防止拖拉这两种元素。

注意，一旦某个元素节点的draggable属性设为true，就无法再用鼠标选中该节点内部的文字或子节点了。

当元素节点或选中的文本被拖拉时，就会持续触发拖拉事件，包括以下一些事件。

drag：拖拉过程中，在被拖拉的节点上持续触发（相隔几百毫秒）。

dragstart：用户开始拖拉时，在被拖拉的节点上触发，该事件的target属性是被拖拉的节点。通常应该在这个事件的监听函数中，指定拖拉的数据。

dragend：拖拉结束时（释放鼠标键或按下ESC键）在被拖拉的节点上触发，该事件的target属性是被拖拉的节点。它与dragstart事件，在同一个节点上触发。不管拖拉是否跨窗口，或者中途被取消，dragend事件总是会触发的。

dragenter：拖拉进入当前节点时，在当前节点上触发一次，该事件的target属性是当前节点。通常应该在这个事件的监听函数中，指定是否允许在当前节点放下（drop）拖拉的数据。如果当前节点没有该事件的监听函数，或者监听函数不执行任何操作，就意味着不允许在当前节点放下数据。在视觉上显示拖拉进入当前节点，也是在这个事件的监听函数中设置。

dragover：拖拉到当前节点上方时，在当前节点上持续触发（相隔几百毫秒），该事件的target属性是当前节点。该事件与dragenter事件的区别是，dragenter事件在进入该节点时触发，然后只要没有离开这个节点，dragover事件会持续触发。

dragleave：拖拉操作离开当前节点范围时，在当前节点上触发，该事件的target属性是当前节点。如果要在视觉上显示拖拉离开操作当前节点，就在这个事件的监听函数中设置。

drop：被拖拉的节点或选中的文本，释放到目标节点时，在目标节点上触发。注意，如果当前节点不允许drop，即使在该节点上方松开鼠标键，也不会触发该事件。如果用户按下ESC键，取消这个操作，也不会触发该事件。该事件的监听函数负责取出拖拉数据，并进行相关处理。

下面的例子展示，如何动态改变被拖动节点的背景色。

div.addEventListener(\'dragstart\',function(e){

this.style.backgroundColor=\'red\';

},false);

div.addEventListener(\'dragend\',function(e){

this.style.backgroundColor=\'green\';

},false);

上面代码中，div节点被拖动时，背景色会变为红色，拖动结束，又变回绿色。

下面是一个例子，展示如何实现将一个节点从当前父节点，拖拉到另一个父节点中。

/*HTML代码如下

<divclass=\"dropzone\">

<divid=\"draggable\"draggable=\"true\">

该节点可拖拉

</div>

</div>

<divclass=\"dropzone\"></div>

<divclass=\"dropzone\"></div>

<divclass=\"dropzone\"></div>

*/

//被拖拉节点

vardragged;

document.addEventListener(\'dragstart\',function(event){

//保存被拖拉节点

dragged=event.target;

//被拖拉节点的背景色变透明

event.target.style.opacity=0.5;

},false);

document.addEventListener(\'dragend\',function(event){

//被拖拉节点的背景色恢复正常

event.target.style.opacity=\'\';

},false);

document.addEventListener(\'dragover\',function(event){

//防止拖拉效果被重置，允许被拖拉的节点放入目标节点

event.preventDefault();

},false);

document.addEventListener(\'dragenter\',function(event){

//目标节点的背景色变紫色

//由于该事件会冒泡，所以要过滤节点

if(event.target.className===\'dropzone\'){

event.target.style.background=\'purple\';

}

},false);

document.addEventListener(\'dragleave\',function(event){

//目标节点的背景色恢复原样

if(event.target.className===\'dropzone\'){

event.target.style.background=\'\';

}

},false);

document.addEventListener(\'drop\',function(event){

//防止事件默认行为（比如某些元素节点上可以打开链接），

event.preventDefault();

if(event.target.className===\'dropzone\'){

//恢复目标节点背景色

event.target.style.background=\'\';

//将被拖拉节点插入目标节点

dragged.parentNode.removeChild(dragged);

event.target.appendChild(dragged);

}

},false);

关于拖拉事件，有以下几个注意点。

拖拉过程只触发以上这些拖拉事件，尽管鼠标在移动，但是鼠标事件不会触发。

将文件从操作系统拖拉进浏览器，不会触发dragstart和dragend事件。

dragenter和dragover事件的监听函数，用来取出拖拉的数据（即允许放下被拖拉的元素）。由于网页的大部分区域不适合作为放下拖拉元素的目标节点，所以这两个事件的默认设置为当前节点不允许接受被拖拉的元素。如果想要在目标节点上放下的数据，首先必须阻止这两个事件的默认行为。

<divondragover=\"returnfalse\">

<divondragover=\"event.preventDefault()\">

上面代码中，如果不取消拖拉事件或者阻止默认行为，就不能在div节点上放下被拖拉的节点。

2、DragEvent接口

拖拉事件都继承了DragEvent接口，这个接口又继承了MouseEvent接口和Event接口。

浏览器原生提供一个DragEvent()构造函数，用来生成拖拉事件的实例对象。

newDragEvent(type,options)

DragEvent()构造函数接受两个参数，第一个参数是字符串，表示事件的类型，该参数必须；第二个参数是事件的配置对象，用来设置事件的属性，该参数可选。配置对象除了接受MouseEvent接口和Event接口的配置属性，还可以设置dataTransfer属性要么是null，要么是一个DataTransfer接口的实例。

DataTransfer的实例对象用来读写拖拉事件中传输的数据，详见下文《DataTransfer接口》的部分。

3、DataTransfer接口概述

所有拖拉事件的实例都有一个DragEvent.dataTransfer属性，用来读写需要传递的数据。这个属性的值是一个DataTransfer接口的实例。

浏览器原生提供一个DataTransfer()构造函数，用来生成DataTransfer实例对象。

vardataTrans=newDataTransfer();

DataTransfer()构造函数不接受参数。

拖拉的数据分成两方面：数据的种类（又称格式）和数据的值。数据的种类是一个MIME字符串（比如text/plain、image/jpeg），数据的值是一个字符串。一般来说，如果拖拉一段文本，则数据默认就是那段文本；如果拖拉一个链接，则数据默认就是链接的URL。

拖拉事件开始时，开发者可以提供数据类型和数据值。拖拉过程中，开发者通过dragenter和dragover事件的监听函数，检查数据类型，以确定是否允许放下（drop）被拖拉的对象。比如，在只允许放下链接的区域，检查拖拉的数据类型是否为text/uri-list。

发生drop事件时，监听函数取出拖拉的数据，对其进行处理。

4、DataTransfer的实例属性

DataTransfer.dropEffect

DataTransfer.dropEffect属性用来设置放下（drop）被拖拉节点时的效果，会影响到拖拉经过相关区域时鼠标的形状。它可能取下面的值。

copy：复制被拖拉的节点

move：移动被拖拉的节点

link：创建指向被拖拉的节点的链接

none：无法放下被拖拉的节点

除了上面这些值，设置其他的值都是无效的。

target.addEventListener(\'dragover\',function(e){

e.preventDefault();

e.stopPropagation();

e.dataTransfer.dropEffect=\'copy\';

});

上面代码中，被拖拉元素一旦drop，接受的区域会复制该节点。

dropEffect属性一般在dragenter和dragover事件的监听函数中设置，对于dragstart、drag、dragleave这三个事件，该属性不起作用。因为该属性只对接受被拖拉的节点的区域有效，对被拖拉的节点本身是无效的。进入目标区域后，拖拉行为会初始化成设定的效果。

4.2、DataTransfer.effectAllowed

DataTransfer.effectAllowed属性设置本次拖拉中允许的效果。它可能取下面的值。

copy：复制被拖拉的节点

move：移动被拖拉的节点

link：创建指向被拖拉节点的链接

copyLink：允许copy或link

copyMove：允许copy或move

linkMove：允许link或move

all：允许所有效果

none：无法放下被拖拉的节点

uninitialized：默认值，等同于all

如果某种效果是不允许的，用户就无法在目标节点中达成这种效果。

这个属性与dropEffect属性是同一件事的两个方面。前者设置被拖拉的节点允许的效果，后者设置接受拖拉的区域的效果，它们往往配合使用。

dragstart事件的监听函数，可以用来设置这个属性。其他事件的监听函数里面设置这个属性是无效的。

source.addEventListener(\'dragstart\',function(e){

e.dataTransfer.effectAllowed=\'move\';

});

target.addEventListener(\'dragover\',function(e){

ev.dataTransfer.dropEffect=\'move\';

});

只要dropEffect属性和effectAllowed属性之中，有一个为none，就无法在目标节点上完成drop操作。

4.3、DataTransfer.files

DataTransfer.files属性是一个FileList对象，包含一组本地文件，可以用来在拖拉操作中传送。如果本次拖拉不涉及文件，则该属性为空的FileList对象。

下面就是一个接收拖拉文件的例子。

//HTML代码如下

//<divid=\"output\"style=\"min-height:200px;border:1pxsolidblack;\">

//文件拖拉到这里

//</div>

vardiv=document.getElementById(\'output\');

div.addEventListener(\"dragenter\",function(event){

div.textContent=\'\';

event.stopPropagation();

event.preventDefault();

},false);

div.addEventListener(\"dragover\",function(event){

event.stopPropagation();

event.preventDefault();

},false);

div.addEventListener(\"drop\",function(event){

event.stopPropagation();

event.preventDefault();

varfiles=event.dataTransfer.files;

for(vari=0;i<files.length;i++){

div.textContent+=files[i].name+\'\'+files[i].size+\'字节\\n\';

}

},false);

上面代码中，通过dataTransfer.files属性读取被拖拉的文件的信息。如果想要读取文件内容，就要使用FileReader对象。

div.addEventListener(\'drop\',function(e){

e.preventDefault();

e.stopPropagation();

varfileList=e.dataTransfer.files;

if(fileList.length>0){

varfile=fileList[0];

varreader=newFileReader();

reader.onloadend=function(e){

if(e.target.readyState===FileReader.DONE){

varcontent=reader.result;

div.innerHTML=\'File:\'+file.name+\'\\n\\n\'+content;

}

}

reader.readAsBinaryString(file);

}

});

4.4、DataTransfer.types

DataTransfer.types属性是一个只读的数组，每个成员是一个字符串，里面是拖拉的数据格式（通常是MIME值）。比如，如果拖拉的是文字，对应的成员就是text/plain。

下面是一个例子，通过检查dataTransfer属性的类型，决定是否允许在当前节点执行drop操作。

functioncontains(list,value){

for(vari=0;i<list.length;++i){

if(list[i]===value)returntrue;

}

returnfalse;

}

functiondoDragOver(event){

varisLink=contains(event.dataTransfer.types,\'text/uri-list\');

if(isLink)event.preventDefault();

}

上面代码中，只有当被拖拉的节点是一个链接时，才允许在当前节点放下。

4.5、DataTransfer.items

DataTransfer.items属性返回一个类似数组的只读对象（DataTransferItemList实例），每个成员就是本次拖拉的一个对象（DataTransferItem实例）。如果本次拖拉不包含对象，则返回一个空对象。

DataTransferItemList实例具有以下的属性和方法。

length：返回成员的数量

add(data,type)：增加一个指定内容和类型（比如text/html和text/plain）的字符串作为成员

add(file)：add方法的另一种用法，增加一个文件作为成员

remove(index)：移除指定位置的成员

clear()：移除所有的成员

DataTransferItem实例具有以下的属性和方法。

kind：返回成员的种类（string还是file）。

type：返回成员的类型（通常是MIME值）。

getAsFile()：如果被拖拉是文件，返回该文件，否则返回null。

getAsString(callback)：如果被拖拉的是字符串，将该字符传入指定的回调函数处理。该方法是异步的，所以需要传入回调函数。

下面是一个例子。

div.addEventListener(\'drop\',function(e){

e.preventDefault();

if(e.dataTransfer.items!=null){

for(vari=0;i<e.dataTransfer.items.length;i++){

console.log(e.dataTransfer.items[i].kind+\':\'+e.dataTransfer.items[i].type);

}

}

});

5、DataTransfer的实例方法

5.1、DataTransfer.setData()

DataTransfer.setData()方法用来设置拖拉事件所带有的数据。该方法没有返回值。

event.dataTransfer.setData(\'text/plain\',\'Texttodrag\');

上面代码为当前的拖拉事件加入纯文本数据。

该方法接受两个参数，都是字符串。第一个参数表示数据类型（比如text/plain），第二个参数是具体数据。如果指定类型的数据在dataTransfer属性不存在，那么这些数据将被加入，否则原有的数据将被新数据替换。

如果是拖拉文本框或者拖拉选中的文本，会默认将对应的文本数据，添加到dataTransfer属性，不用手动指定。

<divdraggable=\"true\">

aaa

</div>

上面代码中，拖拉这个<div>元素会自动带上文本数据aaa。

使用setData方法，可以替换到原有数据。

<div

draggable=\"true\"

ondragstart=\"event.dataTransfer.setData(\'text/plain\',\'bbb\')\"

>

aaa

</div>

上面代码中，拖拉数据实际上是bbb，而不是aaa。

下面是添加其他类型的数据。由于text/plain是最普遍支持的格式，为了保证兼容性，建议最后总是保存一份纯文本格式的数据。

vardt=event.dataTransfer;

//添加链接

dt.setData(\'text/uri-list\',\'http://www.example.com\');

dt.setData(\'text/plain\',\'http://www.example.com\');

//添加HTML代码

dt.setData(\'text/html\',\'Hellothere,<strong>stranger</strong>\');

dt.setData(\'text/plain\',\'Hellothere,<strong>stranger</strong>\');

//添加图像的URL

dt.setData(\'text/uri-list\',imageurl);

dt.setData(\'text/plain\',imageurl);

可以一次提供多种格式的数据。

vardt=event.dataTransfer;

dt.setData(\'application/x-bookmark\',bookmarkString);

dt.setData(\'text/uri-list\',\'http://www.example.com\');

dt.setData(\'text/plain\',\'http://www.example.com\');

上面代码中，通过在同一个事件上面，存放三种类型的数据，使得拖拉事件可以在不同的对象上面，drop不同的值。注意，第一种格式是一个自定义格式，浏览器默认无法读取，这意味着，只有某个部署了特定代码的节点，才可能drop（读取到）这个数据。

5.2、DataTransfer.getData()

DataTransfer.getData()方法接受一个字符串（表示数据类型）作为参数，返回事件所带的指定类型的数据（通常是用setData方法添加的数据）。如果指定类型的数据不存在，则返回空字符串。通常只有drop事件触发后，才能取出数据。

下面是一个drop事件的监听函数，用来取出指定类型的数据。

functiononDrop(event){

vardata=event.dataTransfer.getData(\'text/plain\');

event.target.textContent=data;

event.preventDefault();

}

上面代码取出拖拉事件的文本数据，将其替换成当前节点的文本内容。注意，这时还必须取消浏览器的默认行为，因为假如用户拖拉的是一个链接，浏览器默认会在当前窗口打开这个链接。

getData方法返回的是一个字符串，如果其中包含多项数据，就必须手动解析。

functiondoDrop(event){

varlines=event.dataTransfer.getData(\'text/uri-list\').split(\'\\n\');

for(letlineoflines){

letlink=document.createElement(\'a\');

link.href=line;

link.textContent=line;

event.target.appendChild(link);

}

event.preventDefault();

}

上面代码中，getData方法返回的是一组链接，就必须自行解析。

类型值指定为URL，可以取出第一个有效链接。

varlink=event.dataTransfer.getData(\'URL\');

下面的例子是从多种类型的数据里面取出数据。

functiondoDrop(event){

vartypes=event.dataTransfer.types;

varsupportedTypes=[\'text/uri-list\',\'text/plain\'];

types=supportedTypes.filter(function(value){types.includes(value)});

if(types.length){

vardata=event.dataTransfer.getData(types[0]);

}

event.preventDefault();

}

5.3、DataTransfer.clearData()

DataTransfer.clearData()方法接受一个字符串（表示数据类型）作为参数，删除事件所带的指定类型的数据。如果没有指定类型，则删除所有数据。如果指定类型不存在，则调用该方法不会产生任何效果。

event.dataTransfer.clearData(\'text/uri-list\');

上面代码清除事件所带的text/uri-list类型的数据。

该方法不会移除拖拉的文件，因此调用该方法后，DataTransfer.types属性可能依然会返回Files类型（前提是存在文件拖拉）。

注意，该方法只能在dragstart事件的监听函数之中使用，因为这是拖拉操作的数据唯一可写的时机。

5.4、DataTransfer.setDragImage()

拖动过程中（dragstart事件触发后），浏览器会显示一张图片跟随鼠标一起移动，表示被拖动的节点。这张图片是自动创造的，通常显示为被拖动节点的外观，不需要自己动手设置。

DataTransfer.setDragImage()方法可以自定义这张图片。它接受三个参数。第一个是<img>节点或者<canvas>节点，如果省略或为null，则使用被拖动的节点的外观；第二个和第三个参数为鼠标相对于该图片左上角的横坐标和右坐标。

下面是一个例子。

/*HTML代码如下

<divid=\"drag-with-image\"class=\"dragdemo\"draggable=\"true\">

dragme

</div>

*/

vardiv=document.getElementById(\'drag-with-image\');

div.addEventListener(\'dragstart\',function(e){

varimg=document.createElement(\'img\');

img.src=\'http://path/to/img\';

e.dataTransfer.setDragImage(img,0,0);

},false);