valid-v-on.md

pageClass	sidebarDepth	title	description	since
rule-details	0	vue/valid-v-on	enforce valid `v-on` directives	v3.11.0

vue/valid-v-on

enforce valid v-on directives

• ⚙️ This rule is included in all of "plugin:vue/vue3-essential", *.configs["flat/essential"], "plugin:vue/essential", *.configs["flat/vue2-essential"], "plugin:vue/vue3-strongly-recommended", *.configs["flat/strongly-recommended"], "plugin:vue/strongly-recommended", *.configs["flat/vue2-strongly-recommended"], "plugin:vue/vue3-recommended", *.configs["flat/recommended"], "plugin:vue/recommended" and *.configs["flat/vue2-recommended"].

This rule checks whether every v-on directive is valid.

📖 Rule Details

This rule reports v-on directives in the following cases:

• The directive does not have that event name. E.g. <div v-on="foo"></div>
• The directive has invalid modifiers. E.g. <div v-on:click.bbb="foo"></div>
• The directive does not have that attribute value and any verb modifiers. E.g. <div v-on:click></div>

<template>
  <!-- ✓ GOOD -->
  <div v-on="foo" />
  <div v-on:click="foo" />
  <div @click="foo" />
  <div @click.left="foo" />
  <div @click.prevent />
  <div @click.stop />

  <!-- ✗ BAD -->
  <div v-on />
  <div v-on:click />
  <div v-on:click.aaa="foo" />
  <div @click />
</template>

::: warning Note This rule does not check syntax errors in directives because it's checked by vue/no-parsing-error rule. :::

🔧 Options

{
  "vue/valid-v-on": ["error", {
    "modifiers": []
  }]
}

This rule has an object option:

"modifiers" array of additional allowed modifiers.

"modifiers": ["foo"]

<template>
  <div @click.foo="foo" />
  <div v-on:click.foo="foo" />
</template>

👫 Related Rules

• vue/no-parsing-error

🚀 Version

This rule was introduced in eslint-plugin-vue v3.11.0

🔍 Implementation

• Rule source
• Test source