# vue/require-explicit-emits
require
emitsoption with name triggered by$emit()
- ⚙️ This rule is included in
"plugin:vue/vue3-strongly-recommended"and"plugin:vue/vue3-recommended".
# 📖 Rule Details
This rule reports event triggers not declared with the emits option. (The emits option is a new in Vue.js 3.0.0+)
Explicit emits declaration serves as self-documenting code. This can be useful for other developers to instantly understand what events the component is supposed to emit.
Also, with attribute fallthrough changes in Vue.js 3.0.0+, v-on listeners on components will fallthrough as native listeners by default. Declare it as a component-only event in emits to avoid unnecessary registration of native listeners.
<template>
<!-- ✓ GOOD -->
<div @click="$emit('good')"/>
<!-- ✗ BAD -->
<div @click="$emit('bad')"/>
</template>
<script>
export default {
emits: ['good']
}
</script>
<script>
export default {
emits: ['good'],
methods: {
foo () {
// ✓ GOOD
this.$emit('good')
// ✗ BAD
this.$emit('bad')
}
}
}
</script>
<script>
export default {
emits: ['good'],
setup (props, context) {
// ✓ GOOD
context.emit('good')
// ✗ BAD
context.emit('bad')
}
}
</script>
# 🔧 Options
{
"vue/require-explicit-emits": ["error", {
"allowProps": false
}]
}
"allowProps"... Iftrue, allow event names defined inprops. defaultfalse
# "allowProps": true
<script>
export default {
props: ['onGood', 'bad'],
methods: {
foo () {
// ✓ GOOD
this.$emit('good')
// ✗ BAD
this.$emit('bad')
}
}
}
</script>
# 📚 Further Reading
- Guide - Custom Events / Defining Custom Events (opens new window)
- Vue RFCs - 0030-emits-option (opens new window)
# 🚀 Version
This rule was introduced in eslint-plugin-vue v7.0.0