参考资料

element中利用tooltip实现文字超出框悬浮显示

vue自定义指令

vue自定义指令,表格内文字超出显示提示tooltip

问题

最近ui提了一个优化问题,就是文本超出的时候才显示title提示?

方法一:结合el-tooltip编写公共组件

1、先编写一个公共组件TextOverTooltip.vue

大致的实现思路:利鼠标移动到标签之上时,判断文字内容的宽度是否大于父级的宽度,来判断是否需要title提示

<template>
  <div class="text-over-tooltip-components">
    <el-tooltip :effect="effect" :disabled="isDisabledTooltip" :content="content" :placement="placement">
      <div class="ellipsis" :class="className" @mouseover="onMouseOver(refName)">
        <span :ref="refName">{{content}}</span>
      </div>
    </el-tooltip>
  </div>
</template>

<script>
export default {
  name: 'TextOverTooltip',
  props: {
    // 显示的文字内容
    content: String,
    // 设置父元素的样式:比如宽度字体等,需可以自己在组件内部配置样式比如字体大小20:fs20
    className: String,
    // 子元素标识(如在同一页面中调用多次组件,此参数不可重复)
    refName: String,
    // 默认提供的主题 dark/light
    effect: {
      type: String,
      default: () => {
        return 'dark';
      }
    },
    // Tooltip 的出现位置top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end
    placement: {
      type: String,
      default: () => {
        return 'bottom';
      }
    },
  },
  data() {
    return {
      isDisabledTooltip: true // 是否需要禁止提示
    };
  },
  methods: {
    // 移入事件: 判断内容的宽度contentWidth是否大于父级的宽度
    onMouseOver(str) {
      let parentWidth = this.$refs[str].parentNode.offsetWidth;
      let contentWidth = this.$refs[str].offsetWidth;
      // 判断是否禁用tooltip功能
      this.isDisabledTooltip = contentWidth <= parentWidth;
    }
  }
};
</script>

<style lang="scss" scoped>
.text-over-tooltip-components{
  /* 文字超出宽度显示省略号 单行 */
  .ellipsis {
    overflow: hidden;
    text-overflow: ellipsis;
    white-space: nowrap
  }
  /* 自定义样式 */
  .fs20 {
    font-size: 20px;
    font-weight: 600;
    color: green;
    line-height: 22px;
  }
  .fs12 {
    font-size: 12px;
    font-weight: 400;
    color: orange;
    line-height: 14px;
  }
}
</style>

2、使用TextOverTooltip.vue的例子

引入import TextOverTooltip from '@/components/TextOverTooltip.vue';

<text-over-tooltip refName="testName1" className="fs20" content="葫芦娃,葫芦娃, 一根藤上七朵花。风吹雨打,都不怕,啦啦啦啦。叮当当咚咚当当,葫芦娃,叮当当咚咚当当,本领大,啦啦啦啦。"></text-over-tooltip>

<text-over-tooltip refName="testName2" className="fs12" content="葫芦娃,葫芦娃,本领大。葫芦娃,葫芦娃, 一根藤上七朵花。风吹雨打,都不怕,啦啦啦啦。"></text-over-tooltip>

3、效果

出现了省略号的才会有提示出来。

090101

方法二:vue自定义v-tooltip指令实现

如果觉得方法一的组件使用比较麻烦,不太灵活的话,不妨试试自定义指令实现。

自定义指令

除了核心功能默认内置的指令 (v-model 和 v-show),Vue 也允许注册自定义指令。注意,在 Vue2.0 中,代码复用和抽象的主要形式是组件。然而,有的情况下,你仍然需要对普通 DOM 元素进行底层操作,这时候就会用到自定义指令。

钩子函数

一个指令定义对象可以提供如下几个钩子函数 (均为可选):

  • bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。
  • inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。
  • update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。
  • componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。
  • unbind:只调用一次,指令与元素解绑时调用。

钩子函数参数:

指令钩子函数会被传入以下参数:

  • el:指令所绑定的元素,可以用来直接操作 DOM。
  • binding:一个对象,包含以下 property:
    • name:指令名,不包括 v- 前缀。
    • value:指令的绑定值,例如:v-my-directive="1 + 1" 中,绑定值为 2。
    • oldValue:指令绑定的前一个值,仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。
    • expression:字符串形式的指令表达式。例如 v-my-directive="1 + 1" 中,表达式为 “1 + 1”。
    • arg:传给指令的参数,可选。例如 v-my-directive:foo 中,参数为 “foo”。
    • modifiers:一个包含修饰符的对象。例如:v-my-directive.foo.bar 中,修饰符对象为 { foo: true, bar: true }
  • vnode:Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
  • oldVnode:上一个虚拟节点,仅在 updatecomponentUpdated 钩子中可用。

思路:

  • 问题:想实现一个在元素上使用的指令v-tooltip,实现文本溢出的时候才显示title
  • 重点:在componentUpdated钩子函数里实现el的宽度以及文本宽度的对比
  • 1、第1步:先要创建一个容器span去获取文本的宽度
  • 2、第2步:用获取到的宽跟el的宽进行对比,如果文本字体大于当前el元素的宽度,则需要title提示
  • 3、第3步:监听elonmouseenter以及onmouseleave的鼠标移入移出事件
  • 4、第4步:鼠标移入onmouseenter事件里需要处理title提示的显示
  • 5、第5步:鼠标移出onmouseleave需要移出title显示的元素
  • 6、第6步:解绑移除浮层元素

实现

