noAriaHiddenOnFocusable

import { Tabs, TabItem } from '@astrojs/starlight/components';

<Tabs> <TabItem label="JSX and TSX" icon="seti:javascript"> ## Summary - Rule available since: `v1.4.0` - Diagnostic Category: [`lint/a11y/noAriaHiddenOnFocusable`](/reference/diagnostics#diagnostic-category) - This rule is **recommended**, meaning it is enabled by default. - This rule has an [**unsafe**](/linter/#unsafe-fixes) fix. - The default severity of this rule is [**error**](/reference/diagnostics#error). - Sources: - Same as [`jsx-a11y/no-aria-hidden-on-focusable`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/docs/rules/no-aria-hidden-on-focusable.md)

How to configure

json

{
	"linter": {
		"rules": {
			"a11y": {
				"noAriaHiddenOnFocusable": "error"
			}
		}
	}
}

Description

Enforce that aria-hidden="true" is not set on focusable elements.

aria-hidden="true" can be used to hide purely decorative content from screen reader users. A focusable element with aria-hidden="true" can be reached by keyboard. This can lead to confusion or unexpected behavior for screen reader users.

Example

Invalid

jsx

<div aria-hidden="true" tabIndex="0" />

<pre class="language-text"><code class="language-text">code-block.jsx:1:1 <a href="https://biomejs.dev/linter/rules/no-aria-hidden-on-focusable">lint/a11y/noAriaHiddenOnFocusable</a> FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ✖ Disallow aria-hidden="true" from being set on focusable elements. > 1 │ <div aria-hidden="true" tabIndex="0" /> │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 2 │ ℹ aria-hidden should not be set to true on focusable elements because this can lead to confusing behavior for screen reader users. ℹ Unsafe fix: Remove the aria-hidden attribute from the element. 1 │ <div·aria-hidden="true"·tabIndex="0"·/> │ ------------------- </code></pre>

jsx

<a href="/" aria-hidden="true" />

<pre class="language-text"><code class="language-text">code-block.jsx:1:1 <a href="https://biomejs.dev/linter/rules/no-aria-hidden-on-focusable">lint/a11y/noAriaHiddenOnFocusable</a> FIXABLE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ✖ Disallow aria-hidden="true" from being set on focusable elements. > 1 │ <a href="/" aria-hidden="true" /> │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 2 │ ℹ aria-hidden should not be set to true on focusable elements because this can lead to confusing behavior for screen reader users. ℹ Unsafe fix: Remove the aria-hidden attribute from the element. 1 │ <a·href="/"·aria-hidden="true"·/> │ ------------------- </code></pre>

Valid

jsx

<button aria-hidden="true" tabIndex="-1" />

jsx

<button aria-hidden="true" tabIndex={-1} />

jsx

<div aria-hidden="true"><a href="#"></a></div>

Resources

</TabItem> </Tabs>