DIV CSS 佈局教程網

JavaScript 拖放功能的完整實作與鎖定機制
編輯:關於JavaScript     

本文分享一個完整的拖放實作,並在原始範例基礎上重新整理、加上說明,供需要的朋友參考學習。

拖放狀態:未開始

拖放的三個步驟

原理其實很單純:在被拖曳的物件上監聽 mousedown,滑鼠按下時透過事件物件取得座標參數;接著在 document 上監聽 mousemove,讀取 clientX 與 clientY 並據此設定拖曳物件的 left 與 top;最後在 mouseup 時移除這兩個監聽器。

為什麼 mousemove 要掛在 document 而不是物件上?因為滑鼠移動速度可能快過物件本身,若掛在物件上,游標衝出物件範圍就收不到事件,拖曳會中途斷掉。

先掛 mousedown

EventUtil.addEventHandler(this.Drag, "mousedown", BindAsEventListener(this, this.Start));

然後在 Start 中掛上 mousemove 與 mouseup:

//監聽mousemove 和 mouseup事件
EventUtil.addEventHandler(document, "mousemove", this._fM);
EventUtil.addEventHandler(document, "mouseup", this._fS);

移動時設定位置:

if(!this.LockX)this.Drag.style.left = iLeft + "px";
if(!this.LockY)this.Drag.style.top = iTop + "px";

水平與垂直鎖定就是靠 LockX、LockY 兩個旗標決定要不要寫入對應的屬性。而範圍鎖定則是透過容器寬高減去拖曳物件寬高,算出 left 與 top 的上下界,再用 Math.max/Math.min 夾住。

完整 DEMO

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>JavaScript拖放效果</title>
<style type="text/css">
</style>
</head>
<body>
<div id="drag-wrap" style="height: 300px;margin:10px;border:5px solid #FF8000;background:#8080C0;position: relative;">
<div class="draggable" id="drag" style="width:100px;height: 100px;position: absolute;top: 100px;left:100px;background:#eee;border:1px solid #aceaac;cursor: move;">拖動div</div>
</div>

<input id="idReset" type="button" value="復位" />
<input id="idLock" type="button" value="鎖定全部" />
<input id="idLockX" type="button" value="鎖定水平" />
<input id="idLockY" type="button" value="鎖定垂直" />
<input id="idLimit" type="button" value="范圍鎖定" />
<input id="idLimitOff" type="button" value="取消范圍鎖定" />
<br />
拖放狀態:<span id="idShow">未開始</span>

<script type="text/javascript">
/**
 *工具函數
 */
var isIE = (document.all) ? true : false ;
var $$ = function(id){ return "string" == typeof id ? document.getElementById(id) : id; };

var Class = {
    create: function() {
        return function() {
            this.initialize.apply(this, arguments);
        }
    }
};

var Extend = function(destination,source){
    for(var property in source){
        destination[property] = source[property];
    }
};

var BindAsEventListener = function(object,func){
    return function(event){
        return func.call(object,event || window.event);
    }
};

var Bind = function(object,func){
    return function(){
        return func.apply(object,arguments);
    }
};

/**
 *跨浏覽器事件對象
 */
var EventUtil = {
    //事件注冊處理程序
    addEventHandler:function(oTarget,sEventType,fnHandler){
        if(oTarget.addEventListener){
            oTarget.addEventListener(sEventType,fnHandler,false);
        }else if(oTarget.attachEvent){
            oTarget.attachEvent("on"+sEventType,fnHandler);
        }else{
            oTarget["on"+sEventType] = fnHandler;
        }
    },
    //事件移除處理程序
    removeEventHandler:function(oTarget,sEventType,fnHandler){
        if(oTarget.removeEventListener){
            oTarget.removeEventListener(sEventType,fnHandler,false);
        }else if(oTarget.detachEvent){
            oTarget.detachEvent("on"+sEventType,fnHandler);
        }else{
            oTarget["on"+sEventType] = null;
        }
    },
    getEvent:function(event){ return event ? event : window.event; },
    getTarget:function(event){ return event.target || event.srcElement; }
};

/**
 *拖放程序
 */
var Drag= Class.create();

