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

package/stepper/index.d.ts

@@ -1,8 +1,290 @@
+import { _AbstractConstructor } from '@angular/material/core';
+import { AfterContentInit } from '@angular/core';
+import { AfterViewInit } from '@angular/core';
+import { AnimationEvent as AnimationEvent_2 } from '@angular/animations';
+import { AnimationTriggerMetadata } from '@angular/animations';
+import { CanColor } from '@angular/material/core';
+import { CdkStep } from '@angular/cdk/stepper';
+import { CdkStepLabel } from '@angular/cdk/stepper';
+import { CdkStepper } from '@angular/cdk/stepper';
+import { CdkStepperNext } from '@angular/cdk/stepper';
+import { CdkStepperPrevious } from '@angular/cdk/stepper';
+import { ChangeDetectorRef } from '@angular/core';
+import { _Constructor } from '@angular/material/core';
+import { Directionality } from '@angular/cdk/bidi';
+import { ElementRef } from '@angular/core';
+import { ErrorStateMatcher } from '@angular/material/core';
+import { EventEmitter } from '@angular/core';
+import { FocusMonitor } from '@angular/cdk/a11y';
+import { FocusOrigin } from '@angular/cdk/a11y';
+import { FormGroupDirective } from '@angular/forms';
+import * as i0 from '@angular/core';
+import * as i10 from '@angular/material/button';
+import * as i11 from '@angular/cdk/stepper';
+import * as i12 from '@angular/material/icon';
+import * as i7 from '@angular/material/core';
+import * as i8 from '@angular/common';
+import * as i9 from '@angular/cdk/portal';
+import { NgForm } from '@angular/forms';
+import { OnDestroy } from '@angular/core';
+import { Optional } from '@angular/core';
+import { QueryList } from '@angular/core';
+import { StepperOptions } from '@angular/cdk/stepper';
+import { StepperOrientation } from '@angular/cdk/stepper';
+import { StepState } from '@angular/cdk/stepper';
+import { Subject } from 'rxjs';
+import { TemplatePortal } from '@angular/cdk/portal';
+import { TemplateRef } from '@angular/core';
+import { ThemePalette } from '@angular/material/core';
+import { UntypedFormControl } from '@angular/forms';
+import { ViewContainerRef } from '@angular/core';
+
+declare namespace i1 {
+    export {
+        MatStep,
+        MatStepper
+    }
+}
+
+declare namespace i2 {
+    export {
+        MatStepLabel
+    }
+}
+
+declare namespace i3 {
+    export {
+        MatStepperNext,
+        MatStepperPrevious
+    }
+}
+
+declare namespace i4 {
+    export {
+        MatStepHeader
+    }
+}
+
+declare namespace i5 {
+    export {
+        MatStepperIconContext,
+        MatStepperIcon
+    }
+}
+
+declare namespace i6 {
+    export {
+        MatStepContent
+    }
+}
+
+/** @docs-private */
+export declare const MAT_STEPPER_INTL_PROVIDER: {
+    provide: typeof MatStepperIntl;
+    deps: Optional[][];
+    useFactory: typeof MAT_STEPPER_INTL_PROVIDER_FACTORY;
+};
+
+/** @docs-private */
+export declare function MAT_STEPPER_INTL_PROVIDER_FACTORY(parentIntl: MatStepperIntl): MatStepperIntl;
+
+export declare class MatStep extends CdkStep implements ErrorStateMatcher, AfterContentInit, OnDestroy {
+    private _errorStateMatcher;
+    private _viewContainerRef;
+    private _isSelected;
+    /** Content for step label given by `<ng-template matStepLabel>`. */
+    stepLabel: MatStepLabel;
+    /** Theme color for the particular step. */
+    color: ThemePalette;
+    /** Content that will be rendered lazily. */
+    _lazyContent: MatStepContent;
+    /** Currently-attached portal containing the lazy content. */
+    _portal: TemplatePortal;
+    constructor(stepper: MatStepper, _errorStateMatcher: ErrorStateMatcher, _viewContainerRef: ViewContainerRef, stepperOptions?: StepperOptions);
+    ngAfterContentInit(): void;
+    ngOnDestroy(): void;
+    /** Custom error state matcher that additionally checks for validity of interacted form. */
+    isErrorState(control: UntypedFormControl | null, form: FormGroupDirective | NgForm | null): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStep, [null, { skipSelf: true; }, null, { optional: true; }]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MatStep, "mat-step", ["matStep"], { "color": "color"; }, {}, ["stepLabel", "_lazyContent"], ["*"], false>;
+}
+
 /**
- * @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
+ * Content for a `mat-step` that will be rendered lazily.
  */
