mirror of
https://github.com/JamesIves/github-pages-deploy-action.git
synced 2023-12-15 20:03:39 +08:00
1.2 KiB
1.2 KiB
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.
References
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>