Skip to content

docs: remove color property from remaining examples and overview pages and make description comment consistent across components #29345

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

Merged
merged 1 commit into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</mat-form-field>
<!-- #docregion action-bar -->
<mat-action-row>
<button mat-button color="primary" (click)="nextStep()">Next</button>
<button mat-button (click)="nextStep()">Next</button>
</mat-action-row>
<!-- #enddocregion action-bar -->
</mat-expansion-panel>
Expand All @@ -39,8 +39,8 @@
</mat-form-field>

<mat-action-row>
<button mat-button color="warn" (click)="prevStep()">Previous</button>
<button mat-button color="primary" (click)="nextStep()">Next</button>
<button mat-button (click)="prevStep()">Previous</button>
<button mat-button (click)="nextStep()">Next</button>
</mat-action-row>
</mat-expansion-panel>

Expand All @@ -60,8 +60,8 @@
<mat-datepicker #picker></mat-datepicker>

<mat-action-row>
<button mat-button color="warn" (click)="prevStep()">Previous</button>
<button mat-button color="primary" (click)="nextStep()">End</button>
<button mat-button (click)="prevStep()">Previous</button>
<button mat-button (click)="nextStep()">End</button>
</mat-action-row>
</mat-expansion-panel>
</mat-accordion>
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@if (shouldRun) {
<div class="example-container" [class.example-is-mobile]="mobileQuery.matches">
<mat-toolbar color="primary" class="example-toolbar">
<mat-toolbar class="example-toolbar">
<button mat-icon-button (click)="snav.toggle()"><mat-icon>menu</mat-icon></button>
<h1 class="example-app-name">Responsive App</h1>
</mat-toolbar>
Expand Down
7 changes: 5 additions & 2 deletions src/material/badge/badge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,11 @@ export class _MatBadgeStyleLoader {}
})
export class MatBadge implements OnInit, OnDestroy {
/**
* The color of the badge. Can be `primary`, `accent`, or `warn`.
* Not recommended in M3, for more information see https://material.angular.io/guide/material-2-theming#optional-add-backwards-compatibility-styles-for-color-variants.
* Theme color of the badge. This API is supported in M2 themes only, it
* has no effect in M3 themes.
*
* For information on applying color variants in M3, see
* https://material.angular.io/guide/theming#using-component-color-variants.
*/
@Input('matBadgeColor')
get color(): ThemePalette {
Expand Down
7 changes: 7 additions & 0 deletions src/material/button/fab.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ import {ThemePalette} from '@angular/material/core';

/** Default FAB options that can be overridden. */
export interface MatFabDefaultOptions {
/**
* Default theme color of the button. This API is supported in M2 themes
* only, it has no effect in M3 themes.
*
* For information on applying color variants in M3, see
* https://material.angular.io/guide/theming#using-component-color-variants
*/
color?: ThemePalette;
}

Expand Down
6 changes: 4 additions & 2 deletions src/material/checkbox/checkbox-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ import {ThemePalette} from '@angular/material/core';
/** Default `mat-checkbox` options that can be overridden. */
export interface MatCheckboxDefaultOptions {
/**
* Default theme color palette to be used for checkboxes. This API is supported in M2 themes
* only, it has no effect in M3 themes. For information on applying color variants in M3, see
* Default theme color of the checkbox. This API is supported in M2 themes
* only, it has no effect in M3 themes.
*
* For information on applying color variants in M3, see
* https://material.angular.io/guide/theming#using-component-color-variants
*/
color?: ThemePalette;
Expand Down
8 changes: 0 additions & 8 deletions src/material/checkbox/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,6 @@ Default behavior of `mat-checkbox`. Always set `indeterminate` to `false`
when user click on the `mat-checkbox`.
This matches the behavior of native `<input type="checkbox">`.

### Theming

The color of a `<mat-checkbox>` can be changed by specifying a `$color-variant` when applying the
`mat.checkbox-theme` or `mat.checkbox-color` mixins (see the
[theming guide](/guide/theming#using-component-color-variants) to learn more.) By default,
checkboxes use the theme's primary palette. This can be changed to `'secondary'`, `'tertiary'`,
or `'error'`.

### Accessibility

`MatCheckbox` uses an internal `<input type="checkbox">` to provide an accessible experience.
Expand Down
8 changes: 0 additions & 8 deletions src/material/chips/chips.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,6 @@ Use the `MAT_CHIPS_DEFAULT_OPTIONS` token to specify default options for the chi
})
```

### Theming

The color of a `<mat-datepicker>` can be changed by specifying a `$color-variant` when applying the
`mat.datepicker-theme` or `mat.datepicker-color` mixins (see the
[theming guide](/guide/theming#using-component-color-variants) to learn more.) By default, the
datepicker uses the theme's primary palette. This can be changed to `'secondary'`, `'tertiary'`,
or `'error'`.

### Interaction Patterns

The chips components support 3 user interaction patterns, each with its own container and chip elements:
Expand Down
12 changes: 8 additions & 4 deletions src/material/datepicker/datepicker-base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,9 @@ export interface MatDatepickerPanel<
closedStream: EventEmitter<void>;
/**
* Color palette to use on the datepicker's calendar. This API is supported in M2 themes only, it
* has no effect in M3 themes. For information on applying color variants in M3, see
* has no effect in M3 themes.
*
* For information on applying color variants in M3, see
* https://material.angular.io/guide/theming#using-component-color-variants
*/
color: ThemePalette;
Expand Down Expand Up @@ -379,9 +381,11 @@ export abstract class MatDatepickerBase<
@Input() startView: 'month' | 'year' | 'multi-year' = 'month';

/**
* Color palette to use on the datepicker's calendar. This API is supported in M2 themes only, it
* has no effect in M3 themes. For information on applying color variants in M3, see
* https://material.angular.io/guide/theming#using-component-color-variants
* Theme color of the datepicker's calendar. This API is supported in M2 themes only, it
* has no effect in M3 themes.
*
* For information on applying color variants in M3, see
* https://material.angular.io/guide/theming#using-component-color-variants.
*/
@Input()
get color(): ThemePalette {
Expand Down
8 changes: 0 additions & 8 deletions src/material/datepicker/datepicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,6 @@ As with other types of `<input>`, the datepicker works with `@angular/forms` dir

<!-- example(datepicker-value) -->

### Changing the datepicker colors

The color of the datepicker can be changed by specifying a `$color-variant` when applying the
`mat.datepicker-theme` or `mat.datepicker-color` mixins (see the
[theming guide](/guide/theming#using-component-color-variants) to learn more.) By default, the
datepicker uses the theme's primary palette. This can be changed to `'secondary'`, `'tertiary'`, or
`'error'`.

### Date validation

There are three properties that add date validation to the datepicker input. The first two are the
Expand Down
6 changes: 4 additions & 2 deletions src/material/form-field/form-field.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,10 @@ export interface MatFormFieldDefaultOptions {
/** Default form field appearance style. */
appearance?: MatFormFieldAppearance;
/**
* Default color of the form field. This API is supported in M2 themes only, it has no effect in
* M3 themes. For information on applying color variants in M3, see
* Default theme color of the form field. This API is supported in M2 themes only, it has no
* effect in M3 themes.
*
* For information on applying color variants in M3, see
* https://material.angular.io/guide/theming#using-component-color-variants
*/
color?: ThemePalette;
Expand Down
1 change: 0 additions & 1 deletion tools/public_api_guard/material/button.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ export class MatFabButton extends MatButtonBase {

// @public
export interface MatFabDefaultOptions {
// (undocumented)
color?: ThemePalette;
}

Expand Down
Loading