Window.getComputedStyle()方法返回一个对象,该对象在应用活动样式表并解析这些值可能包含的任何基本计算后报告元素的所有CSS属性的值。 私有的CSS属性值可以通过对象提供的API或通过简单地使用CSS属性名称进行索引来访问。Window.getComputedStyle()

1、编写指令文件./assets/directive/tooltip.js

export default {
  // 指令所在组件的 VNode 及其子 VNode 全部更新后调用
	componentUpdated (el) {
    console.log(...arguments);
    /* 第1步:先要创建一个容器`span`去获取文本的宽度 */
    // 获取当前元素的style
    const curStyle = window.getComputedStyle(el, '');
    // 创建一个容器来记录文字的width
	  const textSpan = document.createElement('span');
	  // 设置新容器的字体样式,确保与当前需要隐藏的样式相同
	  textSpan.style.fontSize = curStyle.fontSize;
	  textSpan.style.fontWeight = curStyle.fontWeight;
	  textSpan.style.fontFamily = curStyle.fontFamily;
	  // 将容器插入body,如果不插入,offsetWidth为0
	  document.body.appendChild(textSpan);
	  // 设置新容器的文字
	  textSpan.innerHTML = el.innerText;
    // 如果字体元素大于当前元素,则需要隐藏
    /* 第2步:用获取到的宽跟`el`的宽进行对比,如果文本字体大于当前`el`元素的宽度,则需要title提示
     * 第3步:监听`el`的`onmouseenter`以及`onmouseleave`的鼠标移入移出事件
     */
	  if (textSpan.offsetWidth > el.offsetWidth) {
	    // 给当前元素设置超出隐藏
	    el.style.overflow = 'hidden';
	    el.style.textOverflow = 'ellipsis';
	    el.style.whiteSpace = 'nowrap';
	    // 鼠标移入
	    el.onmouseenter = (e) => {
        console.log(e);
        /* 第4步:鼠标移入`onmouseenter`事件里需要处理title提示的显示 */ 
	      // 创建浮层元素并设置样式
	      const kxmTooltipDom = document.createElement('div');
        kxmTooltipDom.style.cssText = `
          display: inline-block;
          max-width: 400px;
	        max-height: 400px;
          position: absolute;
	        top: ${e.clientY + 5}px;
          left: ${e.clientX}px;
          padding: 10px;
          overflow: auto;
          font-size: 14px;
	        color: #fff;
	        background: rgba(0, 0 , 0, .6);
	        border-radius: 5px;
	        z-index: 19999
	      `;
	      // 设置id方便寻找
	      kxmTooltipDom.setAttribute('id', 'kxm-tooltip');
	      // 将浮层插入到body中
	      document.body.appendChild(kxmTooltipDom);
	      // 浮层中的文字
	      document.getElementById('kxm-tooltip').innerHTML = el.innerText;
	    }
	    // 鼠标移出
	    el.onmouseleave = () => {
        console.log(...arguments);
        /* 第5步:鼠标移出`onmouseleave`需要移出title显示的元素 */ 
	      // 找到浮层元素并移出
	      const kxmTooltipDom = document.getElementById('kxm-tooltip');
	      kxmTooltipDom && document.body.removeChild(kxmTooltipDom);
	    }
	  }
	  // 需要注意:更新完之后需要移除容器,不然body里会多一个span元素内容
	  document.body.removeChild(textSpan);
	},
	// 指令与元素解绑时
	unbind () {
    console.log(...arguments);
    /* 第6步:解绑移除浮层元素 */
	  // 找到浮层元素并移除
	  const kxmTooltipDom = document.getElementById('kxm-tooltip');
	  kxmTooltipDom && document.body.removeChild(kxmTooltipDom);
	}
}

2、在需要的单页里,找到对应的main.js入口文件,引入指令

import tooltip from './assets/directive/tooltip.js'

Vue.directive('tooltip', tooltip)

3、使用指令

注意:这里如果你是直接写成下面这样的话

<template>
    <div class="test" v-tooltip>
        没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件
    </div>
</template>

指令那边需要使用inserted才会生效,下面这种就不会

<template>
    <div class="test" v-tooltip>
        {{content}}
    </div>
</template>

<script>

export default {
    data() {
        return {
            content: ''
        }
    },
    mounted() {
        this.content = '没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件没有人比我更懂自定义组件'
    },
}
</script>

<style lang="scss">
.test {
    width: 400px;
}
</style>

4、效果

090102

其他

如果在canvas里你可能会用涉及到文本的测量measureText方法

/**
  * 文字测量
  * @param String data - 文字
  * @param String textStyle - 文字样式
  * @param {*} ctx - canvas context
  * @param Boolean isCompatible - 是否兼容measureText
  */
measureText (data, textStyle, ctx, isCompatible = true) {
  let obj = {}
  if (isCompatible) {
    const d = document.createElement('span')
    d.innerText = data
    d.style.font = textStyle
    d.style.visibility = 'hidden'
    d.style.position = 'absolute'
    d.style.top = '0'
    d.style.left = '0'
    document.querySelector('body').appendChild(d)
    obj.width = d.offsetWidth
    obj.height = d.offsetHeight
  } else {
    // 注意在使用前设置好对应的 font 属性才能准确获取文字的长度
    ctx.font = textStyle
    obj.width = ctx.measureText(data).width
  }
  return obj
}

如果还感兴趣可以看看底下两个插件

vtip

Vtip 文档

项目地址:https://github.com/kinglisky/vtip

VueTippy

VueTippy demo

Logo

前往低代码交流专区

更多推荐