Element Tooltip组件的限制使用的工具函数

需求描述

需求:

页面已经写了太多的详情表单元素，并且每一个表单元素都使用了Tooltip组件来包裹，这样是不符合需求的，因为用户需要限定当表单元素的文本太多时，也就是说出现了省略号才会出现Tooltip组件的包裹。比如项目采用的 element UI 组件库。在一个页面有太多的这样的表单元素:

<el-form>
   <el-form-item label="姓名" prop="name">
       <el-tooltip :content="form.name">
           <el-input v-model="form.name" disabled="true"></el-input>
       </el-tooltip>
   </el-form-item>
   .....后续出现多个这样的元素
</el-form>

如果我每一个都加disabled属性，那么页面模板元素有将近一百个，很显然我这样加是很耗费时间的，很显然对于追求高效的我是不喜欢一个一个加，然后一个一个判断的。

在这之前，我们需要确定一点，那就是我们控制文本的截断是通过 CSS 代码来实现的。也就是如下这段代码:

.el-input {
    text-overflow:ellipsis;
    white-space:nowrap;
    overflow:hidden;
}

因此，完成以上的需求的第一步就是需要先判断哪些元素满足被截断的条件。那么如何判断文本是否被截断呢？关于这个实现，我想element ui的表格组件符合这种场景，所以我只需要去参考一下element ui的表格组件的截断判断实现就知道了。没错，我在源码中找到了实现方式。

创建 range 元素

核心思路就是创建一个range元素，通过获取range元素width，然后与元素的offsetWidth进行判断就行了。所以，我按照 element-ui 的实现思路完成了这个工具函数。如下所示:

function isTextOverflow(element) {
    // use range width instead of scrollWidth to determine whether the text is overflowing
    // to address a potential FireFox bug: https://bugzilla.mozilla.org/show_bug.cgi?id=1074543#c3
    if (!element || !element.childNodes || !element.childNodes.length) {
        return false;
    }
    const range = document.createRange();
    range.setStart(element, 0);
    range.setEnd(element, element.childNodes.length);
    const rangeWidth = range.getBoundingClientRect().width;
    // if the element has padding style,should add the padding value.
    const padding = (parseInt(getStyle(element, 'paddingLeft'), 10) || 0) + (parseInt(getStyle(element, 'paddingRight'), 10) || 0);
    return rangeWidth + padding > element.offsetWidth || element.scrollWidth > element.offsetWidth;
}
function hasClass(el, cls) {
    if (!el || !cls) {
        return false;
    }
    if (cls.indexOf(" ") > -1) {
        return console.error(`className should not contain space!`);
    }
    if (el.classList) {
        return el.classList.contains(cls);
    } else {
        return (" " + el.className + " ").indexOf(" " + cls + " ") > -1;
    }
}
function camelCase(name) {
    return name.replace(/([\:\_\-]+(.))/g, (_, separator, letter, offset) => offset ? letter.toUpperCase() : letter).replace(/^moz([A-Z])/, "Moz$1")
}
// IE version more than 9
function getStyle(el, styleName) {
    if (!element || !styleName) return null;
    styleName = camelCase(styleName);
    if (styleName === 'float') {
        styleName = 'cssFloat';
    }
    try {
        var computed = document.defaultView.getComputedStyle(element, '');
        return element.style[styleName] || computed ? computed[styleName] : null;
    } catch (e) {
        return element.style[styleName];
    }
}

收集所有的 tooltip 组件实例

这只是完成了第一步，接下来是第二步，就是我需要将页面上所有包含 tooltip 组件的 vue 组件实例都要收集起来。首先我们可以确定页面所有的 toolTip 组件实例应该都是当前这个表单组件实例的所有子组件，因此，我想到了递归去收集所有包含 tooltip 组件的组件实例。代码如下:

export function findToolTip(children,tooltips = []){
    //这里写代码
}

所有的 tooltip 组件实例都是 vue 组件实例的子组件，所以我们可以知道我们去循环组件实例的子组件，即vm.$children属性。然后 tooltip 组件有什么标志呢？或者说我们如何判断该子组件实例就是一个 tooltip 组件呢？我又参考了element ui tooltip组件的实现，发现element ui tooltip组件都会有一个doDestory方法。所以我们就可以根据这个来做判断。所以递归方法，我们就可以写好了。如下:

//参数 1：子组件实例数组
//参数 2：收集组件实例的数组
export function findToolTip(children,tooltips = []){
    for(let i = 0,len = children.length;i < len;i++){
        //递归条件
        if(Array.isArray(children[i]) && children[i].length){
            findToolTip(children[i],tooltips);
        }else{
            //判断如果 doDestroy 属性是一个方法，则代表是一个 tooltip 组件，添加到数组中
            if(typeof children[i].doDestroy === "function"){
                tooltips.push(children[i]);
            }
        }
    }
    //把收集到的组件实例返回
    return tooltips;
}
//调用方式，传入当前组件实例 this 对象的所有子组件实例
//如:findToolTip(this.$children)

我们找到所有 tooltip 组件实例了，接下来，我们要遍历它，然后判断是否符合截断条件，不符合我们就需要将组件给销毁，事实上，我们直接设置 tooltip 组件实例的disabled属性为true就可以了。接下来，就是这个工具函数的实现了。如下:

// 参数 1:当前组件实例 this 对象
// 参数 2:用于获取被 tooltip 包裹的子元素的类名
export function isShowToolTip(vm,className="el-input"){
    //这里写代码
}

如何修改 tooltip 组件?

接下来，我们就要实现这个工具函数。首先，我们需要确定的是，因为 disabled 是 props 数据，props 是单向数据流，vue.js 是不建议我们直接修改的，那么我们应该如何做到设置 disabled 呢？我想了很久，想的办法就是重新渲染整个组件，利用Vue.compie API也就是编译 API 直接重新编译整个 tooltip 组件，然后替换原本渲染的 tooltip 组件。如下:

const res = Vue.compile(`<el-tooltip disabled><el-input value="${ child && child.innerText }" disabled></el-input></el-tooltip>`);
const reRender = new Vue({
    render:res.render,
    staticRenderFns:res.staticRenderFns
}).$mount(parent);//parent 为获取的 tooltip 组件实例根元素

所以，接下来在工具函数里，我们可以这样实现：

// 参数 1:当前组件实例 this 对象
// 参数 2:用于获取被 tooltip 包裹的子元素的类名
export function isShowToolTip(vm,className="el-input"){
    //为了确保能够获取到 DOM 元素，需要调用一次 nextTick 方法
    vm.$nextTick(() => {
        const allTooltips = findToolTip(vm.$children);
        allTooltips.forEach(item => {
            //获取子元素
            const child = item.$el.querySelector("." + className);
            //判断是否被截断
            if(!isTextOverflow(child)){
                //获取渲染元素
                const parent = item.$el;
                const res = Vue.compile(`<el-tooltip disabled><el-input value="${ child && child.innerText }" disabled></el-input></el-tooltip>`);
                const reRender = new Vue({
                    render:res.render,
                    staticRenderFns:res.staticRenderFns
                }).$mount(parent);
            }
        })
    }};
}

如何使用这个工具函数?

如此一来，就做到了一个方法完成了以上的需求。如何使用这个方法呢，很简单，我们可以在详情组件里面监听表单详情数据的变化。如:

watch:{
    form(val){
        if(typeof val === "object" && val && Object.keys(val).length){
            //将 this 当做参数传入即可
            isShowToolTip(this);
        }
    }
}

以上就是我对于这个需求的实现方法，如大家有更好的方法，望不吝赐教，感谢阅读。

原文：点击这里