@angular/material 21.0.0-next.9 → 21.0.0-rc.0

package/fesm2022/snack-bar-testing.mjs

@@ -1,93 +1,46 @@
 import { ContentContainerComponentHarness, HarnessPredicate, parallel } from '@angular/cdk/testing';
 
-/** Harness for interacting with a mat-snack-bar in tests. */
 class MatSnackBarHarness extends ContentContainerComponentHarness {
-    // Developers can provide a custom component or template for the
-    // snackbar. The canonical snack-bar parent is the "MatSnackBarContainer".
-    /** The selector for the host element of a `MatSnackBar` instance. */
-    static hostSelector = '.mat-mdc-snack-bar-container:not([mat-exit])';
-    _messageSelector = '.mdc-snackbar__label';
-    _actionButtonSelector = '.mat-mdc-snack-bar-action';
-    _snackBarLiveRegion = this.locatorFor('[aria-live]');
-    /**
-     * Gets a `HarnessPredicate` that can be used to search for a `MatSnackBarHarness` that meets
-     * certain criteria.
-     * @param options Options for filtering which snack bar instances are considered a match.
-     * @return a `HarnessPredicate` configured with the given options.
-     */
-    static with(options = {}) {
-        return new HarnessPredicate(MatSnackBarHarness, options);
-    }
-    /**
-     * Gets the role of the snack-bar. The role of a snack-bar is determined based
-     * on the ARIA politeness specified in the snack-bar config.
-     * @deprecated Use `getAriaLive` instead.
-     * @breaking-change 13.0.0
-     */
-    async getRole() {
-        return (await this.host()).getAttribute('role');
-    }
-    /**
-     * Gets the aria-live of the snack-bar's live region. The aria-live of a snack-bar is
-     * determined based on the ARIA politeness specified in the snack-bar config.
-     */
-    async getAriaLive() {
-        return (await this._snackBarLiveRegion()).getAttribute('aria-live');
-    }
-    /**
-     * Whether the snack-bar has an action. Method cannot be used for snack-bar's with custom content.
-     */
-    async hasAction() {
-        return (await this._getActionButton()) !== null;
-    }
-    /**
-     * Gets the description of the snack-bar. Method cannot be used for snack-bar's without action or
-     * with custom content.
-     */
-    async getActionDescription() {
-        await this._assertHasAction();
-        return (await this._getActionButton()).text();
-    }
-    /**
-     * Dismisses the snack-bar by clicking the action button. Method cannot be used for snack-bar's
-     * without action or with custom content.
-     */
-    async dismissWithAction() {
-        await this._assertHasAction();
-        await (await this._getActionButton()).click();
-    }
-    /**
-     * Gets the message of the snack-bar. Method cannot be used for snack-bar's with custom content.
-     */
-    async getMessage() {
-        return (await this.locatorFor(this._messageSelector)()).text();
-    }
-    /** Gets whether the snack-bar has been dismissed. */
-    async isDismissed() {
-        // We consider the snackbar dismissed if it's not in the DOM. We can assert that the
-        // element isn't in the DOM by seeing that its width and height are zero.
-        const host = await this.host();
-        const [exit, dimensions] = await parallel(() => [
-            // The snackbar container is marked with the "exit" attribute after it has been dismissed
-            // but before the animation has finished (after which it's removed from the DOM).
-            host.getAttribute('mat-exit'),
-            host.getDimensions(),
-        ]);
-        return exit != null || (!!dimensions && dimensions.height === 0 && dimensions.width === 0);
-    }
-    /**
-     * Asserts that the current snack-bar has an action defined. Otherwise the
-     * promise will reject.
-     */
-    async _assertHasAction() {
-        if (!(await this.hasAction())) {
-            throw Error('Method cannot be used for a snack-bar without an action.');
-        }
-    }
-    /** Gets the simple snack bar action button. */
-    async _getActionButton() {
-        return this.locatorForOptional(this._actionButtonSelector)();
-    }
+  static hostSelector = '.mat-mdc-snack-bar-container:not([mat-exit])';
+  _messageSelector = '.mdc-snackbar__label';
+  _actionButtonSelector = '.mat-mdc-snack-bar-action';
+  _snackBarLiveRegion = this.locatorFor('[aria-live]');
+  static with(options = {}) {
+    return new HarnessPredicate(MatSnackBarHarness, options);
+  }
+  async getRole() {
+    return (await this.host()).getAttribute('role');
+  }
+  async getAriaLive() {
+    return (await this._snackBarLiveRegion()).getAttribute('aria-live');
+  }
+  async hasAction() {
+    return (await this._getActionButton()) !== null;
+  }
+  async getActionDescription() {
+    await this._assertHasAction();
+    return (await this._getActionButton()).text();
+  }
+  async dismissWithAction() {
+    await this._assertHasAction();
+    await (await this._getActionButton()).click();
+  }
+  async getMessage() {
+    return (await this.locatorFor(this._messageSelector)()).text();
+  }
+  async isDismissed() {
+    const host = await this.host();
+    const [exit, dimensions] = await parallel(() => [host.getAttribute('mat-exit'), host.getDimensions()]);
+    return exit != null || !!dimensions && dimensions.height === 0 && dimensions.width === 0;
+  }
+  async _assertHasAction() {
+    if (!(await this.hasAction())) {
+      throw Error('Method cannot be used for a snack-bar without an action.');
+    }
+  }
+  async _getActionButton() {
+    return this.locatorForOptional(this._actionButtonSelector)();
+  }
 }
 
 export { MatSnackBarHarness };

