Skip to content

v-on 事件绑定

监听事件

我们可以使用 v-on 指令 (简写为 @) 来监听 DOM 事件,并在事件触发时执行对应的 JavaScript。用法:v-on:click="handler"@click="handler"

事件处理器 (handler) 的值可以是:

  1. 内联事件处理器:事件被触发时执行的内联 JavaScript 语句 (与 onclick 类似)。
  2. 方法事件处理器:一个指向组件上定义的方法的属性名或是路径。

内联事件处理器

内联事件处理器通常用于简单场景,例如:

js
const count = ref(0);
vue
<button @click="count++">Add 1</button>
<p>Count is: {{ count }}</p>

方法事件处理器

随着事件处理器的逻辑变得愈发复杂,内联代码方式变得不够灵活。因此 v-on 也可以接受一个方法名或对某个方法的调用。

举例来说:

js
const name = ref("Vue.js");

function greet(event) {
  alert(`Hello ${name.value}!`);
  // `event` 是 DOM 原生事件
  if (event) {
    alert(event.target.tagName);
  }
}
vue
<!-- `greet` 是上面定义过的方法名 -->
<button @click="greet">Greet</button>

方法事件处理器会自动接收原生 DOM 事件并触发执行。在上面的例子中,我们能够通过被触发事件的 event.target.tagName 访问到该 DOM 元素。

方法与内联事件判断

模板编译器会通过检查 v-on 的值是否是合法的 JavaScript 标识符或属性访问路径来断定是何种形式的事件处理器。举例来说,foofoo.barfoo['bar'] 会被视为方法事件处理器,而 foo()count++ 会被视为内联事件处理器。

在内联处理器中调用方法

除了直接绑定方法名,你还可以在内联事件处理器中调用方法。这允许我们向方法传入自定义参数以代替原生事件:

js
function say(message) {
  alert(message);
}
vue
<button @click="say('hello')">Say hello</button>
<button @click="say('bye')">Say bye</button>

处理访问事件参数

有时我们需要在内联事件处理器中访问原生 DOM 事件。你可以向该处理器方法传入一个特殊的 $event 变量,或者使用内联箭头函数:

有时我们需要在内联事件处理器中访问原生 DOM 事件。你可以向该处理器方法传入一个特殊的 $event 变量,或者使用内联箭头函数:

vue
<!-- 使用特殊的 $event 变量 -->
<button @click="warn('Form cannot be submitted yet.', $event)">
  Submit
</button>

<!-- 使用内联箭头函数 -->
<button @click="(event) => warn('Form cannot be submitted yet.', event)">
  Submit
</button>
js
function warn(message, event) {
  // 这里可以访问原生事件
  if (event) {
    event.preventDefault();
  }
  alert(message);
}

事件修饰符

在处理事件时调用 event.preventDefault()event.stopPropagation() 是很常见的。尽管我们可以直接在方法内调用,但如果方法能更专注于数据逻辑而不用去处理 DOM 事件的细节会更好。

为解决这一问题,Vue 为 v-on 提供了 事件修饰符 。修饰符是用 . 表示的指令后缀,包含以下这些:

  • .stop
  • .prevent
  • .self
  • .capture
  • .once
  • .passive
vue
<!-- 单击事件将停止传递 -->
<a @click.stop="doThis"></a>

<!-- 提交事件将不再重新加载页面 -->
<form @submit.prevent="onSubmit"></form>

<!-- 修饰语可以使用链式书写 -->
<a @click.stop.prevent="doThat"></a>

<!-- 也可以只有修饰符 -->
<form @submit.prevent></form>

<!-- 仅当 event.target 是元素本身时才会触发事件处理器 -->
<!-- 例如:事件处理器不来自子元素 -->
<div @click.self="doThat">...</div>

提示

使用修饰符时需要注意调用顺序,因为相关代码是以相同的顺序生成的。因此使用 @click.prevent.self 会阻止元素及其子元素的所有点击事件的默认行为,而 @click.self.prevent 则只会阻止对元素本身的点击事件的默认行为。

.capture.once.passive 修饰符与原生 addEventListener 事件相对应:

