docs(multiple): Update color input comments to standarize across the components (#29254)

amysorto · web-flow · commit 27503ed285f3 · 2024-06-13T14:17:59.000-07:00
diff --git a/src/material/button/button-base.ts b/src/material/button/button-base.ts
@@ -108,11 +108,11 @@ export class MatButtonBase implements AfterViewInit, OnDestroy {
   }
 
   /**
-   * Theme color palette of the button. This API is supported in M2 themes
-   * only, it has no effect in M3 themes.
+   * 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
+   * https://material.angular.io/guide/theming#using-component-color-variants.
    */
   @Input() color?: string | null;
 
diff --git a/src/material/checkbox/checkbox.ts b/src/material/checkbox/checkbox.ts
@@ -203,9 +203,11 @@ export class MatCheckbox
   // TODO(crisbeto): this should be a ThemePalette, but some internal apps were abusing
   // the lack of type checking previously and assigning random strings.
   /**
-   * Palette 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
+   * 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.
    */
   @Input() color: string | undefined;
 
diff --git a/src/material/chips/chip.ts b/src/material/chips/chip.ts
@@ -173,9 +173,11 @@ export class MatChip implements OnInit, AfterViewInit, AfterContentInit, DoCheck
 
   // TODO: should be typed as `ThemePalette` but internal apps pass in arbitrary strings.
   /**
-   * Theme color palette of the chip. 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 chip. 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() color?: string | null;
 
diff --git a/src/material/datepicker/datepicker-base.ts b/src/material/datepicker/datepicker-base.ts
@@ -145,7 +145,13 @@ export class MatDatepickerContent<S, D = ExtractDateTypeFromSelection<S>>
   /** Reference to the internal calendar component. */
   @ViewChild(MatCalendar) _calendar: MatCalendar<D>;
 
-  /** Palette color of the internal calendar. */
+  /**
+   * Theme color of the internal 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() color: ThemePalette;
 
   /** Reference to the datepicker that created the overlay. */
diff --git a/src/material/form-field/form-field.ts b/src/material/form-field/form-field.ts
@@ -213,9 +213,11 @@ export class MatFormField
   private _hideRequiredMarker = false;
 
   /**
-   * The color palette for 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
+   * 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.
    */
   @Input() color: ThemePalette = 'primary';
 
diff --git a/src/material/list/selection-list.ts b/src/material/list/selection-list.ts
@@ -93,7 +93,14 @@ export class MatSelectionList
   @Output() readonly selectionChange: EventEmitter<MatSelectionListChange> =
     new EventEmitter<MatSelectionListChange>();
 
-  /** Theme color of the selection list. This sets the checkbox color for all list options. */
+  /**
+   * Theme color of the selection list. This sets the checkbox color for all
+   * list options. 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() color: ThemePalette = 'accent';
 
   /**
diff --git a/src/material/paginator/paginator.ts b/src/material/paginator/paginator.ts
@@ -122,7 +122,13 @@ export class MatPaginator implements OnInit, OnDestroy {
   private _isInitialized = false;
   private _initializedStream = new ReplaySubject<void>(1);
 
-  /** Theme color to be used for the underlying form controls. */
+  /**
+   * Theme color of the underlying form controls. 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() color: ThemePalette;
 
   /** The zero-based page index of the displayed list of items. Defaulted to 0. */
diff --git a/src/material/radio/radio.ts b/src/material/radio/radio.ts
@@ -152,7 +152,13 @@ export class MatRadioGroup implements AfterContentInit, OnDestroy, ControlValueA
   @ContentChildren(forwardRef(() => MatRadioButton), {descendants: true})
   _radios: QueryList<MatRadioButton>;
 
-  /** Theme color for all of the radio buttons in the group. */
+  /**
+   * Theme color of the radio buttons in the group. 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() color: ThemePalette;
 
   /** Name of the radio button group. All radio buttons inside this group will use this name. */
diff --git a/src/material/slide-toggle/slide-toggle.ts b/src/material/slide-toggle/slide-toggle.ts
@@ -155,7 +155,13 @@ export class MatSlideToggle
 
   // TODO(crisbeto): this should be a ThemePalette, but some internal apps were abusing
   // the lack of type checking previously and assigning random strings.
-  /** Palette color of slide toggle. */
+  /**
+   * Theme color of the slide toggle. 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() color: string | undefined;
 
   /** Whether the slide toggle is disabled. */
diff --git a/src/material/stepper/step-header.ts b/src/material/stepper/step-header.ts
@@ -71,7 +71,13 @@ export class MatStepHeader extends CdkStepHeader implements AfterViewInit, OnDes
   /** Whether the ripple should be disabled. */
   @Input() disableRipple: boolean;
 
-  /** Theme palette color of the step header. */
+  /**
+   * Theme color of the step header. 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() color: ThemePalette;
 
   constructor(
diff --git a/src/material/stepper/stepper.ts b/src/material/stepper/stepper.ts
@@ -79,7 +79,13 @@ export class MatStep extends CdkStep implements ErrorStateMatcher, AfterContentI
   // We need an initializer here to avoid a TS error.
   @ContentChild(MatStepLabel) override stepLabel: MatStepLabel = undefined!;
 
-  /** Theme color for the particular step. */
+  /**
+   * Theme color for the particular step. 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() color: ThemePalette;
 
   /** Content that will be rendered lazily. */
@@ -180,7 +186,13 @@ export class MatStepper extends CdkStepper implements AfterContentInit {
   /** Whether ripples should be disabled for the step headers. */
   @Input() disableRipple: boolean;
 
-  /** Theme color for all of the steps in stepper. */
+  /**
+   * Theme color for all of the steps in stepper. 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() color: ThemePalette;
 
   /**
diff --git a/src/material/tabs/tab-nav-bar/tab-nav-bar.ts b/src/material/tabs/tab-nav-bar/tab-nav-bar.ts
@@ -135,7 +135,13 @@ export class MatTabNav
   @Input({transform: booleanAttribute})
   disableRipple: boolean = false;
 
-  /** Theme color of the nav bar. */
+  /**
+   * Theme color of the nav bar. 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() color: ThemePalette = 'primary';
 
   /**
diff --git a/src/material/toolbar/toolbar.ts b/src/material/toolbar/toolbar.ts
@@ -46,7 +46,13 @@ export class MatToolbarRow {}
 })
 export class MatToolbar implements AfterViewInit {
   // TODO: should be typed as `ThemePalette` but internal apps pass in arbitrary strings.
-  /** Palette color of the toolbar. */
+  /**
+   * Theme color of the toolbar. 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() color?: string | null;
 
   private _document: Document;

Original file line number	Diff line number	Diff line change
`@@ -108,11 +108,11 @@ export class MatButtonBase implements AfterViewInit, OnDestroy {`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`/**`
`111`		`- * Theme color palette of the button. This API is supported in M2 themes`
`112`		`- * only, it has no effect in M3 themes.`
	`111`	`+ * Theme color of the button. This API is supported in M2 themes only, it has`
	`112`	`+ * no effect in M3 themes.`
`113`	`113`	`*`
`114`	`114`	`* For information on applying color variants in M3, see`
`115`		`- * https://material.angular.io/guide/theming#using-component-color-variants`
	`115`	`+ * https://material.angular.io/guide/theming#using-component-color-variants.`
`116`	`116`	`*/`
`117`	`117`	`@Input() color?: string \| null;`
`118`	`118`