vue feedback 指令开发

功能需求

<template>
  <span v-feedback="{activeClass:'span-active'}"></span>
</template>
<style>
.span-active {
  background: #000;
}
</style>

当该span被点时,.span-active生效。此处span可以是任意的html元素或组件

以鼠标操作举例,所谓的点是指左键被按下,按下时样式生效,松开后失效

为什么要使用指令方式

1. 直接使用组件

<feedback :active="{activeClass: 'span-active'}">
  <span></span>
</feedback>

由于vue的组件必须包含一个根节点,实际上是

<div class="span-active">
  <span></span>
</div>

此时出现了尴尬,span本身是一个inline元素,加上feedback后变成了block,并且feedback被使用的时候并不知道slot进来的元素是什么,如果要知道势必又要增加复杂度。

2. 使用混合

<template>
  <span></span>
</template>
<script>
import feedback from '@/components/feedback.js'
export default {
  mixin: {
    feedback
  },
  data () {
    return {
      activeClassName: 'span-active'
    }
  }
}
</script>

mixin是当前使用的方式,但是对使用人员要求更高,需要同时知道两个组件的内部实现。

实现思路

该指令需要干以下几件事:

  1. 为绑定指令的组件添加点击的监听,包括mouseupmousedowntouchestarttouchendtouchcancel
  2. 当事件发生时,为元素添加相应的activeClass
  3. 当元素本身是disabled的时候,去除样式的响应,实际上是去除监听

初始化的时候,先获得绑定的元素,并且添加监听器。在监听到有关事件的时候,添加、删除样式

export default {
  bind (el, binding) {
    const className = binding.value.activeClass
    const disabled = !!binding.value.disabled
    if (!disabled) {
      el.addEventListener('mousedown', ()=> {el.classList.add(className)})
      el.addEventListener('touchstart',  ()=> {el.classList.add(className)})
      el.addEventListener('touchcancel',  ()=> {el.classList.remove(className)})
      el.addEventListener('touchend',  ()=> {el.classList.remove(className)})
      el.addEventListener('mouseup',  ()=> {el.classList.remove(className)})
    }
  }
}

到此时,一切都很美好。

在实际应用中,这个组件极有可能点击后发生了改变,比如从!disabled转为了disabled状态,需要我们对其进行进一步处理。这个看起来很简单,!disabled看起来并不需要处理,原来的事件应该保留。只有disabled的状况需要把原有的监听器去除掉。

export default {
  bind (el, binding) {
    const className = binding.value.activeClass
    const disabled = !!binding.value.disabled
    if (!disabled) {
      el.addEventListener('mousedown', ()=> {el.classList.add(className)})
      el.addEventListener('touchstart',  ()=> {el.classList.add(className)})
      el.addEventListener('touchcancel',  ()=> {el.classList.remove(className)})
      el.addEventListener('touchend',  ()=> {el.classList.remove(className)})
      el.addEventListener('mouseup',  ()=> {el.classList.remove(className)})
    }
  },
  componentUpdated (el, binding) {
    const className = binding.value.activeClass
    const disabled = !!binding.value.disabled
    if (disabled) {
      el.removeEventListener('mousedown', ()=> {el.classList.add(className)})
      el.removeEventListener('touchstart',  ()=> {el.classList.add(className)})
      el.removeEventListener('touchcancel',  ()=> {el.classList.remove(className)})
      el.removeEventListener('touchend',  ()=> {el.classList.remove(className)})
      el.removeEventListener('mouseup',  ()=> {el.classList.remove(className)})
    }
  }
}

运行后,发现监听器没有被去除掉,因为 removeEventListener 应该移除之前添加的监听器,因为使用了箭头函数,所以后面的监听器并不是之前的监听器。那我们把箭头函数换成统一的函数

function addClass (el, className) {
  el.classList.add(className)
}

function removeClass (el, className) {
  el.classList.remove(className)
}

export default {
  bind (el, binding) {
    const className = binding.value.activeClass
    const disabled = !!binding.value.disabled
    if (!disabled) {
      el.addEventListener('mousedown', addClass(el, className))
      el.addEventListener('touchstart',  addClass(el, className))
      el.addEventListener('touchcancel',  removeClass(el, className))
      el.addEventListener('touchend',  removeClass(el, className))
      el.addEventListener('mouseup',  removeClass(el, className))
    }
  },
  componentUpdated (el, binding) {
    const className = binding.value.activeClass
    const disabled = !!binding.value.disabled
    if (disabled) {
      el.removeEventListener('mousedown', addClass(el, className))
      el.removeEventListener('touchstart',  addClass(el, className))
      el.removeEventListener('touchcancel',  removeClass(el, className))
      el.removeEventListener('touchend',  removeClass(el, className))
      el.removeEventListener('mouseup',  removeClass(el, className))
    }
  }
}

报错了,想当然是不行的。addEventListener 的第二个参数

listener 必须是一个实现了 EventListener 接口的对象,或者是一个函数

如果只传入函数,那又产生了一个问题,addClassremoveCLass无法取得elclassName的。这里面还存在一个作用域的问题。最后想了一个办法,就是利用eventTarget来替代el,并且把className放在Dom上。

