[Suggestion]: Adding documentation to note that Effects in children components are committed before their parent component
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 11
説明
Summary
Adding documentation to the useEffect page to note that Effects in children components are committed before their parent component
Page
https://react.dev/reference/react/useEffect
Details
Hi
I was digging into React internals and learning how it works under the hood. I came across an interesting behaviour in Effects -- where the Effects in children components are committed before their parent component.
For example:
function Parent({ children }) {
useEffect(() => {
console.log("Parent committed effect");
}, []);
return <div>{children}</div>;
}
function Child() {
useEffect(() => {
console.log("Child committed effect");
}, []);
return <p>Child</p>;
}
export default function App() {
return (
<Parent>
<Child />
</Parent>
);
}
The result in the console will be
Child committed effect
Parent committed effect
(I made a small animation describing the traversal)
I understand that it is due to how React traverses the Fiber tree during the Commit phase (recursivelyTraversePassiveMountEffects), but it seems like it does confuse some people in
- https://github.com/facebook/react/issues/15281
- https://www.reddit.com/r/reactjs/comments/1447nft/how_the_useeffect_work_in_react/
This is not a bug, but I think it would be helpful to have this documented, perhaps in the Caveats or the Troubleshooting section to avoid confusion around this "unexpected behaviour".
What do you think? :)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず useEffect のリファレンスページ、特に Caveats と Troubleshooting のセクションを確認し、その後、背景を理解するためにリンクされている ReactFiberCommitWork.js のトラバーサルを確認します。ページが、報告された例を使用して、子の Effects が親の Effects より先に committed されることを明確に文書化し、この挙動がバグであることを示唆しないようになれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, react
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 50/100