Drag.prototype = {
    //初始化對象
    initialize:function(drag,options){
        this.Drag = $$(drag);//拖放對象
        this._x = this._y = 0;//記錄鼠標相對於拖放對象的位置
        //事件對象(用於綁定移除事件)
        this._fM = BindAsEventListener(this, this.Move);
        this._fS = Bind(this, this.Stop);
        this.Drag.style.position = "absolute";
        this.marginLeft = this.marginTop = 0;//記錄margin

        //設置參數
        this.setOptions(options);

        //獲取相關參數及類型轉換
        this.Limit = !!this.options.Limit;//轉換為布爾型
        this.mxLeft = parseInt(this.options.mxLeft);
        this.mxRight = parseInt(this.options.mxRight);
        this.mxTop = parseInt(this.options.mxTop);
        this.mxBottom = parseInt(this.options.mxBottom);
        this.Lock = !!this.options.Lock;
        this.LockX = !!this.options.LockX;
        this.LockY = !!this.options.LockY;
        this.onStart = this.options.onStart;
        this.onMove = this.options.onMove;
        this.onStop = this.options.onStop;

        this._Handle = $$(this.options.Handle) || this.Drag;
        this._mxContainer = $$(this.options.mxContainer) || null;

        //監聽拖動對象mousedown事件
        EventUtil.addEventHandler(this.Drag, "mousedown", BindAsEventListener(this, this.Start));
    },

    //准備拖動
    Start:function(oEvent){
        if(this.Lock){return;}//如果鎖定則不執行
        //記錄mousedown觸發時鼠標相對於拖放對象的位置
        this._x = oEvent.clientX - this.Drag.offsetLeft;
        this._y = oEvent.clientY - this.Drag.offsetTop;
        //監聽mousemove 和 mouseup事件
        EventUtil.addEventHandler(document, "mousemove", this._fM);
        EventUtil.addEventHandler(document, "mouseup", this._fS);
    },

    //拖動
    Move:function(oEvent){
        //設置移動參數
        var iLeft = oEvent.clientX - this._x , iTop = oEvent.clientY - this._y;

        //設置范圍限制
        if(this.Limit){
            //設置范圍參數
            var mxLeft = this.mxLeft, mxRight = this.mxRight,
                mxTop = this.mxTop, mxBottom = this.mxBottom;
            //如果設置了容器,再修正范圍參數
            if(!!this._mxContainer){
                mxLeft = Math.max(mxLeft, 0);
                mxTop = Math.max(mxTop, 0);
                mxRight = Math.min(mxRight, this._mxContainer.clientWidth);
                mxBottom = Math.min(mxBottom, this._mxContainer.clientHeight);
            };
            //修正移動參數
            iLeft = Math.max(Math.min(iLeft, mxRight - this.Drag.offsetWidth), mxLeft);
            iTop = Math.min(Math.max(iTop, mxTop), mxBottom - this.Drag.offsetHeight);
            iTop = Math.max(Math.min(iTop, mxBottom - this.Drag.offsetHeight), mxTop);
        }

        //XY鎖定
        if(!this.LockX)this.Drag.style.left = iLeft + "px";
        if(!this.LockY)this.Drag.style.top = iTop + "px";

        //執行附加程序
        this.onMove();
    },

    //停止拖動
    Stop:function(){
        EventUtil.removeEventHandler(document, "mousemove", this._fM);
        EventUtil.removeEventHandler(document, "mouseup", this._fS);
        //執行附加程序
        this.onStop();
    },

    //設置默認參數
    setOptions:function(options){
        this.options = {//默認值
            Handle: "",       //設置觸發對象(不設置則使用拖放對象)
            Limit: false,     //是否設置范圍限制(為true時下面參數有用,可以是負數)
            mxLeft: 0,        //左邊限制
            mxRight: 9999,    //右邊限制
            mxTop: 0,         //上邊限制
            mxBottom: 9999,   //下邊限制
            mxContainer: "",  //指定限制在容器內
            LockX: false,     //是否鎖定水平方向拖放
            LockY: false,     //是否鎖定垂直方向拖放
            Lock: false,      //是否鎖定
            Transparent: false,//是否透明
            onStart: function(){},//開始移動時執行
            onMove: function(){}, //移動時執行
            onStop: function(){}  //結束移動時執行
        };
        Extend(this.options, options || {});
    }
};

