patternfly / patternfly/patternfly-react
Templates(select) - improve documentation around initial selections
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 862
- フォーク
- 392
- 平均マージ
- 4日 8時間
- マージ済み PR(30日)
- 9
説明
The docs aren't clear about how to go about setting an initial selection for the different selects. It is the same pattern, and the examples use it (setting a selected prop on an option), but it would be helpful to explain this in the docs.
Also, currently you can still pass selected to the templates because the props tables extend SelectProps, but this is currently nonfunctional to a user since state is managed internally. My thought is we can exclude the prop from the extension, and potentially add an initialSelection prop as a more direct way of setting an initial selection (and an alternative to the option prop method that currently exists).
Jira Issue: PF-34
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
テンプレートのドキュメント、その select の例、および SelectProps を拡張している props テーブルを見つけます。まず、異なる select で既存の選択済みオプションのパターンがどのように説明されているかを比較します。初期選択の動作が明確にドキュメント化され、selected と考えられる initialSelection prop の API 上の扱いが解決され、一貫して反映されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- react, typescript
- 領域
- documentation, frontend
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 55/100