useEventRef


用于绑定事件的 Hook

TIP

useEvent 功能相同,区别在于只接受三个参数: eventcboptions,函数内部会返回一个 Ref,用于在模板里设置事件绑定的对象

API

const [target, clear] = useEventRef(event, cb, options)

Params

参数名描述类型默认值
event事件名称string
cb事件回调Function
options传递给 addEventListenerremoveEventListener 的第三个参数Bolean | AddEventListenerOptions

Result

参数说明类型
target用于在模板中设置事件绑定的 DOM 节点Ref<Element | null>
clear用于解绑事件() => void

Example

Code

<template>
  <button ref="target">click</button>
</template>

<script>
import { useEventRef } from 'vue-compositions'
export default {
  setup() {
    const [target] = useEventRef(
      'click',
      () => {
        alert('click')
      },
      true
    )
    return {
      target
    }
  }
}
</script>