Skip to content

jsx_a11y/anchor-ambiguous-text Restriction ​

What it does ​

Inspects anchor link text for the use of ambiguous words.

This rule checks the text from the anchor element aria-label if available. In absence of an anchor aria-label it combines the following text of it's children:

  • aria-label if available
  • if the child is an image, the alt text
  • the text content of the HTML element

Why is this bad? ​

Screen readers users rely on link text for context, ambiguous words such as "click here" do not provide enough context.

Examples ​

Examples of incorrect code for this rule:

jsx
<a>link</a>
<a>click here</a>

Examples of correct code for this rule:

jsx
<a>read this tutorial</a>
<a aria-label="oxc linter documentation">click here</a>

How to use ​

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

bash
oxlint --deny jsx-a11y/anchor-ambiguous-text --jsx-a11y-plugin
json
{
  "plugins": ["jsx-a11y"],
  "rules": {
    "jsx-a11y/anchor-ambiguous-text": "error"
  }
}

References ​

Released under the MIT License.