Skip to content
← Back to rules

jsx-a11y/no-redundant-roles 正确性

🛠️ An auto-fix is available for this rule.

它的作用

强制代码不要包含多余的 role 属性,前提是它与元素类型的隐式 role 属性相同。

为什么这不好?

多余的角色会导致代码库中的混淆和冗余。

示例

此规则适用于以下元素及其隐式角色:

  • <button>: button

以下是此规则的错误代码示例:

jsx
<button role="button"></button>

以下是此规则的正确代码示例:

jsx
<button></button>

选项

此规则接受一个对象,其键为元素名称,值为允许在该元素上出现的多余角色数组。提供某个条目会覆盖该元素的默认例外情况。

默认情况下,<nav> 上允许使用 role="navigation"。还可以允许其他角色,例如,为了保留一些浏览器在应用 list-style: none 时会移除的显式列表语义:

json
{
  "jsx-a11y/no-redundant-roles": ["error", { "ul": ["list"], "ol": ["list"], "li": ["listitem"] }]
}

配置

此规则接受一个包含以下属性的配置对象:

type: Record<string, array>

如何使用

To enable this rule using the config file or in the CLI, you can use:

json
{
  "plugins": ["jsx-a11y"],
  "rules": {
    "jsx-a11y/no-redundant-roles": "error"
  }
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["jsx-a11y"],
  rules: {
    "jsx-a11y/no-redundant-roles": "error",
  },
});
bash
oxlint --deny jsx-a11y/no-redundant-roles --jsx-a11y-plugin

版本

此规则已在 v0.2.1 中添加。

参考资料