vue/component-api-style ​

enforce component API style

📖 Rule Details ​

This rule aims to make the API style you use to define Vue components consistent in your project.

For example, if you want to allow only <script setup> and Composition API.
(This is the default for this rule.)

🔧 Options ​

{
  "vue/component-api-style": ["error",
    ["script-setup", "composition"] // "script-setup", "composition", "composition-vue2", or "options"
  ]
}

• Array options ... Defines the API styles you want to allow. Default is ["script-setup", "composition"]. You can use the following values.
  • "script-setup" ... If set, allows <script setup>.
  • "composition" ... If set, allows Composition API (not <script setup>).
  • "composition-vue2" ... If set, allows Composition API for Vue 2 (not <script setup>). In particular, it allows render, renderTracked and renderTriggered alongside setup.
  • "options" ... If set, allows Options API.

["options"] ​

🚀 Version ​

This rule was introduced in eslint-plugin-vue v7.18.0

🔍 Implementation ​

• Rule source
• Test source