[DOCS] Add a clear explanation for the difference between children and [children]
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 11.8k
- Forks
- 7.9k
- Merge medio
- 1 d 11 h
- PR fusionados (30 d)
- 11
Descripción
related issues (from the react repo): 1493 8731 15623
Most of these cases may summed up to this simple snippet:
class App extends React.Component {
state = { condition: false };
toggle = () => this.setState(({ condition }) => ({ condition: !condition }));
renderToggleBtn = () => <button onClick={this.toggle}>toggle</button>;
renderChildren = () => [1, 2].map(o => <Child key={o} id={o} />);
render() {
const { condition } = this.state;
if (condition) {
return (
<div>
<Parent>{this.renderChildren()}</Parent>
{this.renderToggleBtn()}
</div>
);
} else {
return (
<div>
<Parent>
{this.renderChildren()}
<div>dummy</div>
</Parent>
{this.renderToggleBtn()}
</div>
);
}
}
}
On each change of the condition Boolean the Child components will get unmounted and mounted again, this obviously may lead to bugs or unexpected behavior (lost of state).
This happens because when react "sees" a single child as children it will ref to the child element itself (like mentioned on some of the issues i listed above) but when children is a multiple element list it will treat it as an array, since arrays can't have keys (they absolutely can't right?) react can't keep a reference to it, thus it will hit a different type in the reconciliation process hence we get a re-creation of the tree (I remember i read somewhere in the source code that Fragment without a key is treated the same way but can't find it now).
If we focus on the <Parent/> part of the tree,
on the 1st condition case we get an element that roughly looks like this:
{
type: Parent,
children: [
{type: Child}, // <-- keep an eye for this item's type
{type: Child},
]
};
And on the 2nd condition case we get an element that roughly looks like this:
{
type: Parent,
children: [
[{type: Child},{type: Child}], // <-- keep an eye for this item's type
{type: 'div', children: 'dummy'}
]
}
So we end up comparing the types of the first member of `children:
type Child -> type Array // different type, re-create the node tree
We need somehow to keep the same type or provide a consistent key to prevent the mismatch.
Some possible solutions could be:
- Wrapping the array of
Child's with an element or a transparent keyedFragment
renderChildren = () => (
<React.Fragment key="dont-remount-pls">
{[1, 2].map(o => (
<Child key={o} id={o} />
))}
</React.Fragment>
);
This way we kind of hacking and bypassing the limitation of passing a key to an array.
- Maybe a better and more readable solution is to use the
&&operator instead ofif elsewhich will create a "hole" in the tree for the<div>dummy</div>element and this will forcechildrento always be a multiple elements list.
render() {
const { condition } = this.state;
return (
<div>
<Parent>{this.renderChildren()}</Parent>
{this.renderToggleBtn()}
{condition && <div>dummy</div>}
</div>
);
}
So we end up toggling between these 2 results:
When the condition is true
{
type: Parent,
children: [
[{type: Child},{type: Child}], // <-- keep an eye for this item's type
{type: 'div', children: 'dummy'}
]
}
When the condition is false
{
type: Parent,
children: [
[{type: Child},{type: Child}], // <-- keep an eye for this item's type
null
]
}
And in diffing:
type Array -> type Array // same type, do not re-create the node tree
while the question if this is considered a bug / abstraction leak or a design decision may be arguable, I think that we should at least document it clearly. I couldn't find any info regarding this behavior (except the issues posted above :point_up: and some digging in the source code).
Maybe its also good to call the returning JSX via if else as none best practice? (it may throw some hit at react but its better than a frustrated developer ), maybe even a lint rule?
If you think this should land on the official DOCS, I don't mind doing the PR but i may need some help with wording and i may also have some technical mistakes regarding on how i think it works as i described in this issue. 🙂
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando el fragmento de reproducción y las issues relacionadas de React 1493, 8731 y 15623; después, verifica el comportamiento descrito de children frente a [children] antes de redactar el texto. Se considera hecho cuando la documentación oficial explica claramente el comportamiento, sus consecuencias para el estado de los componentes y la forma recomendada de evitar remounts no intencionados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, react
- Área
- documentation, frontend
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100