[Suggestion]: Reference: component prop list shoud be more readable
未关闭
还没有人认领这个 Issue。
type: documentation
- 主要语言
- JavaScript
- 星标
- 11.8k
- 派生
- 7.9k
- 平均合并
- 1 天 11 小时
- 30 天内合并 PR
- 11
描述
Summary
In my view, the current presentation of component props is somewhat unreadable and could benefit from refinement. This issue is particularly visible in long lists like this one: input props.
My propose is to improve indentations and alignment and to enhance visual clarity using existing tools:
- for the long lists, to use table
- for the short lists, to move description sentence into an inner nested list item and remove its bullet
- to remove articles (a/an) before types
P.S. I know, this is a bit influenced by the MDN Web Docs, but those are not poor UX decisions. Nonetheless, I welcome an active discussion on these suggestions.
Page
No response
Details
What it looks like now:
What it looks like with my suggestions applied:
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从链接的 React input props 参考页面开始,将其当前呈现方式与提供的屏幕截图进行比较。查看其他组件的 prop 列表,以确定长列表和短列表的情况,然后考虑提议的表格、嵌套描述、对齐方式以及移除文章;当受影响的参考页面的格式始终更加清晰时,这项工作就完成了。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, react
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 冷清
- 描述清晰度
- 需要澄清
- 新手友好度
- 45/100