angular / angular/components

docs-bug(all): Add doc for mixins

Open
#30,240 2 comments 8 reactions 0 assignees View on GitHub
area: dev-infra area: material.angular.io docs P3
Dominant language
TypeScript
Stars
25k
Forks
6.8k
Avg merge
1d 8h
Merged PRs (30d)
91

Description

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

Contributor guide

Open the contributing guide

Research direction

Start with the affected documentation page at material.angular.io/components/categories and review the existing component styling documentation, especially the new styling tab and the overrides mixin. Inventory the component and global mixins listed in the issue, then define what documentation each needs for its purpose and parameters; done means the relevant mixins are documented in their intended component or global locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.