//初始化拖動對象
var drag = new Drag('drag',{
    mxContainer:'drag-wrap',
    Limit:true,
    onStart: function(){ $$("idShow").innerHTML = "開始拖放"; },
    onMove: function(){ $$("idShow").innerHTML = "left:"+this.Drag.offsetLeft+";top:"+this.Drag.offsetTop; },
    onStop: function(){ $$("idShow").innerHTML = "結束拖放"; }
});

$$("idReset").onclick = function(){
    drag.Limit = true;
    drag.mxLeft = drag.mxTop = 0;
    drag.mxRight = drag.mxBottom = 9999;
    drag.LockX = drag.LockY = drag.Lock = false;
    $$("idShow").innerHTML = "復位";
}
$$("idLock").onclick = function(){ drag.Lock = true; $$("idShow").innerHTML = "鎖定全部"; }
$$("idLockX").onclick = function(){ drag.LockX = true; $$("idShow").innerHTML = "鎖定水平"; }
$$("idLockY").onclick = function(){ drag.LockY = true; $$("idShow").innerHTML = "鎖定垂直"; }
$$("idLimit").onclick = function(){ drag.mxRight = drag.mxBottom = 200; drag.Limit = true; $$("idShow").innerHTML = "范圍鎖定"; }
$$("idLimitOff").onclick = function(){ drag.Limit = false; $$("idShow").innerHTML = "取消范圍鎖定"; }
</script>
</body>
</html>

幾個值得注意的實作細節

為什麼要記 this._x 與 this._y。滑鼠按下時,游標不一定落在拖曳物件的左上角。若直接用 clientX 當作 left,物件會突然跳一下。程式把「游標位置減去物件目前位置」存成偏移量,移動時再用「游標位置減去偏移量」,物件就能保持按下時的相對位置平順移動。

拖曳物件必須是定位元素。initialize 中強制設了 position = "absolute"。若元素是 static,left/top 完全不生效。

範圍計算用 offsetWidth 而非 clientWidth。offsetWidth 含邊框,用來算「物件實際佔據的視覺寬度」才準確。

拖曳期間應防止選取文字。實作時若不加處理,快速拖曳會把頁面上的文字反白選起來。可在 Start 中 return false 阻止預設行為,或在拖曳期間暫時設 body 的 user-select: none。

現代做法的建議

這份程式碼是為 IE6/7 時代設計的,其中的 attachEvent 分支、document.all 判斷在今日都可移除。若要在新專案中實作拖放,有三個更好的選擇:

一是使用原生 HTML5 Drag and Drop API(draggable 屬性加上 dragstart、dragover、drop 事件),它天生支援鍵盤與觸控以外的無障礙情境,但對「自由位置拖曳」支援不佳。

二是使用 Pointer Events(pointerdown、pointermove、pointerup),它能統一處理滑鼠、觸控與手寫筆,不必再分別綁 mouse 與 touch 事件:

const box = document.getElementById('drag');

box.addEventListener('pointerdown', (e) => {
    const startX = e.clientX - box.offsetLeft;
    const startY = e.clientY - box.offsetTop;
    box.setPointerCapture(e.pointerId);   // 游標衝出元素也能持續收到事件

    const onMove = (ev) => {
        box.style.left = (ev.clientX - startX) + 'px';
        box.style.top  = (ev.clientY - startY) + 'px';
    };
    const onUp = () => {
        box.removeEventListener('pointermove', onMove);
        box.removeEventListener('pointerup', onUp);
    };
    box.addEventListener('pointermove', onMove);
    box.addEventListener('pointerup', onUp);
});

setPointerCapture 是關鍵,它取代了「把監聽器掛到 document 上」這個繞路做法。

三是在需要複雜拖放邏輯(排序、跨容器投放、動畫)時直接採用成熟函式庫,例如 SortableJS 或 dnd-kit,能省下大量邊界處理的功夫。

以上就是 JavaScript 拖放效果的完整程式碼與解析,希望對你的學習有所幫助。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved