Highlight Possible Necessity of keys for Conditional Rendering
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- JavaScript
- Estrelas
- 11.8k
- Forks
- 7.9k
- Merge médio
- 1d 11h
- PRs com merge (30d)
- 11
Descrição
Motivation
Keys may be necessary outside the context of any "list" or array, especially when using conditional rendering. This isn't emphasized enough in the docs, and examples (therein and elsewhere) tend to lead to a false association between keys as having directly to do with map(), <li> elements, or JavaScript arrays. As I understand it, at its root, keys have to do with children, and type correspondence based on position during reconciliation.
Related issues such as https://github.com/reactjs/reactjs.org/issues/79 don't seem to directly address this.
Personal Experience
Most recommendations I find online seem to boil down to "use keys when using map()"(or <li> or arrays). It's rare to find a discussion related to conditional rendering and most people tend to be unaware of it.
I've been in a project wherein conditional rendering was heavily used, which led to a hard to find bug due to the absence of keys.
Code snippet in render()
return (
<div>
{ this.state.showCounter2 ?
(
<React.Fragment>
<CounterWithLifeCycleLog name={'myCounter1'}
counter={0} />
<CounterWithLifeCycleLog name={'myCounter2'}
counter={this.state.counter2} />
<CounterWithLifeCycleLog name={'myCounter3'}
counter={0} />
</React.Fragment>
) : (
<React.Fragment>
<CounterWithLifeCycleLog name={'myCounter1'}
counter={0} />
<CounterWithLifeCycleLog name={'myCounter3'}
counter={0} />
</React.Fragment>
)
The above code has a bug. When this.state.showCounter2 moves from true to false myCounter3 will be unmounted instead of myCounter2. Then the new myCounter3 will reuse the backing instance of myCounter2, maintaining its internal state.
It is true that this could be avoided by using the following instead:
&& <CounterWithLifeCycleLog name={'myCounter2'}
counter={this.state.counter2} />
The former example, however, is valid conditional rendering as well.
Proposed solution
An explicit mention of this confusion, an example involving conditional rendering (not using <li>, map(), or arrays), and perhaps a link to this blog post and perhaps the How to force remounting on React components related stackoverflow question.
Also, currently, all warnings related to keys seem to either have to do with arrays or iterators, perhaps a light warning when using conditional rendering could be helpful (though I can see how this will add way too much clutter), or some way to incorporate it into existing warnings.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece localizando as seções da documentação do React que explicam keys, listas e reconciliação. Use o exemplo fornecido de renderização condicional para estabelecer a distinção em relação a map(), itens de lista e arrays. O trabalho estará concluído quando a documentação explicar claramente quando keys importam na renderização condicional e incluir um exemplo dedicado; quaisquer alterações nos avisos devem ser tratadas como escopo opcional.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript, react
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100