Vue.Draggable使用文档超详细总结

更新时间：2022年08月26日 09:54:32 作者：taoyouyou

Vue拖拽组件(Draggable)是一个允许与View-Model同步进行拖放排序的Vue组件,下面这篇文章主要给大家介绍了关于Vue.Draggable使用文档的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下

前言

Draggable为基于Sortable.js的vue组件，用以实现拖拽功能。

关于Vue.Draggable详细信息可以查看github地址

特性

支持触摸设备
支持拖拽和选择文本
支持智能滚动
支持不同列表之间的拖拽
不以jQuery为基础
和视图模型同步刷新
和vue2的国度动画兼容
支持撤销操作
当需要完全控制时，可以抛出所有变化
可以和现有的UI组件兼容

安装

npm install vuedraggable

引入

import draggable from 'vuedraggable'

基础用法

定义一个json串 list，实现它的拖拽排序。

<draggable v-model="list">
    <transition-group>
        <div v-for="element in list" :key="element.id">
            {{element.name}}
        </div>
    </transition-group>
</draggable>

属性

参数	说明	类型	默认值
value	用于实现拖拽的list，通常和内部v-for循环的数组为同一数组	Array	null
list	效果同value的。和v-model不能共用	Array	null
tag	draggable 标签在渲染后展现出来的标签类型	String	div
options	draggable 列表配置项	Object	null
emptyInsertThreshold	拖动时，鼠标必须与空的可排序对象之间的距离	Number	5
clone	返回值为true时克隆，可以理解为正常的拖拽变成了复制。当pull:'clone时的拖拽的回调函数’	Function	无处理
move	如果不为空，这个函数将以类似于Sortable onMove回调的方式调用。返回false将取消拖动操作。	Function	null
componentData	用来结合UI组件的，可以理解为代理了UI组件的定制信息	Object	null

注意：vuedraggable新版本废弃了options属性，建议使用v-bind属性作为配置项

options配置项

参数	说明	类型
group	用于分组，同一组的不同list可以相互拖动	String/Array
sort	定义是否可以拖拽	Boolean
delay	定义鼠标选中列表单元可以开始拖动的延迟时间	Number
disabled	定义是否此sortable对象是否可用	Boolean
animation	动画时间单位:ms	Number
handle	使列表单元中符合选择器的元素成为拖动的手柄，只有按住拖动手柄才能使列表单元进行拖动	Selector
filter	定义哪些列表单元不能进行拖放，可设置为多个选择器，中间用“，”分隔	Selector
preventOnFilter	当拖动filter时是否触发event.preventDefault() 默认触发	Boolean
draggable	定义哪些列表单元可以进行拖放	Selector
ghostClass	当拖动列表单元时会生成一个副本作为影子单元来模拟被拖动单元排序的情况，此配置项就是来给这个影子单元添加一个class	Selector
chosenClass	目标被选中时添加	Selector
dragClass	目标拖动过程中添加	Selector
forceFallback	如果设置为true时，将不使用原生的html5的拖放，可以修改一些拖放中元素的样式等	Boolean
fallbackClass：	当forceFallback设置为true时，拖放过程中鼠标附着单元的样式	String
dataIdAttr	data-id	Selector
scroll	当排序的容器是个可滚动的区域，拖放可以引起区域滚动	Boolean
scrollFn	用于自定义滚动条的适配	Function(offsetX, offsetY, originalEvent, touchEvt, hoverTargetEl)
ScrollSensitivity	就是鼠标靠近边缘多远开始滚动默认30	Number
scrollSpeed	滚动速度	Number

事件

参数	说明	回调参数
start	开始拖动时的回调函数	function（{to,from,item,clone,oldIndex,newIndex})
add	添加单元时的回调函数	function（{to,from,item,clone,oldIndex,newIndex})
remove	单元被移动到另一个列表时的回调函数	function（{to,from,item,clone,oldIndex,newIndex})
update	排序发生变化时的回调函数	function（{to,from,item,clone,oldIndex,newIndex})
end	拖动结束时的回调函数	function（{to,from,item,clone,oldIndex,newIndex})
choose	选择单元时的回调函数	function（{to,from,item,clone,oldIndex,newIndex})
sort	排序发生变化时的回调函数	function（{to,from,item,clone,oldIndex,newIndex})
filter	尝试选择一个被filter过滤的单元的回调函数	function（{to,from,item,clone,oldIndex,newIndex})
clone	clone时的回调函数	function（{to,from,item,clone,oldIndex,newIndex})

插槽

页眉或页脚插槽都不能与 tarnstion-group 一起使用。

Header

使用标题插槽在vuedraggable组件中添加不可拖动的元素。它应该与draggable选项一起使用来标记draggable元素。请注意，无论标题槽在模板中的位置如何，它总是被添加到默认槽之前。

<draggable v-model="myArray" draggable=".item">
    <div v-for="element in myArray" :key="element.id" class="item">
        {{element.name}}
    </div>
    <button slot="header" @click="addPeople">Add</button>
</draggable>

Footer

使用页脚槽在vuedraggable组件中添加不可拖动的元素。它应该与draggable选项一起使用，以标记draggable元素。请注意，无论页脚槽在模板中的位置如何，它都将始终添加到默认槽之后。

<draggable v-model="myArray" draggable=".item">
    <div v-for="element in myArray" :key="element.id" class="item">
        {{element.name}}
    </div>
    <button slot="footer" @click="addPeople">Add</button>
</draggable>

总结

到此这篇关于Vue.Draggable使用文档超的文章就介绍到这了,更多相关Vue.Draggable使用文档内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

node.js开发辅助工具nodemon安装与配置详解
node.js代码修改后，需要重新启动 Express 应用，所做的修改才能生效。若之后的每次代码修改都要重复这样的操作，势必会影响开发效率，本文将详细介绍Nodemon，它会监测项目中的所有文件，一旦发现文件有改动，Nodemon 会自动重启应用
2020-02-02
Vuex 模块化使用详解
这篇文章主要介绍了Vuex 模块化使用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-07-07
vue+echarts图表的基本使用步骤总结
这篇文章主要给大家介绍了关于vue+echarts图表的基本使用步骤,Echarts是一款基于JavaScript的开源可视化图表库,而Vue是一种流行的JavaScript框架,用于构建用户界,需要的朋友可以参考下
2023-11-11
Vue网络请求的三种实现方式介绍
这篇文章主要介绍了Vue网络请求的三种实现方式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-09-09
vue微信分享插件使用方法详解
这篇文章主要介为大家详细绍了vue微信分享插件的使用方法，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-02-02
基于vue.js实现分页查询功能
这篇文章主要为大家详细介绍了基于vue.js实现分页查询功能，vue.js实现数据库分页，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-12-12
javascript中Set、Map、WeakSet、WeakMap区别
这篇文章主要介绍了javascript中Set、Map、WeakSet、WeakMap区别,需要的朋友可以参考下
2022-12-12
Vue.js 中的 $watch使用方法
本篇文章中主要介绍了Vue.js 中的 $watch使用方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-05-05
vue3+springboot部署到Windows服务器的详细步骤
这篇文章主要介绍了vue3+springboot部署到Windows服务器,配置Nginx时，因为现在是把vue前端交给了Nginx代理，所以这里的端口号不一定是我们在vue项目中设置的端口号，本文给大家介绍的非常详细，需要的朋友参考下吧
2022-10-10
Vue头像处理方案小结
这篇文章主要介绍了Vue头像处理方案，实现思路主要是通过获取后台返回头像url，判断图片宽度，高度。具体实例代码大家参考下本文
2018-07-07