欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解如何在Vue里建立长按指令

程序员文章站 2022-06-24 16:29:00
您是否曾想过按住按钮几秒钟才能在vue应用程序中执行某个功能? 您是否曾想在应用程序上创建一个按钮,通过按一次(或按住按钮的整个输入)来清除单个输入? 如果你曾有过这些...

您是否曾想过按住按钮几秒钟才能在vue应用程序中执行某个功能?

您是否曾想在应用程序上创建一个按钮,通过按一次(或按住按钮的整个输入)来清除单个输入?

如果你曾有过这些想法,很好,我也是。那么恭喜你看到了这篇文章。

本文将解释如何通过按下(或按住)按钮来执行功能和删除输入。

首先,我将解释如何在vanillajs中实现这一目标。然后,为它创建一个vue指令。

那么,让我们开始吧。

原理

为了实现长按,用户需要按住按钮几秒钟。

要在代码中复制它,我们需要在按下鼠标“单击”按钮时监听,启动计时器,不管我们希望用户在执行函数之前按住按钮,并在时间设置之后执行该功能。

非常简单!但是,我们需要知道用户何时按住该按钮。

怎么做

当用户单击按钮时,在单击事件之前会触发另外两个事件: mousedown 和 mouseup 。

当用户按下鼠标按钮时会调用 mousedown 事件,而当用户释放该按钮时会调用mouseup事件。

我们需要做的就是:

发生mousedown事件后启动计时器。

清除该计时器,并且在2secs标记之前触发mouseup事件后不执行该函数。即完整点击事件。

只要计时器在到达那个时间之前没有被清除,我们就会发现mouseup事件没有被触发 - 我们可以说用户没有释放按钮。因此,它被认为是长按,然后我们可以继续执行所述功能。

实际操作

让我们深入研究代码并完成这项工作。

首先,我们必须定义3件事,即:

variable 用于存储计时器。

start 函数启动计时器。

cancel 函数取消定时器

变量

这个变量基本上保存了settimeout的值,所以我们可以在发生mouseup事件时取消它。

let presstimer = null;

我们将变量设置为null,这样我们就可以检查变量,以便知道当前是否有一个活动定时器,然后才能取消它。

启动功能

该函数由settimeout组成,它基本上是javascript中的一种方法,它允许我们在函数中声明的特定持续时间之后执行函数。

请记住,在创建click事件的过程中,会触发两个事件。但我们需要启动计时器的是mousedown事件。因此,如果是单击事件,我们不需要启动计时器。

// create timeout ( run function after 1s )
let start = (e) => {
  
  // make sure the event trigger isn't a click event
  if (e.type === 'click' && e.button !== 0) {
    return;
  }
  // make sure we don't currently have a settimeout running
  // before starting another
  if (presstimer === null) {
    presstimer = settimeout(() => {
      // execute soemthing !!!
    }, 1000)
  }
}

取消功能

这个函数基本上就是名字所说的,取消了调用start函数时创建的settimeout。

要取消settimeout,我们将在javascript中使用 cleartimeout 方法,该方法基本上清除了使用settimeout()设置的计时器方法。

在使用cleartimeout之前,我们首先需要检查 presstimer 变量是否设置为null。如果它未设置为null,则表示存在活动计时器。所以,我们需要清除计时器,你猜对了,将 presstimer 变量设置为 null 。

let cancel = (e) => {
  // check if timer has a value or not
  if (presstimer !== null) {
    cleartimeout(presstimer)
    presstimer = null
  }
}

一旦 mouseup 事件被触发,就会调用此函数。

设置触发器

剩下的就是将事件监听器添加到要添加长按效果的按钮上。

addeventlistener("mousedown", start);
addeventlistener("click", cancel);

总而言之,我们有:

// define variable
let presstimer = null;

// create timeout ( run function after 1s )
let start = (e) => {

  if (e.type === 'click' && e.button !== 0) {
    return;
  }

  if (presstimer === null) {
    presstimer = settimeout(() => {

      // execute something !!!

    }, 1000);
  }
}

// cancel timeout
let cancel = (e) => {

  // check if timer has a value or not
  if (presstimer !== null) {
    cleartimeout(presstimer);
    presstimer = null;
  }
}

// select element with id longpressbutton
let el = document.getelementbyid('longpressbutton');

// add event listeners
el.addeventlistener("mousedown", start);

// cancel timeouts if this events happen
el.addeventlistener("click", cancel);
el.addeventlistener("mouseout", cancel);

将它全部包装在vue指令中

在创建vue指令时,vue允许我们在组件的全局或本地定义指令,但在本文中我们将使用全局路由。

让我们构建完成此任务的指令。

首先,我们必须声明自定义指令的名称。

