[Docs] React.cloneElement and forwarding ref
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 11
説明
Hi, I believe the documentation about React.cloneElement is not very clear about handling refs.
I am talking about that part: https://reactjs.org/docs/react-api.html#cloneelement
However, it also preserves refs. This means that if you get a child with a ref on it, you won’t accidentally steal it from your ancestor. You will get the same ref attached to your new element.
Now, let's see consider the following use case (simplified):
const ChangeTitle = ({ children, ...otherProps }) =>
React.cloneElement(children, {
...otherProps,
title: 'Title was changed'
})
function MyComponent() {
const myRef = React.useRef()
return (
<ChangeTitle ref={myRef}>
<span>This is my component</span>
</ChangeTitle>
)
}
This throws a console warning about ChangeTitle unable to hold a ref.
In my original understanding of the docs, I though ChangeTitle would become the cloned element, which, as the docs explains, retain it's original ref, hance the one given by Mycomponent.
Instead, this is obviously wrong, and the cloned element would only retain a ref if it was given to itself, not the parent component, hence something like <span ref={spanRef}>This is my component</span>.
I guess the fix to the above code is the following:
const ChangeTitle = React.forwardRef(({ children, ...otherProps }, ref) =>
React.cloneElement(children, {
...otherProps,
ref,
title: 'Title was changed'
}))
Correct?
Is it worth adding specifically that cloneElement can contain the ref prop if used with React.forwardRef in a functional component?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue にリンクされている React API cloneElement セクションを確認し、ref に関する記述を提供された ChangeTitle の例と比較してください。どの ref が保持されるのか、また React.forwardRef で ref を渡せる仕組みを明確にしてください。説明が警告と修正後の使い方を正確に記述できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- react
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100