Documentation about Keys beyond usage in lists
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
The You Probably Don't Need Derived State post shows a pattern that uses the key prop to reset (force remount) elements in order to restart the component lifecycle: https://reactjs.org/blog/2018/06/07/you-probably-dont-need-derived-state.html#recommendation-fully-uncontrolled-component-with-a-key
It would be good to expand on that example in the main docs and discuss some of the pitfalls of that approach (for example, if a component is not written to account for changing data sources, the consumer must add a key to correctly reset the component).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked “You Probably Don’t Need Derived State” post and its fully uncontrolled component with a key example. Update the relevant main React documentation section with a comparable example and explain the reset behavior and pitfalls around changing data sources; done means the usage and caveats are clear to readers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100