@angular/material
Version:
Angular Material
95 lines • 11.9 kB
JavaScript
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import { ContentContainerComponentHarness, HarnessPredicate, TestKey } from '@angular/cdk/testing';
import { MatLegacyChipAvatarHarness } from './chip-avatar-harness';
import { MatLegacyChipRemoveHarness } from './chip-remove-harness';
/**
* Harness for interacting with a standard selectable Angular Material chip in tests.
* @deprecated Use `MatChipHarness` from `@angular/material/chips/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
export class MatLegacyChipHarness extends ContentContainerComponentHarness {
/**
* Gets a `HarnessPredicate` that can be used to search for a `MatChipHarness` that meets
* certain criteria.
* @param options Options for filtering which chip instances are considered a match.
* @return a `HarnessPredicate` configured with the given options.
*/
static with(options = {}) {
return new HarnessPredicate(MatLegacyChipHarness, options)
.addOption('text', options.text, (harness, label) => HarnessPredicate.stringMatches(harness.getText(), label))
.addOption('selected', options.selected, async (harness, selected) => (await harness.isSelected()) === selected);
}
/** Gets the text of the chip. */
async getText() {
return (await this.host()).text({
exclude: '.mat-chip-avatar, .mat-chip-trailing-icon, .mat-icon',
});
}
/**
* Whether the chip is selected.
* @deprecated Use `MatChipOptionHarness.isSelected` instead.
* @breaking-change 12.0.0
*/
async isSelected() {
return (await this.host()).hasClass('mat-chip-selected');
}
/** Whether the chip is disabled. */
async isDisabled() {
return (await this.host()).hasClass('mat-chip-disabled');
}
/**
* Selects the given chip. Only applies if it's selectable.
* @deprecated Use `MatChipOptionHarness.select` instead.
* @breaking-change 12.0.0
*/
async select() {
if (!(await this.isSelected())) {
await this.toggle();
}
}
/**
* Deselects the given chip. Only applies if it's selectable.
* @deprecated Use `MatChipOptionHarness.deselect` instead.
* @breaking-change 12.0.0
*/
async deselect() {
if (await this.isSelected()) {
await this.toggle();
}
}
/**
* Toggles the selected state of the given chip. Only applies if it's selectable.
* @deprecated Use `MatChipOptionHarness.toggle` instead.
* @breaking-change 12.0.0
*/
async toggle() {
return (await this.host()).sendKeys(' ');
}
/** Removes the given chip. Only applies if it's removable. */
async remove() {
await (await this.host()).sendKeys(TestKey.DELETE);
}
/**
* Gets the remove button inside of a chip.
* @param filter Optionally filters which remove buttons are included.
*/
async getRemoveButton(filter = {}) {
return this.locatorFor(MatLegacyChipRemoveHarness.with(filter))();
}
/**
* Gets the avatar inside a chip.
* @param filter Optionally filters which avatars are included.
*/
async getAvatar(filter = {}) {
return this.locatorForOptional(MatLegacyChipAvatarHarness.with(filter))();
}
}
/** The selector for the host element of a `MatChip` instance. */
MatLegacyChipHarness.hostSelector = '.mat-chip';
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"chip-harness.js","sourceRoot":"","sources":["../../../../../../../src/material/legacy-chips/testing/chip-harness.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAC,gCAAgC,EAAE,gBAAgB,EAAE,OAAO,EAAC,MAAM,sBAAsB,CAAC;AACjG,OAAO,EAAC,0BAA0B,EAAC,MAAM,uBAAuB,CAAC;AAMjE,OAAO,EAAC,0BAA0B,EAAC,MAAM,uBAAuB,CAAC;AAEjE;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,gCAAgC;IAIxE;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,UAAoC,EAAE;QAChD,OAAO,IAAI,gBAAgB,CAAC,oBAAoB,EAAE,OAAO,CAAC;aACvD,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAClD,gBAAgB,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CACzD;aACA,SAAS,CACR,UAAU,EACV,OAAO,CAAC,QAAQ,EAChB,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,QAAQ,CACvE,CAAC;IACN,CAAC;IAED,iCAAiC;IACjC,KAAK,CAAC,OAAO;QACX,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;YAC9B,OAAO,EAAE,sDAAsD;SAChE,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC3D,CAAC;IAED,oCAAoC;IACpC,KAAK,CAAC,UAAU;QACd,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE;YAC9B,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;SACrB;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACZ,IAAI,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE;YAC3B,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;SACrB;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC;IAED,8DAA8D;IAC9D,KAAK,CAAC,MAAM;QACV,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CACnB,SAAyC,EAAE;QAE3C,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS,CACb,SAAyC,EAAE;QAE3C,OAAO,IAAI,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAC5E,CAAC;;AAhGD,iEAAiE;AAC1D,iCAAY,GAAG,WAAW,CAAC","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.io/license\n */\n\nimport {ContentContainerComponentHarness, HarnessPredicate, TestKey} from '@angular/cdk/testing';\nimport {MatLegacyChipAvatarHarness} from './chip-avatar-harness';\nimport {\n  LegacyChipAvatarHarnessFilters,\n  LegacyChipHarnessFilters,\n  LegacyChipRemoveHarnessFilters,\n} from './chip-harness-filters';\nimport {MatLegacyChipRemoveHarness} from './chip-remove-harness';\n\n/**\n * Harness for interacting with a standard selectable Angular Material chip in tests.\n * @deprecated Use `MatChipHarness` from `@angular/material/chips/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.\n * @breaking-change 17.0.0\n */\nexport class MatLegacyChipHarness extends ContentContainerComponentHarness {\n  /** The selector for the host element of a `MatChip` instance. */\n  static hostSelector = '.mat-chip';\n\n  /**\n   * Gets a `HarnessPredicate` that can be used to search for a `MatChipHarness` that meets\n   * certain criteria.\n   * @param options Options for filtering which chip instances are considered a match.\n   * @return a `HarnessPredicate` configured with the given options.\n   */\n  static with(options: LegacyChipHarnessFilters = {}): HarnessPredicate<MatLegacyChipHarness> {\n    return new HarnessPredicate(MatLegacyChipHarness, options)\n      .addOption('text', options.text, (harness, label) =>\n        HarnessPredicate.stringMatches(harness.getText(), label),\n      )\n      .addOption(\n        'selected',\n        options.selected,\n        async (harness, selected) => (await harness.isSelected()) === selected,\n      );\n  }\n\n  /** Gets the text of the chip. */\n  async getText(): Promise<string> {\n    return (await this.host()).text({\n      exclude: '.mat-chip-avatar, .mat-chip-trailing-icon, .mat-icon',\n    });\n  }\n\n  /**\n   * Whether the chip is selected.\n   * @deprecated Use `MatChipOptionHarness.isSelected` instead.\n   * @breaking-change 12.0.0\n   */\n  async isSelected(): Promise<boolean> {\n    return (await this.host()).hasClass('mat-chip-selected');\n  }\n\n  /** Whether the chip is disabled. */\n  async isDisabled(): Promise<boolean> {\n    return (await this.host()).hasClass('mat-chip-disabled');\n  }\n\n  /**\n   * Selects the given chip. Only applies if it's selectable.\n   * @deprecated Use `MatChipOptionHarness.select` instead.\n   * @breaking-change 12.0.0\n   */\n  async select(): Promise<void> {\n    if (!(await this.isSelected())) {\n      await this.toggle();\n    }\n  }\n\n  /**\n   * Deselects the given chip. Only applies if it's selectable.\n   * @deprecated Use `MatChipOptionHarness.deselect` instead.\n   * @breaking-change 12.0.0\n   */\n  async deselect(): Promise<void> {\n    if (await this.isSelected()) {\n      await this.toggle();\n    }\n  }\n\n  /**\n   * Toggles the selected state of the given chip. Only applies if it's selectable.\n   * @deprecated Use `MatChipOptionHarness.toggle` instead.\n   * @breaking-change 12.0.0\n   */\n  async toggle(): Promise<void> {\n    return (await this.host()).sendKeys(' ');\n  }\n\n  /** Removes the given chip. Only applies if it's removable. */\n  async remove(): Promise<void> {\n    await (await this.host()).sendKeys(TestKey.DELETE);\n  }\n\n  /**\n   * Gets the remove button inside of a chip.\n   * @param filter Optionally filters which remove buttons are included.\n   */\n  async getRemoveButton(\n    filter: LegacyChipRemoveHarnessFilters = {},\n  ): Promise<MatLegacyChipRemoveHarness> {\n    return this.locatorFor(MatLegacyChipRemoveHarness.with(filter))();\n  }\n\n  /**\n   * Gets the avatar inside a chip.\n   * @param filter Optionally filters which avatars are included.\n   */\n  async getAvatar(\n    filter: LegacyChipAvatarHarnessFilters = {},\n  ): Promise<MatLegacyChipAvatarHarness | null> {\n    return this.locatorForOptional(MatLegacyChipAvatarHarness.with(filter))();\n  }\n}\n"]}