MVVM 式的热区组件开发

时间 2019-11-26

标签 mvvm 组件开发繁體版

原文原文链接

1. 什么是热区

热区，是指在一张图片上选取一些区域，每一个区域连接到指定的地址。css

所以热区组件的功能，就是在图片上设置多个热区区域并配置相应的数据。html

2. 热区功能介绍

热区须要实现的功能为：git

建立新热区区域；
热区大小可调整；
热区位置可更改；
热区数据可设置；
设置数据可显示。github
- 试试实际效果：戳我
- 具体项目代码：戳我

3. 实现手段与结构划分

若是你在公司里听到有人在讨论 MVVM，那么话题必定离不开 RegularJS。npm

因此这里以 RegularJS 为例对主题进行介绍（但如果用 Vue 在实现上区别其实也不大）：bash

MVVM 讲究以数据驱动视图，然而热区这类场景须要须要大量的 DOM 操做。框架

还好，AngularJS、VueJS 和 RegularJS 等框架都提供了自定义指令（directive，写法及用法上大同小异），方便开发者对纯 DOM 元素进行底层操做。dom

也避免了在节点上大量的挂载 on- 开头的属性：ide

<!-- not so good -->
<div on-keydown={this.handleKeyDown($event)}></div>

<!-- better -->
<div r-keydown></div>复制代码

由上可知，热区组件重度依赖指令，则代码结构最终设定为：函数

src
 ├── assets
 │      ├── directive
 │      │     ├── addItem.js        添加热区指令
 │      │     ├── changeSize.js     改变尺寸指令
 │      │     ├── dragItem.js       移动位置指令
 │      │     ├── resizeImg.js      图片resize处理指令
 │      │     └── ...
 │      ├── constant.js             通用常量
 │      ├── filter.js               过滤器
 │      ├── operations.js           处理逻辑封装
 │      └── util.js                 工具函数
 ├── components
 │      ├── modal                   数据设置模态窗组件
 │      └── zone                    热区区域组件
 ├── mcss
 │      ├── _reset.mcss             限定做用范围的样式 reset
 │      └── index.mcss              基本样式
 ├── index.js                       组件入口
 └── view.html                      组件模板复制代码

4. 相关指令介绍

指令通常须要返回一个函数用于指令销毁工做。

Question: 为何要返回销毁函数，而不是经过监听 $destroy 事件来完成？

Answer: 由于指令的销毁并不必定伴随着组件销毁，指令的生命周期更短，一些语法元素（if/list/include）会致使它在组件销毁以前被重复建立和销毁。

因为热区组件使用了较多的事件监听，基于上述考虑，热区操做指令中都返回了用于 事件解绑 的函数。

新增热区区域、拖拽热区位置和调整热区大小指令，都存在三个操做阶段：

mousedown: 鼠标选中；
mousemove: 移动鼠标，此时经过 js 动态改变元素的样式，但并不对真实数据作修改；
mouseup: 释放鼠标，将改动保存到真实数据中。

import { dom } from 'regularjs';

export default function (content) {

    dom.on(content, 'mousedown', handleMouseDown);

    function handleMouseDown(e) {
        // ...

        dom.on(window, 'mousemove', handleChange);
        dom.on(window, 'mouseup', handleMouseUp);

        function handleChange(e) {
            // ...
        };

        function handleMouseUp() {
            // ...

            dom.off(window, 'mousemove', handleChange);
            dom.off(window, 'mouseup', handleMouseUp);
        };
    }

    return () => {
        // 解绑 mousedown 事件
        dom.off(content, 'mousedown', handleMouseDown);
    };
}复制代码

这里能够作些优化：

在 changeSize 时对可拖拽点的事件监听上，利用「事件委托」+「自定义属性」减小事件绑定，并统一处理不一样方位的拖拽点：

如图所示，热区区域周围的八个小方块就是「拖拽点」。

<ul r-changeSize>
    <li class="hz-u-square hz-u-square-tl" data-pointer="dealTL"></li>
    <li class="hz-u-square hz-u-square-tc" data-pointer="dealTC"></li>
    <li class="hz-u-square hz-u-square-tr" data-pointer="dealTR"></li>
    <li class="hz-u-square hz-u-square-cl" data-pointer="dealCL"></li>
    <li class="hz-u-square hz-u-square-cr" data-pointer="dealCR"></li>
    <li class="hz-u-square hz-u-square-bl" data-pointer="dealBL"></li>
    <li class="hz-u-square hz-u-square-bc" data-pointer="dealBC"></li>
    <li class="hz-u-square hz-u-square-br" data-pointer="dealBR"></li>
