angular / angular/components

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

Abierto
#28,933 2 comentarios 10 reacciones 0 asignados Ver en GitHub
docs M3 needs: discussion
Lenguaje dominante
TypeScript
Estrellas
25k
Forks
6.8k
Merge medio
1 d 8 h
PR fusionados (30 d)
91

Descripción

### 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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con la página afectada de documentación de la Autocomplete API en material.angular.io/components/autocomplete/api y revisa cómo está organizada la documentación de la API de los componentes. Resuelve con el equipo las preguntas abiertas sobre las descripciones de los tokens, la terminología y la ubicación. Se considera terminado cuando los tokens CSS expuestos se pueden encontrar en la documentación de la API del componente correspondiente y existe una guía de terminología acordada.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
angular, typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.