noAutofocus

Diagnostic Category: lint/a11y/noAutofocus

JSX and TSX

Since: v1.0.0

Sources:

Same as: jsx-a11y/no-autofocus

Description

Enforce that autoFocus prop is not used on elements.

Autofocusing elements can cause usability issues for sighted and non-sighted users, alike. But the autofocus attribute should be added to the element the user is expected to interact with immediately upon opening a modal dialog or popover.

Examples

Invalid

<input autoFocus />

code-block.jsx:1:8 lint/a11y/noAutofocus  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Avoid the autoFocus attribute.
  
  > 1 │ <input autoFocus />
      │        ^^^^^^^^^
    2 │ 
  
  ℹ Unsafe fix: Remove the autoFocus attribute.
  
    1 │ <input·autoFocus·/>
      │        ----------

<input autoFocus="true" />

code-block.jsx:1:8 lint/a11y/noAutofocus  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Avoid the autoFocus attribute.
  
  > 1 │ <input autoFocus=“true” />
      │        ^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Unsafe fix: Remove the autoFocus attribute.
  
    1 │ <input·autoFocus=“true”·/>
      │        -----------------

<input autoFocus={"false"} />

code-block.jsx:1:8 lint/a11y/noAutofocus  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Avoid the autoFocus attribute.
  
  > 1 │ <input autoFocus={“false”} />
      │        ^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Unsafe fix: Remove the autoFocus attribute.
  
    1 │ <input·autoFocus={“false”}·/>
      │        --------------------

<input autoFocus={undefined} />

code-block.jsx:1:8 lint/a11y/noAutofocus  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Avoid the autoFocus attribute.
  
  > 1 │ <input autoFocus={undefined} />
      │        ^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Unsafe fix: Remove the autoFocus attribute.
  
    1 │ <input·autoFocus={undefined}·/>
      │        ----------------------

Valid

<input />

<div />

<button />

// `autoFocus` prop in user created component is valid
<MyComponent autoFocus={true} />

// `autoFocus` prop in element has `popover` attribute is valid
<div popover><input autoFocus /></div>

// `autoFocus` prop in `dialog` is valid
<dialog><input autoFocus /></dialog>

Resources

How to configure

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