patternfly / patternfly/patternfly-react

Templates(select) - improve documentation around initial selections

未关闭
#10,842 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

PF Team Stale
主要语言
TypeScript
星标
862
派生
392
平均合并
4 天 8 小时
30 天内合并 PR
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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

查找模板文档、其中的 select 示例,以及扩展 SelectProps 的 props 表;先比较不同 select 中对现有选中选项模式的描述方式。完成的标准是:初始选择行为得到清晰记录,并且 API 中对 selected 与可能的 initialSelection prop 的处理得到明确,并保持一致地反映出来。

由索引模型根据 Issue 内容生成。

评估

技术栈
react, typescript
领域
documentation, frontend
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
55/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。