vue
<!-- 添加事件监听器时,使用 `capture` 捕获模式 -->
<!-- 例如:指向内部元素的事件,在被内部元素处理前,先被外部处理 -->
<div @click.capture="doThis">...</div>

<!-- 点击事件最多被触发一次 -->
<a @click.once="doThis"></a>

<!-- 滚动事件的默认行为 (scrolling) 将立即发生而非等待 `onScroll` 完成 -->
<!-- 以防其中包含 `event.preventDefault()` -->
<div @scroll.passive="onScroll">...</div>

.passive 修饰符一般用于触摸事件的监听器,可以用来改善移动端设备的滚屏性能

提示

请勿同时使用 .passive.prevent,因为 .passive 已经向浏览器表明了你不想阻止事件的默认行为。如果你这么做了,则 .prevent 会被忽略,并且浏览器会抛出警告。

按键修饰符

在监听键盘事件时,我们经常需要检查特定的按键。Vue 允许在 v-on@ 监听按键事件时添加按键修饰符。

vue
<!-- 仅在 `key` 为 `Enter` 时调用 `submit` -->
<input @keyup.enter="submit" />

你可以直接使用 KeyboardEvent.key 暴露的按键名称作为修饰符,但需要转为 kebab-case 形式。

vue
<input @keyup.page-down="onPageDown" />

在上面的例子中,仅会在 $event.key'PageDown' 时调用事件处理。

按键别名

Vue 为一些常用的按键提供了别名:

  • .enter
  • .tab
  • .delete (捕获“Delete”和“Backspace”两个按键)
  • .esc
  • .space
  • .up
  • .down
  • .left
  • .right

系统按键修饰符

你可以使用以下系统按键修饰符来触发鼠标或键盘事件监听器,只有当按键被按下时才会触发。

  • .ctrl
  • .alt
  • .shift
  • .meta

注意

在 Mac 键盘上,meta 是 Command 键 (⌘)。在 Windows 键盘上,meta 键是 Windows 键 (⊞)。在 Sun 微机系统键盘上,meta 是钻石键 (◆)。在某些键盘上,特别是 MIT 和 Lisp 机器的键盘及其后代版本的键盘,如 Knight 键盘,space-cadet 键盘,meta 都被标记为“META”。在 Symbolics 键盘上,meta 也被标识为“META”或“Meta”。

举例来说:

vue
<!-- Alt + Enter -->
<input @keyup.alt.enter="clear" />

<!-- Ctrl + 点击 -->
<div @click.ctrl="doSomething">Do something</div>

:::TIP 请注意,系统按键修饰符和常规按键不同。与 keyup 事件一起使用时,该按键必须在事件发出时处于按下状态。换句话说,keyup.ctrl 只会在你仍然按住 ctrl 但松开了另一个键时被触发。若你单独松开 ctrl 键将不会触发。 :::

.exact 修饰符

.exact 修饰符允许控制触发一个事件所需的确定组合的系统按键修饰符。

vue
<!-- 当按下 Ctrl 时,即使同时按下 Alt 或 Shift 也会触发 -->
<button @click.ctrl="onClick">A</button>

<!-- 仅当按下 Ctrl 且未按任何其他键时才会触发 -->
<button @click.ctrl.exact="onCtrlClick">A</button>

<!-- 仅当没有按下任何系统按键时触发 -->
<button @click.exact="onClick">A</button>

鼠标按键修饰符

  • .left
  • .right
  • .middle

这些修饰符将处理程序限定为由特定鼠标按键触发的事件。

案例

目标:给标签绑定事件

  • 语法
    • v-on:事件名="要执行的少量代码"
    • v-on:事件名="methods 中的函数"
    • v-on:事件名="methods 中的函数 (实参)"
  • 简写:@事件名="methods 中的函数"
html
<!-- vue 指令:v-on 事件绑定-->
<script setup>
  import { ref } from "vue";

  const count = ref(1);

  const add = () => {
    count.value += 1;
  };

  const add_n = (n) => {
    count.value += n;
  };

  const sub = () => {
    count.value -= 1;
  };
</script>

