Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wagnermaciel opened this issue Apr 22, 2024 · 0 comments
Open

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

wagnermaciel opened this issue Apr 22, 2024 · 0 comments
Labels
docs This issue is related to documentation M3 needs: discussion Further discussion with the team is needed before proceeding

Comments

@wagnermaciel
Copy link
Contributor

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

@wagnermaciel wagnermaciel added docs This issue is related to documentation needs triage This issue needs to be triaged by the team needs: discussion Further discussion with the team is needed before proceeding M3 and removed needs triage This issue needs to be triaged by the team labels Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation M3 needs: discussion Further discussion with the team is needed before proceeding
Projects
None yet
Development

No branches or pull requests

1 participant