[Docs] jsx-key: improve example
#3202
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Using an index for a key is a violation of the [no-array-index-key](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-array-index-key.md) lint rule
ljharb
approved these changes
Feb 11, 2022
docs/rules/jsx-key.md
Outdated
| @@ -22,7 +22,7 @@ Examples of **correct** code for this rule: | |||
| ```jsx | |||
| [<Hello key="first" />, <Hello key="second" />, <Hello key="third" />]; | |||
|
|
|||
| data.map((x, i) => <Hello key={i}>{x}</Hello>); | |||
| data.map(x => <Hello key={x.id}>{x}</Hello>); | |||
There was a problem hiding this comment.
Suggested change
| data.map(x => <Hello key={x.id}>{x}</Hello>); | |
| data.map((x) => <Hello key={x.id}>{x}</Hello>); |
Codecov Report
@@ Coverage Diff @@
## master #3202 +/- ##
=======================================
Coverage 97.63% 97.63%
=======================================
Files 121 121
Lines 8416 8416
Branches 3025 3025
=======================================
Hits 8217 8217
Misses 199 199 Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using an index for a key is a violation of the no-array-index-key lint rule, so it feel weird to me that we're showing it as an example for "correct" code, even though it isn't strictly a violation of the
js-keyrule.