reactjs / reactjs/react.dev

[Documentation] Add information about `child.key` to `React.Children.map`

Offen
#2,023 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
11.8k
Forks
7.9k
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
11

Beschreibung

I just spent quite a while debugging a performance issue when reordering a large list of components, which were wrapped in React.Children.map.

The issue was the implementation of the wrapping component, which used the index as the key, which caused the entire list to re-render from scratch:

<div>
  {React.Children.map(props.children, (child, index) => (
    <div key={index} className='...'>{child}</div>
  ))}
</div>

The solution was to use child.key and pass it into the child-component, which then, in turn, made the memoization of the child components work as expected:

<div>
  {React.Children.map(props.children, (child) => (
    <div key={child.key} className='...'>{child}</div>
  ))}
</div>

I feel like this should be mentioned somewhere on the documentation page for React.Children.map, since I only figured out that this is possible at all after specifically searching for it and finding #10432.

I'm happy to update the docs in a PR if this gets the OK :)

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit dem Abschnitt React.Children.map auf der im Issue verlinkten React API-Dokumentationsseite und prüfen Sie die zugehörige Diskussion in Issue #10432. Fügen Sie klare Informationen zu child.key und seiner Bedeutung beim Wrappen von Children hinzu und überprüfen Sie anschließend, dass die Dokumentation die vorgesehene Verwendung und den Performance-Aspekt erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.