<vue>
  <div>
    <p>你要购买商品的数量:{{ count }}</p>
    <!-- 1. 绑定事件
     语法:v-on:事件名="少量代码"
     语法:v-on:事件名="函数名"
     语法:v-on:事件名="里函数名 (值)"
     语法:@事件名="函数名"
     -->
    <button v-on:click="count = count + 1">+1</button>
    <button v-on:click="add">+1</button>
    <button v-on:click="add_n(5)">+5</button>
    <button @click="sub">减少 1</button>
  </div>
</vue>

<style scoped></style>

总结:常用 @事件名,给 dom 标签绑定事件,以及用 =右侧事件 处理函数

v-on 事件对象

目标:vue 事件处理函数中,拿到事件对象

  • 语法:
    • 无传参,通过形参直接接收
    • 传参,通过 $event 指代事件对象传给事件处理函数
vue
<script setup>
// 1. 事件触发,无传值,可以直接获取事件对象是
const one = (e) => {
  e.preventDefault();
  console.log(e);
};

// 2. 事件触发,传值,需要手动传入$event
const two = (num, e) => {
  e.preventDefault();
};
</script>

<vue>
  <div>
    <a @click="one" href="https://www.baidu.com">阻止百度</a>
    <hr>
    <a @click="two(10, $event)" href="https://www.baidu.com">阻止去百度</a>
  </div>
</vue>

<style scoped></style>

v-on 修饰符

目的:在事件后面。修饰符名 - 给事件带来更强大的功能

  • 语法:
    • @事件名。修饰符="methods 里函数"
      • .stop - 阻止事件冒泡
      • .prevent - 阻止默认行为
      • .once - 程序运行期间,只触发一次事件处理函数
html
<script setup>
  const father_func = () => {
    console.log("father-触发 click 事件");
  };

  const button_handle = () => {
    console.log("button_handle-触发 click 事件");
  };

  const p_handle = () => {
    console.log("p 标签点击了");
  };

  const a_handle = () => {
    console.log("a 标签被点击了");
  };
</script>

<vue>
  <div @click="father_func">
    <!--有默认的冒泡事件-->
    <button @click="button_handle">button</button>
    <!--使用事件修饰符阻止冒泡事件-->
    <button @click.stop="button_handle">stop button</button>

    <p @click.once="p_handle">点击观察事件处理函数执行几次</p>
    <hr />

    <a @click.stop="a_handle" href="https://www.baidu.com">阻止百度</a><br />
    <a @click.stop.prevent="a_handle" href="https://www.baidu.com">阻止百度</a>
  </div>
</vue>

<style scoped></style>

总结:修饰符给事件扩展额外功能

v-on 按键修饰符

目标:给键盘事件,添加修饰符,增强能力

  • 语法:
    • @keyup.enter - 监测回车按键
    • @keyup.esc - 监测返回按键

更多修饰符

html
<script setup>
  import { ref } from "vue";

  const username = ref("");
  const pwd = ref("");

  const clearContent = () => {
    // 按 delete 键的时候,清空用户名
    username.value = "";
  };

  const handleSubmit = () => {
    console.log(username.value, pwd.value);
  };
</script>

<vue>
  <form action="">
    <label>
      用户名:
      <!--@keyup.delete 按下 delete 键的时候触发 clearContent 函数-->
      <input type="text" @keyup.delete="clearContent" v-model="username" />
    </label>
    <label>
      密码:
      <input type="text" v-model="pwd" />
    </label>
    <label>
      <!-- 1. 绑定键盘按下事件.enter-回车 -->
      <input type="button" @click="handleSubmit" value="提交" />
    </label>
  </form>
</vue>

<style scoped></style>

练习 - 翻转字符串

目标:点击按钮 - 把文字取反显示 - 再点击取反显示 (回来了)

提示:把字符串取反赋予回去

正确代码:

html
<script setup>
  import { ref } from "vue";

  const message = ref("hello, world");

  const reverse = () => {
    message.value = message.value.split("").reverse().join("");
  };
</script>

<vue>
  <div>
    <h1>{{ message }}</h1>
    <button @click="reverse">翻转文字</button>
  </div>
</vue>

<style scoped></style>

总结:记住方法特点,多做需求,vue 是数据变化视图自动更新,减少操作 DOM 时间,提高开发效率