order-in-components.md

pageClass	sidebarDepth	title	description
rule-details	0	vue/order-in-components	enforce order of properties in components

vue/order-in-components

enforce order of properties in components

• ⚙️ This rule is included in "plugin:vue/vue3-recommended" and "plugin:vue/recommended".
• 🔧 The --fix option on the command line can automatically fix some of the problems reported by this rule.

📖 Rule Details

This rule makes sure you keep declared order of properties in components. Recommended order of properties can be found here.

<script>
/* ✓ GOOD */
export default {
  name: 'app',
  props: {
    propA: Number
  },
  data () {
    return {
      msg: 'Welcome to Your Vue.js App'
    }
  }
}
</script>

<script>
/* ✗ BAD */
export default {
  name: 'app',
  data () {
    return {
      msg: 'Welcome to Your Vue.js App'
    }
  },
  props: {
    propA: Number
  }
}
</script>

🔧 Options

{
  "vue/order-in-components": ["error", {
    "order": [
      "el",
      "name",
      "key",
      "parent",
      "functional",
      ["delimiters", "comments"],
      ["components", "directives", "filters"],
      "extends",
      "mixins",
      ["provide", "inject"],
      "ROUTER_GUARDS",
      "middleware",
      "validate",
      "inheritAttrs",
      "model",
      ["props", "propsData"],
      "emits",
      "setup",
      "fetch",
      "asyncData",
      "data",
      "computed",
      "watch",
      "watchQuery",
      "LIFECYCLE_HOOKS",
      "methods",
      "head",
      "layout",
      ["template", "render"],
      "renderError",
      "transition",
      "loading",
      "scrollToTop"
    ]
  }]
}

• order ((string | string[])[]) ... The order of properties. Elements are the property names or one of the following groups:

  • LIFECYCLE_HOOKS: Vue Lifecycle Events, in the order they are called
  • ROUTER_GUARDS: Vue Router Navigation Guards, in the order they are called

  If an element is an array of strings, it means any of those can be placed there unordered. Default is above.

📚 Further reading

• Style guide - Component/instance options order

🔍 Implementation

• Rule source
• Test source