vue.directive('longpress', {
 
}

这基本上注册了一个名为 v-longpress的全局自定义指令.

接下来,我们使用一些参数添加bind hook函数 ,这允许我们引用元素指令绑定,获取传递给指令的值并标识使用该指令的组件。

vue.directive('longpress', {
 bind: function (el, binding, vnode) {
  
 }
}

接下来,我们在bind函数中添加我们的长按javascript代码。

vue.directive('longpress', {
  bind: function (el, binding, vnode) {

    // define variable
    let presstimer = null

    // define funtion handlers
    // create timeout ( run function after 1s )
    let start = (e) => {

      if (e.type === 'click' && e.button !== 0) {
        return;
      }

      if (presstimer === null) {
        presstimer = settimeout(() => {
          // execute something !!!
        }, 1000)
      }
    }

    // cancel timeout
    let cancel = (e) => {
      // check if timer has a value or not
      if (presstimer !== null) {
        cleartimeout(presstimer)
        presstimer = null
      }
    }

    // add event listeners
    el.addeventlistener("mousedown", start);
    // cancel timeouts if this events happen
    el.addeventlistener("click", cancel);
    el.addeventlistener("mouseout", cancel);
  }
})

接下来,我们需要添加一个函数来运行将传递给 longpress 指令的方法。

// long press vue directive
vue.directive('longpress', {
  bind: function (el, binding, vnode) {

    // define variable
    let presstimer = null

    // define funtion handlers
    // create timeout ( run function after 1s )
    let start = (e) => {

      if (e.type === 'click' && e.button !== 0) {
        return;
      }

      if (presstimer === null) {
        presstimer = settimeout(() => {
          // execute function
          handler()
        }, 1000)
      }
    }

    // cancel timeout
    let cancel = (e) => {
      // check if timer has a value or not
      if (presstimer !== null) {
        cleartimeout(presstimer)
        presstimer = null
      }
    }
    // run function
    const handler = (e) => {
      // execute method that is passed to the directive
      binding.value(e)
    }

    // add event listeners
    el.addeventlistener("mousedown", start);

    // cancel timeouts if this events happen
    el.addeventlistener("click", cancel);
    el.addeventlistener("mouseout", cancel);
    
  }
})

现在我们可以在我们的vue应用程序中使用该指令,该指令将正常工作,直到用户添加的值不是指令值中的函数。所以我们必须通过在发生这种情况时警告用户来防止这种情况。

要警告用户,我们将以下内容添加到bind函数:

// make sure expression provided is a function
if (typeof binding.value !== 'function') {
 // fetch name of component
 const compname = vnode.context.name
 // pass warning to console
 let warn = `[longpress:] provided expression '${binding.expression}' is not a function, but has to be`
 if (compname) { warn += `found in component '${compname}' ` }
 console.warn(warn)
}

最后,这个指令也适用于触控设备。所以我们为 touchstart , touchend & touchcancel 添加事件监听器。

把所有东西放在一起:

vue.directive('longpress', {
  bind: function (el, binding, vnode) {
    // make sure expression provided is a function
    if (typeof binding.value !== 'function') {
      // fetch name of component
      const compname = vnode.context.name
      // pass warning to console
      let warn = `[longpress:] provided expression '${binding.expression}' is not a function, but has to be`
      if (compname) { warn += `found in component '${compname}' ` }

      console.warn(warn)
    }

    // define variable
    let presstimer = null

    // define funtion handlers
    // create timeout ( run function after 1s )
    let start = (e) => {

      if (e.type === 'click' && e.button !== 0) {
        return;
      }

      if (presstimer === null) {
        presstimer = settimeout(() => {
          // run function
          handler()
        }, 1000)
      }
    }

    // cancel timeout
    let cancel = (e) => {
      // check if timer has a value or not
      if (presstimer !== null) {
        cleartimeout(presstimer)
        presstimer = null
      }
    }
    // run function
    const handler = (e) => {
      binding.value(e)
    }

    // add event listeners
    el.addeventlistener("mousedown", start);
    el.addeventlistener("touchstart", start);
    // cancel timeouts if this events happen
    el.addeventlistener("click", cancel);
    el.addeventlistener("mouseout", cancel);
    el.addeventlistener("touchend", cancel);
    el.addeventlistener("touchcancel", cancel);
  }
})

现在引用我们的vue组件:

<template>
  <div>
    <button v-longpress="incrementplusten" @click="incrementplusone">{{value}}</button>
  </div>
</template>

<script>
export default {
  data() {
    return {
      value: 10
    }
  },
  methods: {
    // increment value plus one
    incrementplusone() {
      this.value++
    },
    // increment value plus 10
    incrementplusten() {
      this.value += 10
    }
  }
}
</script>

如果您希望了解有关自定义指令的更多信息,可以使用的钩子函数,可以传递给此钩子函数的参数,函数缩写。伟大的家伙@vuejs在解释它方面做得很好。

成功 !!!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。