jsx-a11y-anchor-has-content.md

@typehut/jsx-a11y-anchor-has-content

Enforce that anchors have content and that the content is accessible to screen readers

Accessible means that it is not hidden using the aria-hidden prop. Refer to the references to learn about why this is important.

Rule Details

This rule takes one optional object argument of type object:

{
  "rules": {
    "jsx-a11y/anchor-has-content": [
      2,
      {
        "components": ["Anchor"]
      }
    ]
  }
}

For the components option, these strings determine which JSX elements (always including <a>) should be checked for having content. This is a good use case when you have a wrapper component that simply renders an a element (like in React):

// Anchor.js
const Anchor = props => {
  return (
    <a {...props}>{ props.children }</a>
  );
}

...

// CreateAccount.js (for example)
...
return (
  <Anchor>Create Account</Anchor>
);

Succeed

<a>Anchor Content!</a>
<a><TextWrapper /><a>
<a dangerouslySetInnerHTML={{ __html: 'foo' }} />

Fail

<a />
<a><TextWrapper aria-hidden /></a>

Options

This rule has an object option for an exception:

• "components" string[] If you want to apply a rule to a custom component, write it here.
• "ignoreAttributeInner" false (default: true) Ignore rule if element is inside component attribute.
• "attributeTracingDepth" -1 (default: 4) The number of AST nodes trace when applying ignoreAttributeInner. Specify -1 to trace indefinitely.

Accessibility guidelines

• WCAG 2.4.4
• WCAG 4.1.2

Resources

• axe-core, link-name

Implementation

• Rule source
• Test source