Vue 可拖拽组件Vue Smooth DnD的使用详解

• 简介和 Demo 展示
  
• API: Container
  
  
  
  • 属性
    
  • 生命周期
    
  • 回调
    
  • 事件
    
  
  
• API: Draggable
  
  
  
  • 实战
    
  
  

Container
复制代码

Draggable
复制代码

Container
复制代码

Draggable
复制代码

Draggable
复制代码

npm i vue-smooth-dnd
复制代码

<template>
    <div>
        <div class="simple-page">
            <Container @drop="onDrop">
                <Draggable v-for="item in items" :key="item.id">
                    <div class="draggable-item">
                        {{item.data}}
                    </div>
                </Draggable>
            </Container>
        </div>
    </div>
</template>

<script>
    import { Container, Draggable } from "vue-smooth-dnd";

    const applyDrag = (arr, dragResult) => {
        const { removedIndex, addedIndex, payload } = dragResult
        console.log(removedIndex, addedIndex, payload)
        if (removedIndex === null && addedIndex === null) return arr

        const result = [...arr]
        let itemToAdd = payload

        if (removedIndex !== null) {
            itemToAdd = result.splice(removedIndex, 1)[0]
        }

        if (addedIndex !== null) {
            result.splice(addedIndex, 0, itemToAdd)
        }

        return result
    }

    const generateItems = (count, creator) => {
        const result = []
        for (let i = 0; i < count; i++) {
            result.push(creator(i))
        }
        return result
    }

    export default {
        name: "Simple",
        components: { Container, Draggable },
        data() {
            return {
                items: generateItems(50, i => ({ id: i, data: "Draggable " + i }))
            };
        },
        methods: {
            onDrop(dropResult) {
                this.items = applyDrag(this.items, dropResult);
            }
        }
    };

</script>

<style>
    .draggable-item {
        height: 50px;
        line-height: 50px;
        text-align: center;
        display: block;
        background-color: #fff;
        outline: 0;
        border: 1px solid rgba(0, 0, 0, .125);
        margin-bottom: 2px;
        margin-top: 2px;
        cursor: default;
        user-select: none;
    }
</style>
复制代码

drag-class
复制代码

drop-class
复制代码

drop-placeholder.className
复制代码

<Container # 省略其它属性...
        :animation-duration="1000" # 放置元素后动画延时
        drag-class="card-ghost"         
        drop-class="card-ghost-drop"
        :drop-placeholder="{
            className: 'drop-preview',  # 占位符的样式
            animationDuration: '1000', # 占位符的动画延迟
            showOnTop: true            # 是否在其它元素的上面显示 设置为false会被其他的拖拽元素覆盖
        }"
>
    <!-- 一些可拖拽元素 -->
    <Draggable>....</Draggable>
</Container>
复制代码

.card-ghost {
    transition: transform 0.18s ease;
    transform: rotateZ(35deg);
    background: red !important;
}
.card-ghost-drop {
    transition: transform 1s cubic-bezier(0,1.43,.62,1.56);
    transform: rotateZ(0deg);
    background: green !important;
}
.drop-preview {
    border: 1px dashed #abc;
    margin: 5px;
    background: yellow !important;
}
复制代码

Mouse     Calls  Callback / Event       Parameters              Notes

down   o                                                        Initial click

move   o                                                        Initial drag
       |
       |         get-child-payload()    index                   Function should return payload
       |
       |   3 x   should-accept-drop()   srcOptions, payload     Fired for all containers
       |
       |   3 x   drag-start             dragResult              Fired for all containers
       |
       |         drag-enter
       v

move   o                                                        Drag over containers
       |
       |   n x   drag-leave                                     Fired as draggable leaves container
       |   n x   drag-enter                                     Fired as draggable enters container
       v

up     o                                                        Finish drag

                 should-animate-drop()  srcOptions, payload     Fires once for dropped container

           3 x   drag-end               dragResult              Fired for all containers

           n x   drop                   dropResult              Fired only for droppable containers
复制代码

drag-start
复制代码

drag-end
复制代码