</ul>复制代码

function handleMouseDown(e) {
    // 获取选中节点的自定义属性值
    let pointer = e.target.dataset.pointer;
    if(!pointer) {
        return;
    }
    e && e.stopPropagation();

    dom.on(window, 'mousemove', handleChange);
    dom.on(window, 'mouseup', handleMouseUp);

    function handleChange(e) {
        e && e.preventDefault();

        // 处理选中不一样拖拽点时的状况
        let styleInfo = operations[pointer](itemInfo, moveX, moveY);

        // 边界值处理
        itemInfo = operations.dealEdgeValue(itemInfo, styleInfo, container);

        // ...
    }
    function handleMouseUp() {
        // ...

        dom.off(window, 'mousemove', handleChange);
        dom.off(window, 'mouseup', handleMouseUp);
    }
};复制代码

统一封装 operations 处理逻辑：

export default {
    /** * 改变热区大小时的边界状况处理 * @param {Object} itemInfo 实际使用的热区模块数据 * @param {Object} styleInfo 操做中的热区模块数据 * @param {Object} container 图片区域的宽高数据 */
    dealEdgeValue(itemInfo, styleInfo, container) {},
    /** * 处理不一样的拖拽点，大写字母表示含义：T-top，L-left，C-center，R-right，B-bottom * @param {Object} itemInfo * @param {Number} moveX * @param {Number} moveY * @return {Object} 对过程数据进行处理 */
    dealTL(itemInfo, moveX, moveY, minLimit = MIN_LIMIT) {},
    dealTC(itemInfo, moveX, moveY, minLimit = MIN_LIMIT) {},
    dealTR(itemInfo, moveX, moveY, minLimit = MIN_LIMIT) {},
    dealCL(itemInfo, moveX, moveY, minLimit = MIN_LIMIT) {},
    dealCR(itemInfo, moveX, moveY, minLimit = MIN_LIMIT) {},
    dealBL(itemInfo, moveX, moveY, minLimit = MIN_LIMIT) {},
    dealBC(itemInfo, moveX, moveY, minLimit = MIN_LIMIT) {},
    dealBR(itemInfo, moveX, moveY, minLimit = MIN_LIMIT) {}
};复制代码

在拖拽移动热区位置时，使用 translate 替代直接改变 top && left 值避免重绘，实现更流畅的拖拽效果。

// bad
dom.css(elem, {
    top: `${moveY}px`,
    left: `${moveX}px` 
});

// better
dom.css(elem, {
    transform: `translate(${moveX}px, ${moveY}px)` 
});复制代码

热区尺寸单位用 % 取代 px，不一样屏幕尺寸的用户都得到更好的热区操做体验。

但热区区域存在最小尺寸限制，须要利用 element-resize-detector 对图片进行监听，在图片尺寸变化时对边界区域作兼容。

import elementResizeDetectorMaker from 'element-resize-detector';
const erd = elementResizeDetectorMaker();

export default function resizeImg(elem) {
    // ...

    const resize = _.debounce(() => {
        // ...
    }, 500);

    erd.listenTo(elem, resize);

    return () => {
        erd.removeListener(elem, resize);
    };
};复制代码

经过计算属性动态修改设置数据的 hover 位置，确保不超过图片范围，以确保信息的正确显示。

<ul r-style={{top: infoTop, bottom: infoBottom, left: infoLeft, right: infoRight, transform: infoTransform}}></ul>复制代码

5. 体验加强

使用透明小方块加强鼠标从热区区域移动到设置信息区域的体验：

hideblock

（这里用灰色标识一下小方块）
双击热区区域弹出信息设置模态框时，利用 r-autofocus 指令自动聚焦：

modal

同时绑定键盘监听事件，监听 Enter 键和 Esc 键，加强「确认」和「取消」体验。

6. 其余总结

不管 reset（容易遗漏）或基础样式，都须要限制 scope，避免命名空间污染；
统一控制 Constant 全局常量，如最小热区尺寸限制。