Vue3問題:如何實現組件拖拽實時預覽功能?
本文主要內容分三部分,第一部分是需求分析,第二部分是實現步驟,第三部分是問題詳解。
如果您只需要解決問題,請閱讀第一、二部分即可。
如果您有更多時間,進一步學習問題相關知識點,請閱讀至第三部分。
1、需求分析
實現一個CMS內容管理系統,在后臺進行內容編輯,在官網更新展示內容。
關于后臺的編輯功能,大致分為兩部分:組件拖拽預覽、組件內容編輯實時預覽。
對于組件拖拽預覽,用戶可以在含有各種功能組件的列表中,選擇需要的組件進行拖拽。將組件拖拽到預覽畫布中后,可以在畫布中預覽組件的內容。
對于組件內容編輯實時預覽,用戶可以點擊編輯按鈕,顯示對應組件的內容編輯信息。當修改組件內容時,在畫布中可以實時預覽組件的變化。
2、實現步驟
(1)關于拖拽組件庫的選擇
關于拖拽組件庫,在github上有很多,最熱門的當屬vuedraggable這個庫。
它基于Sortable.js,擁有完整的中文文檔,所以很多朋友在做拖拽功能時,都會優先考慮它。
但是,我在使用的過程中,在組件拖拽、取消組件拖拽這里,遇到了一些小問題。不知道是我操作的問題,還是庫本身存在BUG,所以最終沒有選用它。
于是我發現了,一個更加好用的拖拽庫vue-draggable-next。
它的出現是參考了vuedraggable這個庫,所以說很多用法很相似,但是使用起來較之更加友善。總結為一個詞,自由。
下面我們的拖拽功能實現,就是利用了vue-draggable-next這個庫。
如果你對拖拽底層原理感興趣,并且有空余時間,勞請閱至第三部分拖拽原理總結。
(2)拖拽功能代碼實例
模版和邏輯中代碼都分為了三部分:組件列表、預覽畫布、內容編輯。
布局時,樣式根據需求自定義,此處只是提供了功能的基本邏輯實現。
使用時,關于拖拽組件的需求,根據文檔中提供的屬性和事件的描述,靈活配置完善。
vue-draggable-next庫文檔地址:https://github.com/anish2690/vue-draggable-next。
安裝依賴:
npm install vue-draggable-next
//or
yarn add vue-draggable-next
模板代碼:
<template>
<div style="display: flex;cursor: pointer;">
<!-- 組件列表 左側 -->
<div style="width:30vw;padding:30px;height:300px;border: 1px solid #000;text-align: center">
<h1>組件列表</h1>
<VueDraggableNext :list="componentNameList" :group="{ name: 'people', pull: 'clone', put: false }" :sort="false">
<div v-for="element in componentNameList" :key="element.name">
<div style="padding: 10px;background: #ccc;margin-bottom: 10px">
<el-button> {{ element.name }}</el-button>
</div>
</div>
</VueDraggableNext>
</div>
<!-- 預覽畫布 中間 -->
<div style="width:30vw;padding:30px;height:300px;border: 1px solid #000;text-align: center">
<h1>預覽畫布</h1>
<VueDraggableNext :list="componentList" group="people" :sort="false">
<div v-for="(element, index) in componentList" :key="element.name">
<div>
<el-button @click="changeComponent(element)" size="small">編輯</el-button>
<el-button @click="deleteComponent(index)" size="small">刪除</el-button>
</div>
<component :is="element.component" :details="element.details"></component>
</div>
</VueDraggableNext>
</div>
<!-- 內容編輯 右側 -->
<div style="width:30vw;padding:30px;height:300px;border: 1px solid #000;text-align: center">
<h1>內容編輯</h1>
<div v-for="(nowDetails, index) in nowComponentDetail.details" :key="index">
{{ nowDetails.key }}: <el-input clearable v-model="nowDetails.value" />
</div>
</div>
</div>
</template>
邏輯代碼:
<script setup>
import {markRaw, reactive, ref, watch, nextTick} from "vue";
// 引入需要拖拽的組件
import About from "@/views/AboutView.vue"
// 引入拖拽庫
import { VueDraggableNext } from "vue-draggable-next";
// 組件列表數據
const componentNameList = [
{
// 組件ID
componentId:0,
// 組件名
name:'關于組件',
// 組件描述
description: '關于組件',
// 組件信息
component: markRaw(About),
// 組件需要編輯內容
details: About.props.details.default
},
{
componentId:1,
name:'關于組件1',
description: '關于組件1',
component:markRaw(About),
details: About.props.details.default
},
];
// 預覽畫布數據
let componentList = reactive([]);
watch(componentList, () => {
console.log(componentList, 'componentList')
})
// 畫布中刪除的點擊事件
const deleteComponent = (index) => {
componentList.splice(index, 1);
};
// 內容編輯數據
let nowComponentDetail = ref({});
// 畫布中編輯的點擊事件
const changeComponent = (element) => {
nowComponentDetail.value = element;
};
</script>
(3)功能組件代碼實例(參考)
此處提供了組件列表中,任意功能組件的編寫實例,組件的具體功能根據需求自定義。
特別注意,組件Props中details對象屬性的結構寫法,要靈活應用。
模版代碼:
<template>
<div style="padding: 10px;background: pink;margin-bottom: 10px">
{{ props.details.content }}
</div>
</template>
邏輯代碼:
<script setup>
import { defineProps } from "vue";
const props = defineProps({
details: {
type: Object,
default: {
content: {
key: '內容',
value: "我是About",
},
}
}
})
</script>
3、問題詳解
(1)拖拽實現的底層原理
拖拽的實現原理可以簡單描述為以下幾個步驟:
- 觸發拖拽:通過監聽鼠標或觸摸事件,當用戶按下鼠標左鍵或觸摸屏幕時,表示開始拖拽操作。
- 記錄拖拽信息:在拖拽開始時,記錄拖拽起始位置(鼠標或觸摸點的坐標),以及需要拖拽的元素的初始位置(相對于文檔的坐標)。
- 更新拖拽元素位置:在拖拽過程中,通過監聽鼠標移動或觸摸滑動事件,計算鼠標或觸摸點的當前位置,并根據鼠標或觸摸點的位置變化,更新拖拽元素的位置。這可以通過修改元素的 CSS 屬性(如 left 和 top)或使用 CSS 變換(如 translateX 和 translateY)來實現。
- 處理拖拽結束:當用戶釋放鼠標左鍵或觸摸結束時,表示拖拽結束。此時可以執行一些操作,如更新拖拽元素的最終位置、觸發事件或回調函數等。
以下是拖拽實現的基本原理代碼實例:
// 獲取拖拽元素
const draggableElement = document.getElementById('draggable');
// 記錄拖拽起始位置和拖拽元素的初始位置
let startX, startY, initialX, initialY;
// 監聽鼠標按下事件
draggableElement.addEventListener('mousedown', dragStart);
draggableElement.addEventListener('touchstart', dragStart);
// 監聽鼠標移動事件
document.addEventListener('mousemove', drag);
document.addEventListener('touchmove', drag);
// 監聽鼠標釋放事件
document.addEventListener('mouseup', dragEnd);
document.addEventListener('touchend', dragEnd);
// 拖拽開始事件處理程序
function dragStart(event) {
event.preventDefault();
if (event.type === 'touchstart') {
startX = event.touches[0].clientX;
startY = event.touches[0].clientY;
} else {
startX = event.clientX;
startY = event.clientY;
}
initialX = draggableElement.offsetLeft;
initialY = draggableElement.offsetTop;
}
// 拖拽事件處理程序
function drag(event) {
event.preventDefault();
if (event.type === 'touchmove') {
const currentX = event.touches[0].clientX - startX;
const currentY = event.touches[0].clientY - startY;
draggableElement.style.left = initialX + currentX + 'px';
draggableElement.style.top = initialY + currentY + 'px';
} else {
const currentX = event.clientX - startX;
const currentY = event.clientY - startY;
draggableElement.style.left = initialX + currentX + 'px';
draggableElement.style.top = initialY + currentY + 'px';
}
}
// 拖拽結束事件處理程序
function dragEnd() {
// 執行拖拽結束后的操作
}
(2)關于vue-draggable-next 庫的功能總結
vue-draggable-next 庫特點和功能的補充說明:
- 基于 Vue 3:vue-draggable-next 是為 Vue.js 3 版本設計的拖拽庫,充分利用了 Vue 3 的響應式系統和組合式 API。
- 輕量級和簡單易用:該庫的代碼量較少,易于理解和使用。它提供了一組簡單的指令和組件,可以輕松地將拖拽功能集成到 Vue.js 應用程序中。
- 支持多種拖拽模式:vue-draggable-next 支持多種拖拽模式,包括自由拖拽、列表拖拽、網格拖拽等。您可以根據需求選擇適合的拖拽模式。
- 自定義拖拽樣式和行為:該庫允許您自定義拖拽元素的樣式和行為。您可以定義拖拽時的樣式、占位符元素、限制拖拽的范圍等。
- 事件和回調支持:vue-draggable-next 提供了一組事件和回調函數,可以在拖拽過程中監聽和處理各種事件。例如,您可以監聽拖拽開始、拖拽結束、拖拽元素排序等事件,并執行相應的操作。
- 支持觸摸設備:該庫對觸摸設備提供了良好的支持,可以在移動設備上實現流暢的拖拽交互。