index.api.md

API Report File for "@angular/material_stepper"

Do not edit this file. It is a report generated by API Extractor.

import { AbstractControl } from '@angular/forms';
import { AfterContentInit } from '@angular/core';
import { AfterViewChecked } from '@angular/core';
import { AfterViewInit } from '@angular/core';
import { CdkStep } from '@angular/cdk/stepper';
import { CdkStepHeader } 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 { ElementRef } from '@angular/core';
import { EventEmitter } from '@angular/core';
import { FocusOrigin } from '@angular/cdk/a11y';
import { FormGroupDirective } from '@angular/forms';
import * as i0 from '@angular/core';
import * as i1 from '@angular/cdk/bidi';
import * as i3$1 from '@angular/cdk/stepper';
import * as i3 from '@angular/cdk/portal';
import { NgForm } from '@angular/forms';
import { OnDestroy } from '@angular/core';
import { OnInit } from '@angular/core';
import { Optional } from '@angular/core';
import { QueryList } from '@angular/core';
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';

// @public @deprecated
export const MAT_STEPPER_INTL_PROVIDER: {
    provide: typeof MatStepperIntl;
    deps: Optional[][];
    useFactory: typeof MAT_STEPPER_INTL_PROVIDER_FACTORY;
};

// @public @deprecated
export function MAT_STEPPER_INTL_PROVIDER_FACTORY(parentIntl: MatStepperIntl): MatStepperIntl;

// @public (undocumented)
export class MatStep extends CdkStep implements ErrorStateMatcher, AfterContentInit, OnDestroy {
    color: ThemePalette;
    isErrorState(control: AbstractControl | null, form: FormGroupDirective | NgForm | null): boolean;
    _lazyContent: MatStepContent;
    // (undocumented)
    ngAfterContentInit(): void;
    // (undocumented)
    ngOnDestroy(): void;
    _portal: TemplatePortal;
    stepLabel: MatStepLabel;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatStep, "mat-step", ["matStep"], { "color": { "alias": "color"; "required": false; }; }, {}, ["stepLabel", "_lazyContent"], ["*"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStep, never>;
}

// @public
export class MatStepContent {
    constructor(...args: unknown[]);
    // (undocumented)
    _template: TemplateRef<unknown>;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepContent, "ng-template[matStepContent]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepContent, never>;
}

// @public (undocumented)
export class MatStepHeader extends CdkStepHeader implements AfterViewInit, OnDestroy {
    constructor(...args: unknown[]);
    active: boolean;
    color: ThemePalette;
    disableRipple: boolean;
    errorMessage: string;
    focus(origin?: FocusOrigin, options?: FocusOptions): void;
    // (undocumented)
    _getDefaultTextForState(state: StepState): string;
    _getHostElement(): HTMLElement;
    _getIconContext(): MatStepperIconContext;
    iconOverrides: {
        [key: string]: TemplateRef<MatStepperIconContext>;
    };
    index: number;
    // (undocumented)
    _intl: MatStepperIntl;
    label: MatStepLabel | string;
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngOnDestroy(): void;
    optional: boolean;
    selected: boolean;
    state: StepState;
    _stringLabel(): string | null;
    _templateLabel(): MatStepLabel | null;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatStepHeader, "mat-step-header", never, { "state": { "alias": "state"; "required": false; }; "label": { "alias": "label"; "required": false; }; "errorMessage": { "alias": "errorMessage"; "required": false; }; "iconOverrides": { "alias": "iconOverrides"; "required": false; }; "index": { "alias": "index"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "active": { "alias": "active"; "required": false; }; "optional": { "alias": "optional"; "required": false; }; "disableRipple": { "alias": "disableRipple"; "required": false; }; "color": { "alias": "color"; "required": false; }; }, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepHeader, never>;
}

// @public (undocumented)
export class MatStepLabel extends CdkStepLabel {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepLabel, "[matStepLabel]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepLabel, never>;
}

// @public (undocumented)
export class MatStepper extends CdkStepper implements AfterViewInit, AfterContentInit, OnDestroy {
    constructor(...args: unknown[]);
    _animatedContainers: QueryList<ElementRef>;
    readonly animationDone: EventEmitter<void>;
    get animationDuration(): string;
    set animationDuration(value: string);
    color: ThemePalette;
    disableRipple: boolean;
    // (undocumented)
    _getAnimationDuration(): string;
    headerPosition: 'top' | 'bottom';
    _iconOverrides: Record<string, TemplateRef<MatStepperIconContext>>;
    _icons: QueryList<MatStepperIcon>;
    // (undocumented)
    protected _isAnimating: i0.WritableSignal<boolean>;
    protected _isServer: boolean;
    labelPosition: 'bottom' | 'end';
    // (undocumented)
    ngAfterContentInit(): void;
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngOnDestroy(): void;
    _stepHeader: QueryList<MatStepHeader>;
    // (undocumented)
    _stepIsNavigable(index: number, step: MatStep): boolean;
    readonly steps: QueryList<MatStep>;
    _steps: QueryList<MatStep>;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatStepper, "mat-stepper, mat-vertical-stepper, mat-horizontal-stepper, [matStepper]", ["matStepper", "matVerticalStepper", "matHorizontalStepper"], { "disableRipple": { "alias": "disableRipple"; "required": false; }; "color": { "alias": "color"; "required": false; }; "labelPosition": { "alias": "labelPosition"; "required": false; }; "headerPosition": { "alias": "headerPosition"; "required": false; }; "animationDuration": { "alias": "animationDuration"; "required": false; }; }, { "animationDone": "animationDone"; }, ["_steps", "_icons"], ["*"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepper, never>;
}

// @public @deprecated
export const matStepperAnimations: {
    readonly horizontalStepTransition: any;
    readonly verticalStepTransition: any;
};

// @public
export class MatStepperIcon {
    constructor(...args: unknown[]);
    name: StepState;
    // (undocumented)
    templateRef: TemplateRef<MatStepperIconContext>;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepperIcon, "ng-template[matStepperIcon]", never, { "name": { "alias": "matStepperIcon"; "required": false; }; }, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperIcon, never>;
}

// @public
export interface MatStepperIconContext {
    active: boolean;
    index: number;
    optional: boolean;
}

// @public
export class MatStepperIntl {
    readonly changes: Subject<void>;
    completedLabel: string;
    editableLabel: string;
    optionalLabel: string;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperIntl, never>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<MatStepperIntl>;
}

// @public (undocumented)
export class MatStepperModule {
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<MatStepperModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<MatStepperModule, never, [typeof MatCommonModule, typeof i3.PortalModule, typeof i3$1.CdkStepperModule, typeof MatIconModule, typeof MatRippleModule, typeof MatStep, typeof MatStepLabel, typeof MatStepper, typeof MatStepperNext, typeof MatStepperPrevious, typeof MatStepHeader, typeof MatStepperIcon, typeof MatStepContent], [typeof MatCommonModule, typeof MatStep, typeof MatStepLabel, typeof MatStepper, typeof MatStepperNext, typeof MatStepperPrevious, typeof MatStepHeader, typeof MatStepperIcon, typeof MatStepContent]>;
}

// @public
export class MatStepperNext extends CdkStepperNext {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepperNext, "button[matStepperNext]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperNext, never>;
}

// @public
export class MatStepperPrevious extends CdkStepperPrevious {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatStepperPrevious, "button[matStepperPrevious]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatStepperPrevious, never>;
}

export { StepperOrientation }

export { StepState }

// (No @packageDocumentation comment for this package)