angular / angular/components

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

Aperta
#28,933 2 commenti 10 reazioni 0 assegnatari Vedi su GitHub
docs M3 needs: discussion
Lingua principale
TypeScript
Stelle
25k
Fork
6.8k
Merge medio
1g 8h
PR unite (30g)
91

Descrizione

### 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](https://m2.material.io/design/interaction/states.html#usage) 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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla pagina della documentazione dell’Autocomplete API interessata all’indirizzo material.angular.io/components/autocomplete/api e verifica come è organizzata la documentazione dell’API dei componenti. Risolvi con il team le questioni aperte relative alle descrizioni dei token, alla terminologia e alla collocazione. Il lavoro è completato quando i token CSS esposti sono individuabili nella documentazione dell’API del componente appropriato, con linee guida terminologiche concordate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
angular, typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.