improve the phrasing for using "no keys" on https://reactjs.org/docs/lists-and-keys.html#keys
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 11.8k
- Forks
- 7.9k
- Merge moyen
- 1 j 11 h
- PR mergées (30 j)
- 11
Description
https://reactjs.org/docs/lists-and-keys.html#keys currently has a section that causes confusion about React's behaviour when omitting key attributes, currently reading:
"We don’t recommend using indexes for keys if the order of items may change. This can negatively impact performance and may cause issues with component state. Check out Robin Pokorny’s article for an in-depth explanation on the negative impacts of using an index as a key. If you choose not to assign an explicit key to list items then React will default to using indexes as keys."
The emphasized sentence has led to folks thinking that React knows what a specific map()'s iteration index is, and that it'll use that, rather than that the index talked about is the child index of the element in the vdom. To remove that confusion and make it explicit that React is using an internal index, I would recommend changing the phrasing here to:
"We don’t recommend using indexes for keys if the order of items may change. This can negatively impact performance and may cause issues with component state. Check out Robin Pokorny’s article for an in-depth explanation on the negative impacts of using an index as a key. If you choose not to assign an explicit key to list items then React will default to using element index in the virtual DOM tree as keys."
It might be even more high value to also add one or more sentences to explain that this means that the behaviour for consecutive maps that don't use keys vs. incorrectly use iteration indices as keys will lead to different behaviour, which folks right now mistakenly assume would behave the same.
E.g.
render() {
const { text, additional } = this.state;
const content = text.map(t => <p>{t}</p>);
const addenda = additional.map(t => <p className="add">{t}</p>);
return <section>{content}{addenda}</section>;
}
will work, but:
render() {
const { text, additional } = this.state;
const content = text.map((t,i) => <p>{t}</p>);
const addenda = additional.map((t,i) => <p className="add" key={i}>{t}</p>);
return <section>{content}{addenda}</section>;
}
will not, and if you are familiar enough with React already to not need the docs, you know why, but if you're not and you read the docs, it is entirely understandable if you come away convinced that this should work after reading the current text.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la section Keys à l’adresse https://reactjs.org/docs/lists-and-keys.html#keys et examinez la formulation concernant les Keys omises ainsi que les exemples fournis. Précisez que React utilise l’index de l’élément dans le virtual DOM tree, et déterminez si l’exemple avec des appels map consécutifs doit également être ajouté ; la documentation doit distinguer correctement les deux comportements.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, react
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100