Baidu DLS

返回 DLS

v-nudge

简介

v-nudge 指令用于使用键盘方向键对值进行调整。

应用 v-nudge 的元素或组件根元素必须可以接收焦点。可以使用本身就会接收焦点的元素如 <button><input> 或者使用 tabindex 属性

示例

按方向键时如果同时按下了 shiftalt 键,则变化值会被放大 10 倍或缩小 10 倍。

0
点我,按左右方向键
点我,按上下方向键
<template>
<article>
  <div class="box value">
    {{ displayValue }}
  </div>
  <div
    v-nudge.x="{update: handleNudgeUpdate}"
    class="box"
    tabindex="-1"
  >
    点我,按<strong>左右</strong>方向键
  </div>
  <div
    v-nudge.y="{update: handleNudgeUpdate}"
    class="box"
    tabindex="-1"
  >
    点我,按<strong>上下</strong>方向键
  </div>
</article>
</template>

<script>
import nudge from 'veui/directives/nudge'

export default {
  directives: {
    nudge
  },
  data () {
    return {
      value: 0
    }
  },
  computed: {
    displayValue () {
      return this.value.toFixed(1).replace('.0', '')
    }
  },
  methods: {
    handleNudgeUpdate (increase) {
      this.value += increase
    }
  }
}
</script>

API

指令的具体用法请参考官方文档。更多详细参数请参考自定义指令

绑定值

类型:function|Object

使用 function 类型则绑定值表示按下方向键后触发的回调函数。例如:

<div tabindex="-1" v-nudge="update"></div>

使用 Object 类型时绑定值可完整配置所有参数。例如:

<div tabindex="-1" v-nudge="{
  step: 5,
  axis: 'y',
  update: increase
}"></div>
参数类型默认值描述
axisstringy限制只能使用左右或上下方向键调整。取值为:xy
stepnumbernudge.step步进值。可进行全局配置
updatefunction(delta: number)function() {}值发生变化时触发,传入变化值。参数 delta 为计算后的数值变化量。

Object 类型提供的参数会覆盖通过指令参数、修饰符指定的参数。

v-nudge 只生成按方向键得到的变化值,本身并不会对值进行修改,需要使用者在 update 回调中自行处理。

修饰符

对应 Object 类型绑定值中的 axis/step。例如:

<div tabindex="-1" v-nudge.x.2="{ update: delta => this.val += delta }"></div>
描述
x限制只能使用左右方向键调整。
y限制只能使用上下方向键调整。
step步进值,注意这里 step 是一个变量。

在修饰符中的唯一正整数将被识别为 step

全局配置

配置项类型默认值描述
nudge.stepnumber1步进值。