Skip to content

Add react/no-array-index-key rule example to documentation #2219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/rules/no-array-index-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ The `key` is used by React to [identify which items have changed, are added, or

It's a bad idea to use the array index since it doesn't uniquely identify your elements. In cases where the array is sorted or an element is added to the beginning of the array, the index will be changed even though the element representing that index may be the same. This results in unnecessary renders.

## Example

Add to your eslint configuration file (usually `.estlintrc`)

```
{
"rules": {
"react/no-array-index-key": false // boolean
}
}

```

## Rule Details

The following patterns are considered warnings:
Expand Down