require-default-prop.md

pageClass	sidebarDepth	title	description	since
rule-details	0	vue/require-default-prop	require default value for props	v3.13.0

vue/require-default-prop

require default value for props

• ⚙️ This rule is included in all of "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"].

📖 Rule Details

This rule requires default value to be set for each props that are not marked as required (except Boolean props).

<script>
export default {
  props: {
    /* ✓ GOOD */
    a: {
      type: Number,
      required: true
    },
    b: {
      type: Number,
      default: 0
    },
    c: {
      type: Number,
      default: 0,
      required: false
    },
    d: {
      type: Boolean, // Boolean is the only type that doesn't require default
    },

    /* ✗ BAD */
    e: Number,
    f: [Number, String],
    g: [Boolean, Number],
    j: {
      type: Number
    },
    i: {
      type: Number,
      required: false
    }
  }
}
</script>

🔧 Options

Nothing.

👫 Related Rules

• vue/no-boolean-default

📚 Further Reading

• Style guide - Prop definitions

🚀 Version

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

🔍 Implementation

• Rule source
• Test source