require-v-for-key.md

pageClass	sidebarDepth	title	description	since
rule-details	0	vue/require-v-for-key	require `v-bind:key` with `v-for` directives	v3.0.0

vue/require-v-for-key

require v-bind:key with v-for 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"].

📖 Rule Details

This rule reports the elements which have v-for and do not have v-bind:key with exception to custom components.

<template>
  <!-- ✓ GOOD -->
  <div v-for="todo in todos" :key="todo.id" />
  <!-- ✗ BAD -->
  <div v-for="todo in todos" />
</template>

::: warning Note This rule does not report missing v-bind:key on custom components. It will be reported by vue/valid-v-for rule. :::

🔧 Options

Nothing.

👫 Related Rules

• vue/valid-v-for
• vue/v-if-else-key

📚 Further Reading

• Style guide - Keyed v-for
• Guide (for v2) - v-for with a Component

🚀 Version

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

🔍 Implementation

• Rule source
• Test source