# vue/valid-v-slot

enforce valid v-slot directives

⚙️ This rule is included in all of "plugin:vue/vue3-essential", "plugin:vue/essential", "plugin:vue/vue3-strongly-recommended", "plugin:vue/strongly-recommended", "plugin:vue/vue3-recommended" and "plugin:vue/recommended".

This rule checks whether every v-slot directive is valid.

# 📖 Rule Details

This rule reports v-slot directives in the following cases:

The directive is not owned by a custom element. E.g. <div v-slot=""></div>
The directive is a named slot and is on a custom element directly. E.g. <my-component v-slot:foo></my-component>
The directive is the default slot, is on a custom element directly, and there are other named slots. E.g. <my-component v-slot=""><template v-slot:foo></template></my-component>
The element which has the directive has another v-slot directive. E.g. <my-component v-slot:one v-slot:two></my-component>
The element which has the directive has another v-slot directive that is distributed to the same slot. E.g. <my-component><template v-slot:foo></template><template v-slot:foo></template></my-component>
The directive has a dynamic argument which uses the scope properties that the directive defined. E.g. <my-component><template v-slot:[data]="data"></template></my-component>
The directive has any modifier. E.g. <my-component v-slot.foo></my-component>
The directive is the default slot, is on a custom element directly, and has no value. E.g. <my-component v-slot></my-component>

<template>
  <!-- ✓ GOOD -->
  <my-component v-slot="data">
    {{data}}
  </my-component>
  <my-component>
    <template v-slot:default>
      default
    </template>
    <template v-slot:one>
      one
    </template>
    <template v-slot:two>
      two
    </template>
  </my-component>

  <!-- ✗ BAD -->
  <div v-slot="data">
    {{data}}
  </div>
  <div>
    <template v-slot:one>
      one
    </template>
  </div>

  <my-component v-slot:one="data">
    {{data}}
  </my-component>
  <my-component v-slot="data">
    {{data}}
    <template v-slot:one>
      one
    </template>
  </my-component>

  <my-component v-slot:one v-slot:two>
    one and two
  </my-component>
  <my-component>
    <template v-slot:one>
      one 1
    </template>
    <template v-slot:one>
      one 2
    </template>
  </my-component>

  <my-component>
    <template v-slot:[data]="data">
      dynamic?
    </template>
  </my-component>

  <my-component v-slot.mod="data">
    {{data}}
  </my-component>

  <my-component v-slot>
    content
  </my-component>
</template>

Now loading...

Note

This rule does not check syntax errors in directives because it's checked by vue/no-parsing-error rule.

# 🔧 Options

{
  "vue/valid-v-slot": ["error", {
    "allowModifiers": false
  }]
}

allowModifiers (boolean) ... allows having modifiers in the argument of v-slot directives. Modifiers just after v-slot are still disallowed. E.g. <template v-slot.foo> default false.

# `allowModifiers: true`

<template>
  <!-- ignore -->
  <MyComponent>
    <template v-slot:foo></template>
    <template v-slot:foo.bar></template>
    <template v-slot:foo.baz></template>
    <template v-slot:foo.bar.baz></template>
  </MyComponent>

  <!--  ✗ BAD */ -->
  <MyComponent v-slot.foo="{data}">
    {{ data }}
  </MyComponent>
  <MyComponent>
    <template v-slot.foo>
      bar
    </template>
  </MyComponent>
</template>

Now loading...

vue/no-parsing-error

# 🚀 Version

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

# 🔍 Implementation

← vue/valid-v-show vue/valid-v-text →