Omi教程-外掛體系

【當耐特】發表於2017-03-01

外掛體系

Omi是Web元件化框架，怎麼又來了個外掛的概念？

可以這麼理解: Omi外掛體系可以賦予dom元素一些能力，並且可以和元件的例項產生關聯。

omi-drag

且看這個例子:

import OmiDrag from './omi-drag.js';

OmiDrag.init();

class App extends Omi.Component {
    constructor(data) {
        super(data);
    }

    render() {
        return  `
        <div>
            <div omi-drag class="test">Drag Me</div>
        </div>
        `;

    }

    style(){
       return `
        <style>
        .test{
            width:100px;
            height:100px;
            color:white;
            line-height:90px;
            text-align:center;
            background-color:#00BFF3;
        }
        </style>
        `
    }
}

Omi.render(new App(),"#container");

如上面的程式碼所示，通過在div上標記omi-drag，這個div就能夠被使用者使用滑鼠拖拽。我們稱omi-drag.js為omi外掛。
是不是非常方便？那麼這個omi-drag是怎麼實現的？

Omi.extendPlugin

核心方法: Omi.extendPlugin( pluginName, handler )

下面的程式碼就是展示瞭如何通過 Omi.extendPlugin 賦予dom拖拽的能力:

;(function () {

    var OmiDrag = {};
    var Omi = typeof require === 'function'
        ? require('omi')
        : window.Omi;

    OmiDrag.init = function(){
        Omi.extendPlugin('omi-drag',function(dom, instance){
            dom.style.cursor='move';
            var isMouseDown = false,
                preX = null,
                preY = null,
                currentX = null,
                currentY = null,
                translateX = 0,
                translateY = 0;

            dom.addEventListener('mousedown',function(evt){
                isMouseDown = true;
                preX = evt.pageX;
                preY = evt.pageY;
                evt.stopPropagation();
            },false);

            window.addEventListener('mousemove',function(evt){
                if(isMouseDown){
                    currentX = evt.pageX;
                    currentY = evt.pageY;
                    if(preX != null){
                        translateX += currentX - preX;
                        translateY += currentY - preY;
                        dom.style.transform = 'translateX('+translateX+'px) translateY('+translateY+'px)';
                    }
                    preX = currentX;
                    preY = currentY;
                    evt.preventDefault();
                }
            },false);

            window.addEventListener('mouseup',function(){
                isMouseDown = false;
                preX = preY = currentX = currentY = null;
            },false);
        });
    }

    OmiDrag.destroy = function(){
        delete Omi.plugins['omi-drag'];
    };

    if (typeof exports == "object") {
        module.exports = OmiDrag;
    } else if (typeof define == "function" && define.amd) {
        define([], function(){ return OmiDrag });
    } else {
        window.OmiDrag = OmiDrag;
    }

})();

方法: Omi.extendPlugin( pluginName, handler )

其中pluginName為外掛的名稱
其中handler為處理器。handler可以拿到標記了pluginName的dom以及dom所在的元件的例項，即 dom 和 instance。

通過 Omi.extendPlugin，可以賦予dom元素一些能力，也可以和元件的例項(instance)產生關聯。
但是上面的例子沒有和instance產生關聯，我們接下來試試:

關聯instance

我們想在元件裡面能夠監聽到move並且執行回撥。如下:

...
...
moveHandler(){
    console.log('moving');
}

render() {
    return  `
    <div>
        <div omi-drag class="test">Drag Me</div>
    </div>
    `;
}
...

主要被拖動過程中，moveHandler就不斷地被執行。外掛程式碼需要修改:

...
window.addEventListener('mousemove',function(evt){
    if(isMouseDown){
        currentX = evt.pageX;
        currentY = evt.pageY;
        if(preX != null){
            translateX += currentX - preX;
            translateY += currentY - preY;
            dom.style.transform = 'translateX('+translateX+'px) translateY('+translateY+'px)';
        }
        preX = currentX;
        preY = currentY;
        evt.preventDefault();
        instance.moveHandler(evt);
    }
},false);

我們在裡面增加了instance.moveHandler(evt);方法，用來執行元件例項上的moveHandler方法。
這樣的話:就是元件的例項(instance)產生關聯。但是還是有問題？如果標記了多個omi-drag 就會有問題！如:

...
render() {
    return  `
    <div>
        <div omi-drag class="test">Drag Me</div>
        <div omi-drag class="test">Drag Me</div>
    </div>
    `;
}
...

通常我們系統每個omi-drag都能對應一個回撥函式，如：

...
...
moveHandlerA(){
    console.log('moving');
}

moveHandlerB(){
    console.log('moving');
}

render() {
    return  `
    <div>
        <div omi-drag class="test">Drag Me A</div>
        <div omi-drag class="test">Drag Me B</div>
    </div>
    `;
}
...

怎麼辦？怎麼實現？有辦法！通過dom傳遞資料給外掛。

傳遞資料

先來看最後實現的效果:

...
...
moveHandlerA(){
    console.log('moving');
}

moveHandlerB(){
    console.log('moving');
}

render() {
    return  `
    <div>
        <div omi-drag class="test" dragMove="moveHandlerA" >Drag Me A</div>
        <div omi-drag class="test" dragMove="moveHandlerB" >Drag Me B</div>
    </div>
    `;
}
...

omi-drag修改的地方:

...
var handlerName = dom.getAttribute('dragMove');

window.addEventListener('mousemove',function(evt){
    if(isMouseDown){
        currentX = evt.pageX;
        currentY = evt.pageY;
        if(preX != null){
            translateX += currentX - preX;
            translateY += currentY - preY;
            dom.style.transform = 'translateX('+translateX+'px) translateY('+translateY+'px)';
        }
        preX = currentX;
        preY = currentY;
        evt.preventDefault();
        instance[handlerName](evt);
    }
},false);
...

通過 var handlerName = dom.getAttribute('dragMove') 拿到dom上宣告的dragMove
通過 instancehandlerName 去執行對應的方法

點選這裡→線上試試