angular / angular/components

docs(material/theming): add tokens section to our docs

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

还没有人认领这个 Issue。

docs M3 needs: discussion
主要语言
TypeScript
星标
25k
派生
6.8k
平均合并
1 天 8 小时
30 天内合并 PR
91

描述

Documentation Feedback

Add documentation to material.angular.io to list the tokens that our components expose.

Design

There are still some open questions that the team should discuss.

  • Should we write a description for each token?
    • Critiques:
      • A unique description for every token may be too much data thrown at the user which the user might mentally filter out when looking through our docs.
      • Many tokens are self-explanatory. It seems silly to write "selected-checkmark-color": The color of the checkmark when the checkbox is selected.
    • A more useful approach may be to provide a subsection that explains terminology that is obscure to most users. For example, the section could describe the following:
      • What state-layer commonly refers to.
      • Listing the different states - active, pressed, etc. Material has a page dedicated to this we could also link to.
  • Where should this token list live?
    • IMO under the "API" tab for each component makes the most sense.

This design satisfies the following pain point for our users:

  • CSS variables are difficult to identify / discover.
Affected documentation page

https://material.angular.io/components/autocomplete/api

贡献指南

打开贡献指南

从这里开始

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

调研方向

从受影响的 Autocomplete API 文档页面 material.angular.io/components/autocomplete/api 开始,查看组件 API 文档的组织方式。与团队解决有关 token 描述、术语和放置位置的未决问题。完成的标准是:公开的 CSS token 可在适当的组件 API 文档中找到,并且术语指导已达成一致。

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

评估

技术栈
angular, typescript
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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