Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 1.47 KB

jsx-key.md

File metadata and controls

58 lines (36 loc) · 1.47 KB

Detect missing key prop (react/jsx-key)

Warn if an element that likely requires a key prop--namely, one present in an array literal or an arrow function expression.

Rule Details

The following patterns are considered warnings:

[<Hello />, <Hello />, <Hello />];

data.map(x => <Hello>{x}</Hello>);

<Hello {...{ key: id, id, caption }} />

In the last example the key is being spread, which is currently possible, but discouraged in favor of the statically provided key.

The following patterns are not considered warnings:

[<Hello key="first" />, <Hello key="second" />, <Hello key="third" />];

data.map((x, i) => <Hello key={i}>{x}</Hello>);

<Hello key={id} {...{ id, caption }} />

Rule Options

...
"react/jsx-key": [<enabled>, { "checkFragmentShorthand": <boolean> }]
...

checkFragmentShorthand (default: false)

When true the rule will check if usage of the shorthand fragment syntax requires a key. This option was added to avoid a breaking change and will be the default in the next major version.

The following patterns are considered warnings:

[<></>, <></>, <></>];

data.map(x => <>{x}</>);

When not to use

If you are not using JSX then you can disable this rule.

Also, if you have some prevalent situation where you use arrow functions to return JSX that will not be held in an iterable, you may want to disable this rule.