should-accept-drop
复制代码

dragResult
复制代码

dragResult: {
    payload,        # 负载 可以理解为用来记录被拖动的对象
    isSource,       # 是否是被拖动的容器本身
    willAcceptDrop, # 是否可以被放置
}
复制代码

dropResult
复制代码

dropResult: {
    addedIndex,     # 被放置的新添加元素的下标，没有则为 null
    removedIndex,   # 将被移除的元素下标，没有则为 null
    payload,        # 拖动的元素对象，可通过 getChildPayload 指定
    droppedElement, # 放置的 DOM 元素
}
复制代码

   


• get-child-payload(index)
  复制代码

  自界说传给

  onDrop()
  复制代码

  的

  payload
  复制代码

  对象。   
  

• should-accept-drop(sourceContainerOptions, payload)
  复制代码

  用来确定容器是否可被放置，会覆盖

  group-name
  复制代码

  属性。   
  

• should-animate-drop(sourceContainerOptions, payload)
  复制代码

  返回

  false
  复制代码

  则阻止放置动画。   
  

• get-ghost-parent()
  复制代码

  返回幽灵元素（拖动时显示的元素）应该添加到的元素，默认是父元素，某些情况定位会出现标题，则可以选择自界说，如返回

  document.body
  复制代码

  。
  

   


• @drag-start
  复制代码

  在拖动开始时由所有容器发出的事件。参数

  dragResult
  复制代码

  。   
  

• @drag-end
  复制代码

  所有容器在拖动结束时调用的函数。 在

  @drop
  复制代码

  事件之前调用。参数

  dragResult
  复制代码

  。   
  

• @drag-enter
  复制代码

  每当拖动的项目在拖动时进入其界限时，相关容器要发出的事件。   
  

• @drag-leave
  复制代码

  每当拖动的项目在拖动时脱离其界限时，相关容器要发出的事件。   
  

• @drop-ready
  复制代码

  当容器中可能放置位置的索引发生变革时，被拖动的容器将调用的函数。根本上，每次容器中的可拖动对象滑动以打开拖动项目标空间时都会调用它。参数

  dropResult
  复制代码

  。   
  

• @drop
  复制代码

  放置结束时所有相关容器会发出的事件（放置动画结束后）。源容器和任何可以担当放置的容器都被以为是相关的。参数

  dropResult
  复制代码

  。
  

tag
复制代码

tag
复制代码

<template>
    <div class="card-scene">
        <Container
                orientation="horizontal"
                @drop="onColumnDrop($event)"
                drag-handle-selector=".column-drag-handle"
        >
            <Draggable v-for="column in taskColumnList" :key="column.name">
                <div class="card-container">
                    <div class="card-column-header">
                        <span class="column-drag-handle">&#x2630;</span>
                        {{ column.name }}
                    </div>
                    <Container
                            group-name="col"
                            @drop="(e) => onCardDrop(column.id, e)"
                            :get-child-payload="getCardPayload(column.id)"
                            drag-class="card-ghost"
                            drop-class="card-ghost-drop"
                            :drop-placeholder="dropPlaceholderOptions"
                            class="draggable-container"
                    >
                        <Draggable v-for="task in column.list" :key="task.id">
                            <div class="task-card">
                                <div class="task-title">{{ task.name }}</div>
                                <div class="task-priority" :style="{ background: priorityMap[task.priority].color }">
                                    {{ priorityMap[task.priority].label }}
                                </div>
                            </div>
                        </Draggable>
                    </Container>
                </div>
            </Draggable>
        </Container>
    </div>
</template>

