valid-v-model.md

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

vue/valid-v-model

enforce valid v-model directives

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

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

📖 Rule Details

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

• The directive used on HTMLElement has an argument. E.g. <input v-model:aaa="foo">
• The directive used on HTMLElement has modifiers which are not supported. E.g. <input v-model.bbb="foo">
• The directive does not have that attribute value. E.g. <input v-model>
• The directive does not have the attribute value which is valid as LHS. E.g. <input v-model="foo() + bar()">, <input v-model="a?.b">
• The directive has potential null object property access. E.g. <input v-model="(a?.b).c">
• The directive is on unsupported elements. E.g. <div v-model="foo"></div>
• The directive is on <input> elements which their types are file. E.g. <input type="file" v-model="foo">
• The directive's reference is iteration variables. E.g. <div v-for="x in list"><input type="file" v-model="x"></div>

<template>
  <!-- ✓ GOOD -->
  <input v-model="foo" />
  <input v-model.lazy="foo" />
  <textarea v-model="foo" />
  <MyComponent v-model="foo" />
  <MyComponent v-model:propName="foo" />
  <MyComponent v-model.modifier="foo" />
  <MyComponent v-model:propName.modifier="foo" />
  <div v-for="todo in todos">
    <input v-model="todo.name" />
  </div>

  <!-- ✗ BAD -->
  <input v-model />
  <input v-model:aaa="foo" />
  <input v-model.bbb="foo" />
  <input v-model="foo + bar" />
  <input v-model="a?.b.c" />
  <input v-model="(a?.b).c" />
  <div v-model="foo" />
  <div v-for="todo in todos">
    <input v-model="todo" />
  </div>
</template>

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

🔧 Options

Nothing.

👫 Related Rules

• vue/no-parsing-error

🚀 Version

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

🔍 Implementation

• Rule source
• Test source