-export * from './public-api';
+export declare class MatStepContent {
+    _template: TemplateRef<any>;
+    constructor(_template: TemplateRef<any>);
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepContent, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepContent, "ng-template[matStepContent]", never, {}, {}, never, never, false>;
+}
+
+export declare class MatStepHeader extends _MatStepHeaderBase implements AfterViewInit, OnDestroy, CanColor {
+    _intl: MatStepperIntl;
+    private _focusMonitor;
+    private _intlSubscription;
+    /** State of the given step. */
+    state: StepState;
+    /** Label of the given step. */
+    label: MatStepLabel | string;
+    /** Error message to display when there's an error. */
+    errorMessage: string;
+    /** Overrides for the header icons, passed in via the stepper. */
+    iconOverrides: {
+        [key: string]: TemplateRef<MatStepperIconContext>;
+    };
+    /** Index of the given step. */
+    index: number;
+    /** Whether the given step is selected. */
+    selected: boolean;
+    /** Whether the given step label is active. */
+    active: boolean;
+    /** Whether the given step is optional. */
+    optional: boolean;
+    /** Whether the ripple should be disabled. */
+    disableRipple: boolean;
+    constructor(_intl: MatStepperIntl, _focusMonitor: FocusMonitor, _elementRef: ElementRef<HTMLElement>, changeDetectorRef: ChangeDetectorRef);
+    ngAfterViewInit(): void;
+    ngOnDestroy(): void;
+    /** Focuses the step header. */
+    focus(origin?: FocusOrigin, options?: FocusOptions): void;
+    /** Returns string label of given step if it is a text label. */
+    _stringLabel(): string | null;
+    /** Returns MatStepLabel if the label of given step is a template label. */
+    _templateLabel(): MatStepLabel | null;
+    /** Returns the host HTML element. */
+    _getHostElement(): HTMLElement;
+    /** Template context variables that are exposed to the `matStepperIcon` instances. */
+    _getIconContext(): MatStepperIconContext;
+    _getDefaultTextForState(state: StepState): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepHeader, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MatStepHeader, "mat-step-header", never, { "color": "color"; "state": "state"; "label": "label"; "errorMessage": "errorMessage"; "iconOverrides": "iconOverrides"; "index": "index"; "selected": "selected"; "active": "active"; "optional": "optional"; "disableRipple": "disableRipple"; }, {}, never, never, false>;
+}
+
+/** @docs-private */
+declare const _MatStepHeaderBase: _Constructor<CanColor> & _AbstractConstructor<CanColor> & {
+    new (elementRef: ElementRef): {
+        _elementRef: ElementRef<HTMLElement>;
+        focus(): void;
+    };
+    ɵfac: unknown;
+    ɵdir: unknown;
+};
+
+export declare class MatStepLabel extends CdkStepLabel {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepLabel, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepLabel, "[matStepLabel]", never, {}, {}, never, never, false>;
+}
+
+export declare class MatStepper extends CdkStepper implements AfterContentInit {
+    /** The list of step headers of the steps in the stepper. */
+    _stepHeader: QueryList<MatStepHeader>;
+    /** Full list of steps inside the stepper, including inside nested steppers. */
+    _steps: QueryList<MatStep>;
+    /** Steps that belong to the current stepper, excluding ones from nested steppers. */
+    readonly steps: QueryList<MatStep>;
+    /** Custom icon overrides passed in by the consumer. */
+    _icons: QueryList<MatStepperIcon>;
+    /** Event emitted when the current step is done transitioning in. */
+    readonly animationDone: EventEmitter<void>;
+    /** Whether ripples should be disabled for the step headers. */
+    disableRipple: boolean;
+    /** Theme color for all of the steps in stepper. */
+    color: ThemePalette;
+    /**
+     * Whether the label should display in bottom or end position.
+     * Only applies in the `horizontal` orientation.
+     */
+    labelPosition: 'bottom' | 'end';
+    /**
+     * Position of the stepper's header.
+     * Only applies in the `horizontal` orientation.
+     */
+    headerPosition: 'top' | 'bottom';
+    /** Consumer-specified template-refs to be used to override the header icons. */
+    _iconOverrides: Record<string, TemplateRef<MatStepperIconContext>>;
+    /** Stream of animation `done` events when the body expands/collapses. */
+    readonly _animationDone: Subject<AnimationEvent_2>;
+    /** Duration for the animation. Will be normalized to milliseconds if no units are set. */
+    get animationDuration(): string;
+    set animationDuration(value: string);
+    private _animationDuration;
+    constructor(dir: Directionality, changeDetectorRef: ChangeDetectorRef, elementRef: ElementRef<HTMLElement>);
+    ngAfterContentInit(): void;
+    _stepIsNavigable(index: number, step: MatStep): boolean;
+    _getAnimationDuration(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepper, [{ optional: true; }, null, null]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MatStepper, "mat-stepper, mat-vertical-stepper, mat-horizontal-stepper, [matStepper]", ["matStepper", "matVerticalStepper", "matHorizontalStepper"], { "selectedIndex": "selectedIndex"; "disableRipple": "disableRipple"; "color": "color"; "labelPosition": "labelPosition"; "headerPosition": "headerPosition"; "animationDuration": "animationDuration"; }, { "animationDone": "animationDone"; }, ["_steps", "_icons"], never, false>;
+}
+
+/**
+ * Animations used by the Material steppers.
+ * @docs-private
+ */
+export declare const matStepperAnimations: {
+    readonly horizontalStepTransition: AnimationTriggerMetadata;
+    readonly verticalStepTransition: AnimationTriggerMetadata;
+};
+
+/**
+ * Template to be used to override the icons inside the step header.
+ */
+export declare class MatStepperIcon {
+    templateRef: TemplateRef<MatStepperIconContext>;
+    /** Name of the icon to be overridden. */
+    name: StepState;
+    constructor(templateRef: TemplateRef<MatStepperIconContext>);
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperIcon, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepperIcon, "ng-template[matStepperIcon]", never, { "name": "matStepperIcon"; }, {}, never, never, false>;
+}
+
+/** Template context available to an attached `matStepperIcon`. */
+export declare interface MatStepperIconContext {
+    /** Index of the step. */
+    index: number;
+    /** Whether the step is currently active. */
+    active: boolean;
+    /** Whether the step is optional. */
+    optional: boolean;
+}
+
+/** Stepper data that is required for internationalization. */
+export declare class MatStepperIntl {
+    /**
+     * Stream that emits whenever the labels here are changed. Use this to notify
+     * components if the labels have changed after initialization.
+     */
+    readonly changes: Subject<void>;
+    /** Label that is rendered below optional steps. */
+    optionalLabel: string;
+    /** Label that is used to indicate step as completed to screen readers. */
+    completedLabel: string;
+    /** Label that is used to indicate step as editable to screen readers. */
+    editableLabel: string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperIntl, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MatStepperIntl>;
+}
+
+export declare class MatStepperModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<MatStepperModule, [typeof i1.MatStep, typeof i2.MatStepLabel, typeof i1.MatStepper, typeof i3.MatStepperNext, typeof i3.MatStepperPrevious, typeof i4.MatStepHeader, typeof i5.MatStepperIcon, typeof i6.MatStepContent], [typeof i7.MatCommonModule, typeof i8.CommonModule, typeof i9.PortalModule, typeof i10.MatButtonModule, typeof i11.CdkStepperModule, typeof i12.MatIconModule, typeof i7.MatRippleModule], [typeof i7.MatCommonModule, typeof i1.MatStep, typeof i2.MatStepLabel, typeof i1.MatStepper, typeof i3.MatStepperNext, typeof i3.MatStepperPrevious, typeof i4.MatStepHeader, typeof i5.MatStepperIcon, typeof i6.MatStepContent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<MatStepperModule>;
+}
+
+/** Button that moves to the next step in a stepper workflow. */
+export declare class MatStepperNext extends CdkStepperNext {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperNext, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepperNext, "button[matStepperNext]", never, { "type": "type"; }, {}, never, never, false>;
+}
+
+/** Button that moves to the previous step in a stepper workflow. */
+export declare class MatStepperPrevious extends CdkStepperPrevious {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperPrevious, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepperPrevious, "button[matStepperPrevious]", never, { "type": "type"; }, {}, never, never, false>;
+}
+
+export { StepperOrientation }
+
+export { StepState }
+
+export { }

package/stepper/testing/index.d.ts

@@ -1,8 +1,144 @@
+import { BaseHarnessFilters } from '@angular/cdk/testing';
+import { ComponentHarness } from '@angular/cdk/testing';
+import { ContentContainerComponentHarness } from '@angular/cdk/testing';
+import { HarnessLoader } from '@angular/cdk/testing';
+import { HarnessPredicate } from '@angular/cdk/testing';
+
+/** Harness for interacting with a standard Angular Material step in tests. */
+export declare class MatStepHarness extends ContentContainerComponentHarness<string> {
+    /** The selector for the host element of a `MatStep` instance. */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a `MatStepHarness` that meets
+     * certain criteria.
+     * @param options Options for filtering which steps are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with(options?: StepHarnessFilters): HarnessPredicate<MatStepHarness>;
+    /** Gets the label of the step. */
+    getLabel(): Promise<string>;
+    /** Gets the `aria-label` of the step. */
+    getAriaLabel(): Promise<string | null>;
+    /** Gets the value of the `aria-labelledby` attribute. */
+    getAriaLabelledby(): Promise<string | null>;
+    /** Whether the step is selected. */
+    isSelected(): Promise<boolean>;
+    /** Whether the step has been filled out. */
+    isCompleted(): Promise<boolean>;
+    /**
+     * Whether the step is currently showing its error state. Note that this doesn't mean that there
+     * are or aren't any invalid form controls inside the step, but that the step is showing its
+     * error-specific styling which depends on there being invalid controls, as well as the
+     * `ErrorStateMatcher` determining that an error should be shown and that the `showErrors`
+     * option was enabled through the `STEPPER_GLOBAL_OPTIONS` injection token.
+     */
+    hasErrors(): Promise<boolean>;
+    /** Whether the step is optional. */
+    isOptional(): Promise<boolean>;
+    /**
+     * Selects the given step by clicking on the label. The step may not be selected
+     * if the stepper doesn't allow it (e.g. if there are validation errors).
+     */
+    select(): Promise<void>;
+    protected getRootHarnessLoader(): Promise<HarnessLoader>;
+    /**
+     * Gets the state of the step. Note that we have a `StepState` which we could use to type the
+     * return value, but it's basically the same as `string`, because the type has `| string`.
+     */
+    private _getIconState;
+}
+
+/** Harness for interacting with a standard Material stepper in tests. */
+export declare class MatStepperHarness extends ComponentHarness {
+    /** The selector for the host element of a `MatStepper` instance. */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a `MatStepperHarness` that meets
+     * certain criteria.
+     * @param options Options for filtering which stepper instances are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with(options?: StepperHarnessFilters): HarnessPredicate<MatStepperHarness>;
+    /**
+     * Gets the list of steps in the stepper.
+     * @param filter Optionally filters which steps are included.
+     */
+    getSteps(filter?: StepHarnessFilters): Promise<MatStepHarness[]>;
+    /** Gets the orientation of the stepper. */
+    getOrientation(): Promise<StepperOrientation>;
+    /**
+     * Selects a step in this stepper.
+     * @param filter An optional filter to apply to the child steps. The first step matching the
+     *    filter will be selected.
+     */
+    selectStep(filter?: StepHarnessFilters): Promise<void>;
+}
+
+/** Harness for interacting with a standard Angular Material stepper next button in tests. */
+export declare class MatStepperNextHarness extends StepperButtonHarness {
+    /** The selector for the host element of a `MatStep` instance. */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a `MatStepperNextHarness` that meets
+     * certain criteria.
+     * @param options Options for filtering which steps are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with(options?: StepperButtonHarnessFilters): HarnessPredicate<MatStepperNextHarness>;
+}
+
+/** Harness for interacting with a standard Angular Material stepper previous button in tests. */
+export declare class MatStepperPreviousHarness extends StepperButtonHarness {
+    /** The selector for the host element of a `MatStep` instance. */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a `MatStepperPreviousHarness`
+     * that meets certain criteria.
+     * @param options Options for filtering which steps are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with(options?: StepperButtonHarnessFilters): HarnessPredicate<MatStepperPreviousHarness>;
+}
+
+/** A set of criteria that can be used to filter a list of `MatStepHarness` instances. */
+export declare interface StepHarnessFilters extends BaseHarnessFilters {
+    /** Only find instances whose label matches the given value. */
+    label?: string | RegExp;
+    /** Only find steps with the given selected state. */
+    selected?: boolean;
+    /** Only find completed steps. */
+    completed?: boolean;
+    /** Only find steps that have errors. */
+    invalid?: boolean;
+}
+
+/** Base class for stepper button harnesses. */
+declare abstract class StepperButtonHarness extends ComponentHarness {
+    /** Gets the text of the button. */
+    getText(): Promise<string>;
+    /** Clicks the button. */
+    click(): Promise<void>;
+}
+
 /**
- * @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
+ * A set of criteria that can be used to filter a list of
+ * `MatStepperNextHarness` and `MatStepperPreviousHarness` instances.
  */
-export * from './public-api';
+export declare interface StepperButtonHarnessFilters extends BaseHarnessFilters {
+    /** Only find instances whose text matches the given value. */
+    text?: string | RegExp;
+}
+
+/** A set of criteria that can be used to filter a list of `MatStepperHarness` instances. */
+export declare interface StepperHarnessFilters extends BaseHarnessFilters {
+    /** Only find instances whose orientation matches the given value. */
+    orientation?: StepperOrientation;
+}
+
+/** Possible orientations for a stepper. */
+export declare const enum StepperOrientation {
+    HORIZONTAL = 0,
+    VERTICAL = 1
+}
+
+export { }