angular / angular/components

docs-bug(all): Add doc for mixins

Offen
#30,240 2 Kommentare 8 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area: dev-infra area: material.angular.io docs P3
Vorherrschende Sprache
TypeScript
Sterne
25k
Forks
6.8k
Ø Merge
1 T. 8 Std.
Gemergte PRs (30 T.)
91

Beschreibung

### Documentation Feedback

Add documentation for all the mixins and explain what they are used for and what the parameters are. This includes:
- Component mixins (examples: mat.button-theme, mat.button-color, mat.button-typography, mat.button-density, ...). I think this should be documented under the new styling tab on each component page. For now, there is only the new `overrides` mixin.
- Global mixins (examples: mat.get-theme-color, mat.define-theme, mat.core, mat.theme, mat.elevation-classes, mat.app-background, ...).

### Affected documentation page

https://material.angular.io/components/categories

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der betroffenen Dokumentationsseite unter material.angular.io/components/categories und überprüfe die vorhandene Dokumentation zur Komponentenformatierung, insbesondere den neuen Styling-Tab und das overrides mixin. Erstelle eine Bestandsaufnahme der im Issue aufgeführten Komponenten- und globalen Mixins und lege fest, welche Dokumentation jedes davon für seinen Zweck und seine Parameter benötigt; abgeschlossen ist die Aufgabe, wenn die relevanten Mixins an ihren vorgesehenen Komponenten- oder globalen Stellen dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
angular, typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.