# vue/no-required-prop-with-default
enforce props with default values to be optional
- ❗️ This rule has not been released yet.
- 🔧 The
--fixoption on the command line (opens new window) can automatically fix some of the problems reported by this rule. - 💡 Some problems reported by this rule are manually fixable by editor suggestions (opens new window).
# 📖 Rule Details
If a prop is declared with a default value, whether it is required or not, we can always skip it in actual use. In that situation, the default value would be applied. So, a required prop with a default value is essentially the same as an optional prop. This rule enforces all props with default values to be optional.
<script setup lang="ts">
/* ✓ GOOD */
const props = withDefaults(
defineProps<{
name?: string | number
age?: number
}>(),
{
name: "Foo",
}
);
/* ✗ BAD */
const props = withDefaults(
defineProps<{
name: string | number
age?: number
}>(),
{
name: "Foo",
}
);
</script>
<script>
export default {
/* ✓ GOOD */
props: {
name: {
required: true,
default: 'Hello'
}
}
/* ✗ BAD */
props: {
name: {
required: true,
default: 'Hello'
}
}
}
</script>
# 🔧 Options
{
"vue/no-required-prop-with-default": ["error", {
"autofix": false,
}]
}
"autofix"... Iftrue, enable autofix. (Default:false)