function addClass (event) {
  const el = event.currentTarget
  const className = event.currentTarget.getAttribute('data-active-class')
  el.classList.add(className)
}

function removeClass (event) {
  const el = event.currentTarget
  const className = event.currentTarget.getAttribute('data-active-class')
  el.classList.remove(className)
}

function feedback (el, className, option) {
  el.setAttribute('data-active-class', className)
  if (option === 'add') {
    el.addEventListener('mousedown', addClass)
    el.addEventListener('touchstart', addClass)
    el.addEventListener('touchcancel', removeClass)
    el.addEventListener('touchend', removeClass)
    el.addEventListener('mouseup', removeClass)
  } else if (option === 'remove') {
    el.removeEventListener('mousedown', addClass)
    el.removeEventListener('touchstart', addClass)
    el.removeEventListener('touchcancel', removeClass)
    el.removeEventListener('touchend', removeClass)
    el.removeEventListener('mouseup', removeClass)
  }
}
export default {
  bind (el, binding) {
    const className = binding.value.activeClass
    const disabled = !!binding.value.disabled
    if (!disabled) {
      feedback(el, className, 'add')
    }
  },
  componentUpdated (el, binding) {
    const className = binding.value.activeClass
    const disabled = !!binding.value.disabled
    const oldDisabled = !!binding.oldValue.disabled
    if (oldDisabled !== disabled) {
      if (disabled) {
        feedback(el, className, 'remove')
      } else {
        feedback(el, className, 'add')
      }
    }
  },
  unbind (el, binding) {
    const className = binding.value.activeClass
    feedback(el, className, 'remove')
  }
}

优化及未尽事宜

  1. disabled是不是可以不通过指令传入
  2. 把监听和添加样式从el转到vnode

通过webpack对css压缩后所引起的重名问题

起因

我们维护了两个组件库,一套用于PC,另一套用于Mobile。有一个使用方同时引入了这两个库,这时候突然发现了一个诡异的现象:

一个tag组件凭空旋转起来,事实上没有给这个tag添加任何动画效果

发现

直接从页面表现来看,很难发现问题所在。我们进行了以下步骤进行排查

  1. 通过chrome的animate面板,看执行的是什么动画。发现其动画名为a
  2. 通过vue控制台/源码,发现其使用了vuetransition组件,并且其transition使用了PC组件库提供的fade动画。

分析

为什么fade动画会变成了旋转?我们在编译的css文件中寻找tanslate@keyframes关键词,发现

@keyframes a {
    translate:rotate(1turn)
}
@keyframes a {
    0% {
        opacity:0;
    }
    100% {
        opacity:1;
    }
}

有2个名为a的动画,那么问题就清楚了,是两个动画冲突了。但是怎么会都叫a的呢。我们不太可能这么随意的起名。源码中也没有找到名为a的动画。那么有一种可能,就是在打包的时候被改名了。

找到Vue本身提供的webpack.prod.conf.js,发现里面是这样的:

new OptimizeCSSPlugin({
  cssProcessorOptions: config.build.productionSourceMap
    ? { safe: true, map: { inline: false } }
    : { safe: true }
})

而我们用来发布包的webpack.pack.conf.js里面是这样的:

new OptimizeCSSPlugin()

说明pack脚本是按照最大压缩方式进行压缩的,会对css进行改名,如果两个库都采用同样的方式进行压缩,自然会产生命名冲突。vue官方的配置很明显考虑到了这一点,所以直接采用了避免冲突的「安全」模式。

解决

css压缩模式换为safe并重新打包,问题解决。

Vue组件抛事件和Function prop的差别

1. emit event

child component

<template>
  <button @click="foo">Button</button>
</template>
<script>
export default {
  name: 'my-button',
  methods:{
    foo () {
      this.$emit('onClick')
    }
  }
}
</script>

parent component

<template>
  <my-button @onClick="handleClick"></my-button>
</template>
<script>
import myButton from '@/components/myButton'
export default {
  components: { myButton }
  methods: {
    handleClick () {
      console.log('boo')
    }
  }
}
</script>

2. props function

child component

<template>
  <button @click="onClick">Button</button>
</template>
<script>
export default {
  name: 'my-button',
  props: {
    onClick: {
      type: Function
    }
  }
}
</script>

parent component

<template>
  <my-button :onClick="handleClick"></my-button>
</template>
<script>
import myButton from '@/components/myButton'
export default {
  components: { myButton }
  methods: {
    handleClick () {
      console.log('boo')
    }
  }
}
</script>

3. 实验结果和理解

父组件不知道事件什么时候会发生,因为事件的监听和处理都在子组件

子组件不知道父组件在事件发生后干什么,因为干什么是执行的父组件里的method

子组件要求父组件提供一个Callback函数,当事件发生时子组件去回调父组件提供的Callback函数

两种方式的运行结果是一样的,写法上和理解上有差别。

  1. 在emit的情况下

    父组件能够监听到事件的发生,并且决定在事件发生时做什么

  2. 在props的情况下

    父组件不知道事件发生与否,只能指令子组件在发生时做什么处理

4. 可能的问题

  1. 是否存在父组件要对子组件产生的事件进行搜集并处理? 第二种方式可能就歇菜
  2. 第二种方式对传入的Function内部是无法校验的,不过第一种也只是回避,本来就不校验