useUniqueElementIds

JSX and TSX

Summary

Rule available since: v2.0.0
Diagnostic Category: lint/nursery/useUniqueElementIds
This rule doesn’t have a fix.
The default severity of this rule is error.
This rule belongs to the following domains:
- react

Description

Prevent the usage of static string literal id attribute on elements.

In React, hardcoding IDs is discouraged because IDs have to be unique in the DOM. You should use useId to generate unique IDs for accessibility purposes.

Please keep in mind this rule doesn’t check whether ids are actually unique or not, and does check whether static literal id isn’t passed to the elements or not. So you’re encouraged to check by yourself if the ids are actually unique.

Examples

Invalid

1
<div id="foo">bar</div>;

code-block.jsx:1:1 lint/nursery/useUniqueElementIds ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ id attribute should not be a static string literal. Generate unique IDs using useId().
  
  > 1 │ <div id=“foo”>bar</div>;
      │ ^^^^^^^^^^^^^^
    2 │ 
  
  ℹ In React, if you hardcode IDs and use the component multiple times, it can lead to duplicate IDs in the DOM. Instead, generate unique IDs using useId().

1
React.createElement("div", { id: "foo" });

code-block.jsx:1:1 lint/nursery/useUniqueElementIds ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ id attribute should not be a static string literal. Generate unique IDs using useId().
  
  > 1 │ React.createElement(“div”, { id: “foo” });
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ In React, if you hardcode IDs and use the component multiple times, it can lead to duplicate IDs in the DOM. Instead, generate unique IDs using useId().

Valid

1
const id = useId();
2
<div id={id}>bar</div>;

1
const id = useId();
2
React.createElement("div", { id });

Options

The following option is available

`excludedComponents`

List of unqualified component names to ignore. Use it to list components expecting an id attribute that does not represent a DOM element ID.

Default: empty list.

1
{
2
    "options": {
3
        "excludedComponents": [
4
            "FormattedMessage"
5
        ]
6
    }
7
}

1
<FormattedMessage id="static" />

1
<Library.FormattedMessage id="static" />

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useUniqueElementIds": "error"
6
      }
7
    }
8
  }
9
}