vue/max-props

enforce maximum number of props in Vue component.

Applies to: Vue SFC templates and blocks, with script context where the rule requires it.

Bad

The component declares three props, above the configured maximum.

<script setup lang="ts">
defineProps<{ a: number; b: number; c: number }>();
</script>
<template>
  <p>props</p>
</template>

Good

The component declares one prop.

<script setup lang="ts">
defineProps<{ a: number }>();
</script>
<template>
  <p>props</p>
</template>

Configuration (Vite+)

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({}).withVue({
  linter: {
    "preset": "incremental",
    "rules": {
      "vue/max-props": "warn"
    },
    "ruleOptions": {
      "vue/max-props": {
        "maxProps": 2
      }
    }
  },
});

Then run vp run lint.

Related

• Vue rules
• All rules
• Source code