← Back to rules

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:

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

Examples of correct code for this rule:

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

Configuration

This rule accepts a configuration object with the following properties:

words

type: string[]

default: ["click here", "here", "link", "a link", "learn more"]

List of ambiguous words or phrases that should be flagged in anchor text.

How to use

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

Config (.oxlintrc.json)

{
  "plugins": ["jsx-a11y"],
  "rules": {
    "jsx-a11y/anchor-ambiguous-text": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["jsx-a11y"],
  rules: {
    "jsx-a11y/anchor-ambiguous-text": "error",
  },
});

CLI

oxlint --deny jsx-a11y/anchor-ambiguous-text --jsx-a11y-plugin

Version

This rule was added in v0.13.2.

References

• Rule Source
• Upstream rule docs
• Open rule in Oxc Playground