vuedraggable中文文档
时间: 2023-09-05 19:09:58 浏览: 193
VueDraggable 是一个基于 Vue.js 的拖放组件库,用于实现可拖拽和可排序的列表和网格布局。
以下是 VueDraggable 的中文文档:
## 安装
使用 npm 安装:
```bash
npm install vuedraggable --save
```
## 使用
在 Vue 应用程序中引入 vuedraggable 组件:
```javascript
import draggable from 'vuedraggable'
```
然后在 Vue 组件中使用它:
```html
<draggable v-model="list">
<div v-for="item in list" :key="item.id">{{item.name}}</div>
</draggable>
```
在上面的示例中,我们使用 `v-model` 将列表数据绑定到 `list` 变量上,并将每个项目渲染为一个 `div` 元素。
## API
### Props
以下是可用的 props:
| 属性名 | 类型 | 描述 |
| --- | --- | --- |
| value / v-model | Array | 绑定的列表数据 |
| clone | Function | 用于克隆元素的函数 |
| tag | String | 渲染列表元素的 HTML 标签 |
| move | Function | 用于移动元素的函数 |
| component-data | Object | 传递给组件的数据 |
| component-name | String | 用于渲染每个元素的组件名称 |
| component-class | String | 用于渲染每个元素的 CSS 类名 |
| component-style | Object | 用于渲染每个元素的 CSS 样式 |
| handle | String | 用于拖动元素的选择器 |
| disabled | Boolean | 是否禁用拖放功能 |
| delay | Number | 拖动开始前的等待时间 |
| group | String / Object | 指定拖动元素所属的组 |
| ghost-class | String | 拖动时元素的 CSS 类名 |
| ghost-style | Object | 拖动时元素的 CSS 样式 |
| fallback-class | String | 拖动失败时元素的 CSS 类名 |
| fallback-style | Object | 拖动失败时元素的 CSS 样式 |
| scroll | Boolean / Object | 拖动到边缘时是否自动滚动 |
| scroll-sensitivity | Number | 拖动到边缘时滚动的敏感度 |
| scroll-speed | Number | 拖动到边缘时滚动的速度 |
### 事件
以下是可用的事件:
| 事件名 | 描述 |
| --- | --- |
| start | 开始拖动元素时触发的事件 |
| add | 将元素添加到列表中时触发的事件 |
| remove | 从列表中删除元素时触发的事件 |
| update | 更新列表中元素位置时触发的事件 |
| end | 结束拖动元素时触发的事件 |
| choose | 选择元素时触发的事件 |
| unchoose | 取消选择元素时触发的事件 |
| sort | 对列表进行排序时触发的事件 |
| filter | 过滤列表时触发的事件 |
| clone | 克隆元素时触发的事件 |
| move | 移动元素时触发的事件 |
### 插槽
以下是可用的插槽:
| 插槽名 | 描述 |
| --- | --- |
| default | 列表元素的内容 |
| before | 列表前面的内容 |
| after | 列表后面的内容 |
## 示例
以下是一个完整的示例:
```html
<template>
<div>
<h1>VueDraggable 示例</h1>
<draggable v-model="list" :clone="clone" :tag="'ul'" :handle="'.handle'">
<li v-for="item in list" :key="item.id" :class="'item-'+item.id">
<span class="handle">☰</span>
<span class="name">{{item.name}}</span>
</li>
</draggable>
</div>
</template>
<script>
import draggable from 'vuedraggable'
export default {
components: {
draggable
},
data: function () {
return {
list: [
{ id: 1, name: 'Item 1' },
{ id: 2, name: 'Item 2' },
{ id: 3, name: 'Item 3' },
{ id: 4, name: 'Item 4' }
]
}
},
methods: {
clone: function (item) {
return { id: item.id, name: item.name }
}
}
}
</script>
<style>
.handle {
cursor: move;
}
</style>
```
在上面的示例中,我们创建了一个列表,并使用 `v-model` 将其绑定到 `list` 变量上。
使用 `clone` prop 克隆元素,使用 `tag` prop 设置列表元素的 HTML 标签,使用 `handle` prop 设置拖动元素的选择器。
设置每个列表元素的 CSS 类名和内容,然后使用 `draggable` 组件渲染它们。
阅读全文