feat(multiple): Add a harness filter option for checked checkboxes, radios, and slide-toggles (#24625)

* feat(multiple): Add a harness filter option for checked checkboxes, radios, and slide-toggles

* fixup! feat(multiple): Add a harness filter option for checked checkboxes, radios, and slide-toggles

Author: mmalerba

src/material-experimental/mdc-checkbox/testing/checkbox-harness.ts

@@ -35,6 +35,11 @@ export class MatCheckboxHarness extends _MatCheckboxHarnessBase {
           options.name,
           async (harness, name) => (await harness.getName()) === name,
         )
+        .addOption(
+          'checked',
+          options.checked,
+          async (harness, checked) => (await harness.isChecked()) == checked,
+        )
     );
   }
 

src/material-experimental/mdc-radio/testing/radio-harness.ts

@@ -55,7 +55,12 @@ export class MatRadioButtonHarness extends _MatRadioButtonHarnessBase {
       .addOption('label', options.label, (harness, label) =>
         HarnessPredicate.stringMatches(harness.getLabelText(), label),
       )
-      .addOption('name', options.name, async (harness, name) => (await harness.getName()) === name);
+      .addOption('name', options.name, async (harness, name) => (await harness.getName()) === name)
+      .addOption(
+        'checked',
+        options.checked,
+        async (harness, checked) => (await harness.isChecked()) == checked,
+      );
   }
 
   protected _textLabel = this.locatorFor('label');

src/material-experimental/mdc-slide-toggle/testing/slide-toggle-harness.ts

@@ -39,6 +39,11 @@ export class MatSlideToggleHarness extends _MatSlideToggleHarnessBase {
           options.name,
           async (harness, name) => (await harness.getName()) === name,
         )
+        .addOption(
+          'checked',
+          options.checked,
+          async (harness, checked) => (await harness.isChecked()) == checked,
+        )
     );
   }
 

src/material/checkbox/testing/checkbox-harness-filters.ts

@@ -14,4 +14,6 @@ export interface CheckboxHarnessFilters extends BaseHarnessFilters {
   label?: string | RegExp;
   /** Only find instances whose name attribute is the given value. */
   name?: string;
+  /** Only find instances with the given checked value. */
+  checked?: boolean;
 }

src/material/checkbox/testing/checkbox-harness.ts

@@ -152,6 +152,11 @@ export class MatCheckboxHarness extends _MatCheckboxHarnessBase {
           options.name,
           async (harness, name) => (await harness.getName()) === name,
         )
+        .addOption(
+          'checked',
+          options.checked,
+          async (harness, checked) => (await harness.isChecked()) == checked,
+        )
     );
   }
 

src/material/radio/testing/radio-harness-filters.ts

@@ -20,4 +20,6 @@ export interface RadioButtonHarnessFilters extends BaseHarnessFilters {
   label?: string | RegExp;
   /** Only find instances whose name attribute is the given value. */
   name?: string;
+  /** Only find instances with the given checked value. */
+  checked?: boolean;
 }

src/material/radio/testing/radio-harness.ts

@@ -277,7 +277,12 @@ export class MatRadioButtonHarness extends _MatRadioButtonHarnessBase {
       .addOption('label', options.label, (harness, label) =>
         HarnessPredicate.stringMatches(harness.getLabelText(), label),
       )
-      .addOption('name', options.name, async (harness, name) => (await harness.getName()) === name);
+      .addOption('name', options.name, async (harness, name) => (await harness.getName()) === name)
+      .addOption(
+        'checked',
+        options.checked,
+        async (harness, checked) => (await harness.isChecked()) == checked,
+      );
   }
 
   protected _textLabel = this.locatorFor('.mat-radio-label-content');

src/material/slide-toggle/testing/slide-toggle-harness-filters.ts

@@ -14,4 +14,6 @@ export interface SlideToggleHarnessFilters extends BaseHarnessFilters {
   label?: string | RegExp;
   /** Only find instances whose name is the given value. */
   name?: string;
+  /** Only find instances with the given checked value. */
+  checked?: boolean;
 }

src/material/slide-toggle/testing/slide-toggle-harness.ts

@@ -127,6 +127,11 @@ export class MatSlideToggleHarness extends _MatSlideToggleHarnessBase {
           options.name,
           async (harness, name) => (await harness.getName()) === name,
         )
+        .addOption(
+          'checked',
+          options.checked,
+          async (harness, checked) => (await harness.isChecked()) == checked,
+        )
     );
   }
 

tools/public_api_guard/material/checkbox-testing.md

@@ -12,6 +12,7 @@ import { TestElement } from '@angular/cdk/testing';
 
 // @public
 export interface CheckboxHarnessFilters extends BaseHarnessFilters {
+    checked?: boolean;
     label?: string | RegExp;
     name?: string;
 }