[READ-ONLY] Mirror of https://github.com/sxzz/eslint-plugin-vuekit. Modern ESLint plugin for Vue 3 eslint-plugin-vuekit.sxzz.dev
eslint plugin vue
eslint-plugin-vuekit docs rules no-restricted-html-elements.md
2.1 kB · 100 lines
Markdown
at main


pageClass: rule-details sidebarDepth: 0 title: vue/no-restricted-html-elements description: disallow specific elements since: v8.6.0 #

vue/no-restricted-html-elements #

disallow specific elements

📖 Rule Details #

This rule allows you to specify HTML, SVG, and MathML elements that you don't want to use in your application.

<template>
  <!-- ✓ GOOD -->
  <p></p>
  <input />
  <br />

  <!-- ✗ BAD -->
  <button></button>
  <marquee></marquee>
</template>

🔧 Options #

This rule takes a list of strings, where each string is an element name to be restricted:

{
  "vue/no-restricted-html-elements": ["error", "a", "marquee"]
}
<template>
  <!-- ✗ BAD -->
  <a></a>
  <marquee></marquee>
</template>

Alternatively, the rule also accepts objects.

{
  "vue/no-restricted-html-elements": [
    "error",
    {
      "element": ["a", "RouterLink"],
      "message": "Prefer the use of <NuxtLink> component"
    },
    {
      "element": "marquee",
      "message": "Do not use deprecated HTML tags"
    }
  ]
}

The following properties can be specified for the object.

  • element ... Specify the element name or an array of element names.
  • message ... Specify an optional custom message.

{ "element": "marquee" }, { "element": "a" } #

<template>
  <!-- ✗ BAD -->
  <marquee></marquee>
  <a></a>
</template>

🚀 Version #

This rule was introduced in eslint-plugin-vue v8.6.0

🔍 Implementation #