no-reserved-props.md

pageClass	sidebarDepth	title	description	since
rule-details	0	vue/no-reserved-props	disallow reserved names in props	v8.0.0

vue/no-reserved-props

disallow reserved names in props

• ⚙️ 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 disallow reserved names to be used in props.

<script>
export default {
  props: {
    /* ✗ BAD */
    ref: String,
    key: String,
    /* ✓ GOOD */
    foo: String,
    bar: String,
  }
}
</script>

🔧 Options

{
  "vue/no-reserved-props": ["error", {
    "vueVersion": 3, // or 2
  }]
}

• vueVersion (2 | 3) ... Specify the version of Vue you are using. Default is 3.

🚀 Version

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

🔍 Implementation

• Rule source
• Test source