package/fesm2022/snack-bar-testing.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"snack-bar-testing.mjs","sources":["../../../../../darwin_arm64-fastbuild-ST-199a4f3c4e20/bin/src/material/snack-bar/testing/snack-bar-harness.ts"],"sourcesContent":["/**\n * @license\n * Copyright Google LLC All Rights Reserved.\n *\n * Use of this source code is governed by an MIT-style license that can be\n * found in the LICENSE file at https://angular.dev/license\n */\n\nimport {ContentContainerComponentHarness, HarnessPredicate, parallel} from '@angular/cdk/testing';\nimport {AriaLivePoliteness} from '@angular/cdk/a11y';\nimport {SnackBarHarnessFilters} from './snack-bar-harness-filters';\n\n/** Harness for interacting with a mat-snack-bar in tests. */\nexport class MatSnackBarHarness extends ContentContainerComponentHarness<string> {\n  // Developers can provide a custom component or template for the\n  // snackbar. The canonical snack-bar parent is the \"MatSnackBarContainer\".\n  /** The selector for the host element of a `MatSnackBar` instance. */\n  static hostSelector = '.mat-mdc-snack-bar-container:not([mat-exit])';\n  private _messageSelector = '.mdc-snackbar__label';\n  private _actionButtonSelector = '.mat-mdc-snack-bar-action';\n\n  private _snackBarLiveRegion = this.locatorFor('[aria-live]');\n\n  /**\n   * Gets a `HarnessPredicate` that can be used to search for a `MatSnackBarHarness` that meets\n   * certain criteria.\n   * @param options Options for filtering which snack bar instances are considered a match.\n   * @return a `HarnessPredicate` configured with the given options.\n   */\n  static with(options: SnackBarHarnessFilters = {}): HarnessPredicate<MatSnackBarHarness> {\n    return new HarnessPredicate(MatSnackBarHarness, options);\n  }\n\n  /**\n   * Gets the role of the snack-bar. The role of a snack-bar is determined based\n   * on the ARIA politeness specified in the snack-bar config.\n   * @deprecated Use `getAriaLive` instead.\n   * @breaking-change 13.0.0\n   */\n  async getRole(): Promise<'alert' | 'status' | null> {\n    return (await this.host()).getAttribute('role') as Promise<'alert' | 'status' | null>;\n  }\n\n  /**\n   * Gets the aria-live of the snack-bar's live region. The aria-live of a snack-bar is\n   * determined based on the ARIA politeness specified in the snack-bar config.\n   */\n  async getAriaLive(): Promise<AriaLivePoliteness> {\n    return (await this._snackBarLiveRegion()).getAttribute(\n      'aria-live',\n    ) as Promise<AriaLivePoliteness>;\n  }\n\n  /**\n   * Whether the snack-bar has an action. Method cannot be used for snack-bar's with custom content.\n   */\n  async hasAction(): Promise<boolean> {\n    return (await this._getActionButton()) !== null;\n  }\n\n  /**\n   * Gets the description of the snack-bar. Method cannot be used for snack-bar's without action or\n   * with custom content.\n   */\n  async getActionDescription(): Promise<string> {\n    await this._assertHasAction();\n    return (await this._getActionButton())!.text();\n  }\n\n  /**\n   * Dismisses the snack-bar by clicking the action button. Method cannot be used for snack-bar's\n   * without action or with custom content.\n   */\n  async dismissWithAction(): Promise<void> {\n    await this._assertHasAction();\n    await (await this._getActionButton())!.click();\n  }\n\n  /**\n   * Gets the message of the snack-bar. Method cannot be used for snack-bar's with custom content.\n   */\n  async getMessage(): Promise<string> {\n    return (await this.locatorFor(this._messageSelector)()).text();\n  }\n\n  /** Gets whether the snack-bar has been dismissed. */\n  async isDismissed(): Promise<boolean> {\n    // We consider the snackbar dismissed if it's not in the DOM. We can assert that the\n    // element isn't in the DOM by seeing that its width and height are zero.\n\n    const host = await this.host();\n    const [exit, dimensions] = await parallel(() => [\n      // The snackbar container is marked with the \"exit\" attribute after it has been dismissed\n      // but before the animation has finished (after which it's removed from the DOM).\n      host.getAttribute('mat-exit'),\n      host.getDimensions(),\n    ]);\n\n    return exit != null || (!!dimensions && dimensions.height === 0 && dimensions.width === 0);\n  }\n\n  /**\n   * Asserts that the current snack-bar has an action defined. Otherwise the\n   * promise will reject.\n   */\n  private async _assertHasAction(): Promise<void> {\n    if (!(await this.hasAction())) {\n      throw Error('Method cannot be used for a snack-bar without an action.');\n    }\n  }\n\n  /** Gets the simple snack bar action button. */\n  private async _getActionButton() {\n    return this.locatorForOptional(this._actionButtonSelector)();\n  }\n}\n"],"names":[],"mappings":";;AAYA;AACM,MAAO,kBAAmB,SAAQ,gCAAwC,CAAA;;;;AAI9E,IAAA,OAAO,YAAY,GAAG,8CAA8C;IAC5D,gBAAgB,GAAG,sBAAsB;IACzC,qBAAqB,GAAG,2BAA2B;AAEnD,IAAA,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;AAE5D;;;;;AAKG;AACH,IAAA,OAAO,IAAI,CAAC,OAAA,GAAkC,EAAE,EAAA;AAC9C,QAAA,OAAO,IAAI,gBAAgB,CAAC,kBAAkB,EAAE,OAAO,CAAC;;AAG1D;;;;;AAKG;AACH,IAAA,MAAM,OAAO,GAAA;AACX,QAAA,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,YAAY,CAAC,MAAM,CAAuC;;AAGvF;;;AAGG;AACH,IAAA,MAAM,WAAW,GAAA;AACf,QAAA,OAAO,CAAC,MAAM,IAAI,CAAC,mBAAmB,EAAE,EAAE,YAAY,CACpD,WAAW,CACmB;;AAGlC;;AAEG;AACH,IAAA,MAAM,SAAS,GAAA;QACb,OAAO,CAAC,MAAM,IAAI,CAAC,gBAAgB,EAAE,MAAM,IAAI;;AAGjD;;;AAGG;AACH,IAAA,MAAM,oBAAoB,GAAA;AACxB,QAAA,MAAM,IAAI,CAAC,gBAAgB,EAAE;QAC7B,OAAO,CAAC,MAAM,IAAI,CAAC,gBAAgB,EAAE,EAAG,IAAI,EAAE;;AAGhD;;;AAGG;AACH,IAAA,MAAM,iBAAiB,GAAA;AACrB,QAAA,MAAM,IAAI,CAAC,gBAAgB,EAAE;QAC7B,MAAM,CAAC,MAAM,IAAI,CAAC,gBAAgB,EAAE,EAAG,KAAK,EAAE;;AAGhD;;AAEG;AACH,IAAA,MAAM,UAAU,GAAA;AACd,QAAA,OAAO,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,EAAE,IAAI,EAAE;;;AAIhE,IAAA,MAAM,WAAW,GAAA;;;AAIf,QAAA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE;QAC9B,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,MAAM,QAAQ,CAAC,MAAM;;;AAG9C,YAAA,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;YAC7B,IAAI,CAAC,aAAa,EAAE;AACrB,SAAA,CAAC;QAEF,OAAO,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,KAAK,CAAC,CAAC;;AAG5F;;;AAGG;AACK,IAAA,MAAM,gBAAgB,GAAA;QAC5B,IAAI,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE;AAC7B,YAAA,MAAM,KAAK,CAAC,0DAA0D,CAAC;;;;AAKnE,IAAA,MAAM,gBAAgB,GAAA;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAAE;;;;;;"}
+{"version":3,"file":"snack-bar-testing.mjs","sources":["../../../../../darwin_arm64-fastbuild-ST-199a4f3c4e20/bin/src/material/snack-bar/testing/snack-bar-harness.ts"],"sourcesContent":["/**\n * @license\n * Copyright Google LLC All Rights Reserved.\n *\n * Use of this source code is governed by an MIT-style license that can be\n * found in the LICENSE file at https://angular.dev/license\n */\n\nimport {ContentContainerComponentHarness, HarnessPredicate, parallel} from '@angular/cdk/testing';\nimport {AriaLivePoliteness} from '@angular/cdk/a11y';\nimport {SnackBarHarnessFilters} from './snack-bar-harness-filters';\n\n/** Harness for interacting with a mat-snack-bar in tests. */\nexport class MatSnackBarHarness extends ContentContainerComponentHarness<string> {\n  // Developers can provide a custom component or template for the\n  // snackbar. The canonical snack-bar parent is the \"MatSnackBarContainer\".\n  /** The selector for the host element of a `MatSnackBar` instance. */\n  static hostSelector = '.mat-mdc-snack-bar-container:not([mat-exit])';\n  private _messageSelector = '.mdc-snackbar__label';\n  private _actionButtonSelector = '.mat-mdc-snack-bar-action';\n\n  private _snackBarLiveRegion = this.locatorFor('[aria-live]');\n\n  /**\n   * Gets a `HarnessPredicate` that can be used to search for a `MatSnackBarHarness` that meets\n   * certain criteria.\n   * @param options Options for filtering which snack bar instances are considered a match.\n   * @return a `HarnessPredicate` configured with the given options.\n   */\n  static with(options: SnackBarHarnessFilters = {}): HarnessPredicate<MatSnackBarHarness> {\n    return new HarnessPredicate(MatSnackBarHarness, options);\n  }\n\n  /**\n   * Gets the role of the snack-bar. The role of a snack-bar is determined based\n   * on the ARIA politeness specified in the snack-bar config.\n   * @deprecated Use `getAriaLive` instead.\n   * @breaking-change 13.0.0\n   */\n  async getRole(): Promise<'alert' | 'status' | null> {\n    return (await this.host()).getAttribute('role') as Promise<'alert' | 'status' | null>;\n  }\n\n  /**\n   * Gets the aria-live of the snack-bar's live region. The aria-live of a snack-bar is\n   * determined based on the ARIA politeness specified in the snack-bar config.\n   */\n  async getAriaLive(): Promise<AriaLivePoliteness> {\n    return (await this._snackBarLiveRegion()).getAttribute(\n      'aria-live',\n    ) as Promise<AriaLivePoliteness>;\n  }\n\n  /**\n   * Whether the snack-bar has an action. Method cannot be used for snack-bar's with custom content.\n   */\n  async hasAction(): Promise<boolean> {\n    return (await this._getActionButton()) !== null;\n  }\n\n  /**\n   * Gets the description of the snack-bar. Method cannot be used for snack-bar's without action or\n   * with custom content.\n   */\n  async getActionDescription(): Promise<string> {\n    await this._assertHasAction();\n    return (await this._getActionButton())!.text();\n  }\n\n  /**\n   * Dismisses the snack-bar by clicking the action button. Method cannot be used for snack-bar's\n   * without action or with custom content.\n   */\n  async dismissWithAction(): Promise<void> {\n    await this._assertHasAction();\n    await (await this._getActionButton())!.click();\n  }\n\n  /**\n   * Gets the message of the snack-bar. Method cannot be used for snack-bar's with custom content.\n   */\n  async getMessage(): Promise<string> {\n    return (await this.locatorFor(this._messageSelector)()).text();\n  }\n\n  /** Gets whether the snack-bar has been dismissed. */\n  async isDismissed(): Promise<boolean> {\n    // We consider the snackbar dismissed if it's not in the DOM. We can assert that the\n    // element isn't in the DOM by seeing that its width and height are zero.\n\n    const host = await this.host();\n    const [exit, dimensions] = await parallel(() => [\n      // The snackbar container is marked with the \"exit\" attribute after it has been dismissed\n      // but before the animation has finished (after which it's removed from the DOM).\n      host.getAttribute('mat-exit'),\n      host.getDimensions(),\n    ]);\n\n    return exit != null || (!!dimensions && dimensions.height === 0 && dimensions.width === 0);\n  }\n\n  /**\n   * Asserts that the current snack-bar has an action defined. Otherwise the\n   * promise will reject.\n   */\n  private async _assertHasAction(): Promise<void> {\n    if (!(await this.hasAction())) {\n      throw Error('Method cannot be used for a snack-bar without an action.');\n    }\n  }\n\n  /** Gets the simple snack bar action button. */\n  private async _getActionButton() {\n    return this.locatorForOptional(this._actionButtonSelector)();\n  }\n}\n"],"names":["hostSelector","getRole","host","getAttribute","getAriaLive","_snackBarLiveRegion","hasAction","_getActionButton","getActionDescription","_assertHasAction","dismissWithAction","click","getMessage","locatorFor","_messageSelector","text","exit","dimensions","parallel"],"mappings":";;;AAiBE,EAAA,OAAAA,YAAA,GAAA,8CAAA;kBAE6B;;;;;;AA2B1B,EAAA,MAAAC,OAAA,GAAA;IAED,OAAAC,CAAAA,MAAAA,IAAAA,CAAAA,IAAA,IAAAC,YAAA,CAAA,MAAA,CAAA;;QASAC,WAAOA,GAAA;IACT,OAAA,CAAA,MAAA,IAAA,CAAAC,mBAAA,EAAA,EAAAF,YAAA,CAAA,WAAA,CAAA;AAEA;QAKEG,SAAA,GAAA;WACA,CAAA,MAAc,KAAAC,gBAAA,EAAA,MAAA,IAAA;;QAUhBC,oBAAAA,GAAA;AAEA,IAAA,MAAA,IAAA,CAAAC,gBAAA,EAAA;;AAGA;yBAMsFC,GAAA;cACX,CAAAD,gBAAA,EAAA;IAEzE,MAAAF,CAAAA,MAAAA,IAAAA,CAAAA,gBAAA,IAAAI,KAAA,EAAA;;AAMC,EAAA,MAAAC,UAAA,GAAA;WAEM,OAAA,IAAAC,CAAAA,UAAkB,CAAC,IAAAC,CAAAA,gBAAA,KAAAC,IAAA,EAAA;;;UAQ1Bb,IAAA,GAAY,MAAA,IAAA,CAAAA,IAAA,EAAA;AACV,IAAA,MAAA,CAAAc,IAAA,EAAAC,UAAW,CAAA,GAAA,MAA2DC,QAAA,CAAA,MAAA,CAKlEhB,IAAA,CAAAC,YAAsB,CAAA,UAAA,CAAA,sBAE9B,CAAA,CAAA;;;;;;;;;;;;;;;"}