# vue/no-reserved-props

disallow reserved names in props

⚙️ This rule is included in all of "plugin:vue/vue3-essential", "plugin:vue/essential", "plugin:vue/vue3-strongly-recommended", "plugin:vue/strongly-recommended", "plugin:vue/vue3-recommended" and "plugin:vue/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>

Now loading...

# 🔧 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 (opens new window)
Test source (opens new window)

← vue/no-reserved-keys vue/no-setup-props-destructure →