1 | /**
|
---|
2 | * @license
|
---|
3 | * Copyright Google LLC All Rights Reserved.
|
---|
4 | *
|
---|
5 | * Use of this source code is governed by an MIT-style license that can be
|
---|
6 | * found in the LICENSE file at https://angular.io/license
|
---|
7 | */
|
---|
8 | import { ContentContainerComponentHarness, HarnessPredicate, HarnessLoader } from '@angular/cdk/testing';
|
---|
9 | import { StepHarnessFilters } from './step-harness-filters';
|
---|
10 | /** Harness for interacting with a standard Angular Material step in tests. */
|
---|
11 | export declare class MatStepHarness extends ContentContainerComponentHarness<string> {
|
---|
12 | /** The selector for the host element of a `MatStep` instance. */
|
---|
13 | static hostSelector: string;
|
---|
14 | /**
|
---|
15 | * Gets a `HarnessPredicate` that can be used to search for a `MatStepHarness` that meets
|
---|
16 | * certain criteria.
|
---|
17 | * @param options Options for filtering which steps are considered a match.
|
---|
18 | * @return a `HarnessPredicate` configured with the given options.
|
---|
19 | */
|
---|
20 | static with(options?: StepHarnessFilters): HarnessPredicate<MatStepHarness>;
|
---|
21 | /** Gets the label of the step. */
|
---|
22 | getLabel(): Promise<string>;
|
---|
23 | /** Gets the `aria-label` of the step. */
|
---|
24 | getAriaLabel(): Promise<string | null>;
|
---|
25 | /** Gets the value of the `aria-labelledby` attribute. */
|
---|
26 | getAriaLabelledby(): Promise<string | null>;
|
---|
27 | /** Whether the step is selected. */
|
---|
28 | isSelected(): Promise<boolean>;
|
---|
29 | /** Whether the step has been filled out. */
|
---|
30 | isCompleted(): Promise<boolean>;
|
---|
31 | /**
|
---|
32 | * Whether the step is currently showing its error state. Note that this doesn't mean that there
|
---|
33 | * are or aren't any invalid form controls inside the step, but that the step is showing its
|
---|
34 | * error-specific styling which depends on there being invalid controls, as well as the
|
---|
35 | * `ErrorStateMatcher` determining that an error should be shown and that the `showErrors`
|
---|
36 | * option was enabled through the `STEPPER_GLOBAL_OPTIONS` injection token.
|
---|
37 | */
|
---|
38 | hasErrors(): Promise<boolean>;
|
---|
39 | /** Whether the step is optional. */
|
---|
40 | isOptional(): Promise<boolean>;
|
---|
41 | /**
|
---|
42 | * Selects the given step by clicking on the label. The step may not be selected
|
---|
43 | * if the stepper doesn't allow it (e.g. if there are validation errors).
|
---|
44 | */
|
---|
45 | select(): Promise<void>;
|
---|
46 | protected getRootHarnessLoader(): Promise<HarnessLoader>;
|
---|
47 | /**
|
---|
48 | * Gets the state of the step. Note that we have a `StepState` which we could use to type the
|
---|
49 | * return value, but it's basically the same as `string`, because the type has `| string`.
|
---|
50 | */
|
---|
51 | private _getIconState;
|
---|
52 | }
|
---|