<script>
    import { Container, Draggable } from "vue-smooth-dnd";

    const applyDrag = (arr, dragResult) => {
        const { removedIndex, addedIndex, payload } = dragResult
        console.log(removedIndex, addedIndex, payload)
        if (removedIndex === null && addedIndex === null) return arr

        const result = [...arr]
        let itemToAdd = payload

        if (removedIndex !== null) {
            itemToAdd = result.splice(removedIndex, 1)[0]
        }

        if (addedIndex !== null) {
            result.splice(addedIndex, 0, itemToAdd)
        }

        return result
    }

    const taskList = [
        {
            name: '首页',
            priority: 'P1',
            status: '待开发',
            id: 1,
        },
        {
            name: '流程图开发',
            priority: 'P3',
            status: '待评审',
            id: 2,
        },
        {
            name: '统计图展示',
            priority: 'P0',
            status: '开发中',
            id: 3,
        },
        {
            name: '文件管理',
            priority: 'P1',
            status: '开发中',
            id: 4,
        }
    ]

    const statusList = ['待评审', '待开发', '开发中', '已完成']

    const taskColumnList = statusList.map((status, index) => {
        return {
            name: status,
            list: taskList.filter(item => item.status === status),
            id: index
        }
    })

    const priorityMap = {
        'P0': {
            label: '最高优',
            color: '#ff5454',
        },
        'P1': {
            label: '高优',
            color: '#ff9a00',
        },
        'P2': {
            label: '中等',
            color: '#ffd139',
        },
        'P3': {
            label: '较低',
            color: '#1ac7b5',
        },
    }

    export default {
        name: 'Cards',
        components: {Container, Draggable},
        data () {
            return {
                taskColumnList,
                priorityMap,
                dropPlaceholderOptions: {
                    className: 'drop-preview',
                    animationDuration: '150',
                    showOnTop: true
                }
            }
        },
        methods: {
            onColumnDrop (dropResult) {
                this.taskColumnList = applyDrag(this.taskColumnList, dropResult)
            },
            onCardDrop (columnId, dropResult) {
                let { removedIndex, addedIndex, payload } = dropResult
                if (removedIndex !== null || addedIndex !== null) {
                    const column = taskColumnList.find(p => p.id === columnId)
                    if (addedIndex !== null && payload) { // 更新任务状态
                        dropResult.payload = {
                            ...payload,
                            status: column.name,
                        }
                    }
                    column.list = applyDrag(column.list, dropResult)
                }
            },
            getCardPayload (columnId) {
                return index =>
                    this.taskColumnList.find(p => p.id === columnId).list[index]
            },
        }
    }
</script>


<style>
    * {
        margin: 0;
        padding: 0;
        font-family: 'Microsoft YaHei','PingFang SC','Helvetica Neue',Helvetica,sans-serif;
        line-height: 1.45;
        color: rgba(0,0,0,.65);
    }
    .card-scene {
        user-select: none;
        display: flex;
        height: 100%;
        margin: 20px;
    }
    .card-container {
        display: flex;
        flex-direction: column;
        width: 260px;
        min-width: 260px;
        border-radius: 12px;
        background-color: #edeff2;
        margin-right: 16px;
        height: calc(100vh - 40px);
    }
    .card-column-header {
        display: flex;
        height: 50px;
        margin: 0 16px;
        align-items: center;
        flex-shrink: 0;
        font-weight: 500;
        font-size: 16px;
    }
    .draggable-container {
        flex-grow: 1;
        overflow: auto;
    }
    .column-drag-handle {
        cursor: move;
        padding: 5px;
    }
    .task-card {
        margin: 10px;
        background-color: white;
        padding: 15px 10px;
        border-radius: 8px;
        box-shadow: 0 1px 2px 0 rgba(0, 0, 0, 0.12);
        cursor: pointer;
        display: flex;
        justify-content: space-between;
    }
    .task-title {
        color: #333333;
        font-size: 14px;
    }
    .task-priority {
        width: 60px;
        line-height: 20px;
        border-radius: 12px;
        text-align: center;
        color: #fff;
        font-size: 12px;
    }
    .card-ghost {
        transition: transform 0.18s ease;
        transform: rotateZ(5deg)
    }

    .card-ghost-drop {
        transition: transform 0.18s ease-in-out;
        transform: rotateZ(0deg)
    }

    .drop-preview {
        background-color: rgba(150, 150, 200, 0.1);
        border: 1px dashed #abc;
        margin: 5px;
    }
</style>
复制代码