Docs regarding setState are in direct conflict with one another
還沒有人認領這個 Issue。
- 主要語言
- JavaScript
- 星號
- 11.8k
- 分支
- 7.9k
- 平均合併
- 1 天 11 小時
- 30 天內合併 PR
- 11
描述
In Introducting Hooks, and several other places, there is a simple counter example that illustrates how to use the useState hook.
function Example() {
// Declare a new state variable, which we'll call "count"
const [count, setCount] = useState(0);
return (
<div>
<p>You clicked {count} times</p>
<button onClick={() => setCount(count + 1)}>
Click me
</button>
</div>
);
}
However, there happens to be another counter example in the Hooks API Reference for useState.
function Counter({initialCount}) {
const [count, setCount] = useState(initialCount);
return (
<>
Count: {count}
<button onClick={() => setCount(initialCount)}>Reset</button>
<button onClick={() => setCount(prevCount => prevCount - 1)}>-</button>
<button onClick={() => setCount(prevCount => prevCount + 1)}>+</button>
</>
);
}
In this second example, a callback is being passed into the setState function, and the code is accompanied by the following language...
The ”+” and ”-” buttons use the functional form, because the updated value is based on the previous value.
This would imply that the first example (which is in a very prominent location in the docs by the way), is actually incorrect and is encouraging an anti-pattern.
I hope you can see how these two examples are in direct conflict with one another and might be causing confusion in the community!
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
閱讀 Introducing Hooks 和 Hooks API Reference 中的計數器範例,尤其是 functional-updates 部分,並比較其中關於 setState 的指引。解決這項不一致,讓文件對每種形式適用的時機提供一個清楚的說明,然後驗證連結的範例和周圍文字不再互相衝突。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- javascript, react
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100