import * as i0 from "@angular/core"; import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, InjectionToken, OnDestroy, OnInit, Renderer2, TemplateRef } from "@angular/core"; import { IBaseCancelableBrowserEventArgs, IBaseEventArgs, PlatformUtil } from "igniteui-angular/core"; import { CarouselAnimationDirection, IgxCarouselComponentBase, IgxSlideComponentBase } from "igniteui-angular/carousel"; import * as i1 from "igniteui-angular/directives"; import { ToggleAnimationPlayer, ToggleAnimationSettings } from "igniteui-angular/expansion-panel"; /** * Allows a custom element to be added as an active step indicator. * * @igxModule IgxStepperModule * @igxTheme igx-stepper-theme * @igxKeywords stepper * @igxGroup Layouts * * @example * * * edit * * */ export declare class IgxStepActiveIndicatorDirective { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } /** * Allows a custom element to be added as a complete step indicator. * * @igxModule IgxStepperModule * @igxTheme igx-stepper-theme * @igxKeywords stepper * @igxGroup Layouts * * @example * * * check * * */ export declare class IgxStepCompletedIndicatorDirective { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } /** * Allows a custom element to be added as an invalid step indicator. * * @igxModule IgxStepperModule * @igxTheme igx-stepper-theme * @igxKeywords stepper * @igxGroup Layouts * * @example * * * error * * */ export declare class IgxStepInvalidIndicatorDirective { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } /** * Allows a custom element to be added as a step indicator. * * @igxModule IgxStepperModule * @igxTheme igx-stepper-theme * @igxKeywords stepper * @igxGroup Layouts * * @example * * * home * * */ export declare class IgxStepIndicatorDirective { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } /** * Allows a custom element to be added as a step title. * * @igxModule IgxStepperModule * @igxTheme igx-stepper-theme * @igxKeywords stepper * @igxGroup Layouts * * @example * * *

Home

*
*
*/ export declare class IgxStepTitleDirective { defaultClass: boolean; headerElementClass: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } /** * Allows a custom element to be added as a step subtitle. * * @igxModule IgxStepperModule * @igxTheme igx-stepper-theme * @igxKeywords stepper * @igxGroup Layouts * * @example * * *

Home Subtitle

*
*
*/ export declare class IgxStepSubtitleDirective { elementClass: boolean; headerElementClass: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } /** * Allows a custom element to be added as a step content. * * @igxModule IgxStepperModule * @igxTheme igx-stepper-theme * @igxKeywords stepper * @igxGroup Layouts * * @example * * *
...
*
*
*/ export declare class IgxStepContentDirective { private step; private stepperService; elementRef: ElementRef; defaultClass: boolean; role: string; get stepId(): string; id: string; get tabIndex(): number; set tabIndex(val: number); private _tabIndex; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } /** * Stepper provides a wizard-like workflow by dividing content into logical steps. * * @igxModule IgxStepperModule * * @igxKeywords stepper * * @igxGroup Layouts * * @remarks * The Ignite UI for Angular Stepper component allows the user to navigate between multiple steps. * It supports horizontal and vertical orientation as well as keyboard navigation and provides API methods to control the active step. * The component offers keyboard navigation and API to control the active step. * * @example * ```html * * * home *

Home

*
* ... *
*
* *
* ... *
*
* *
* ... *
*
*
* ``` */ export declare class IgxStepperComponent extends IgxCarouselComponentBase implements IgxStepper, OnInit, AfterContentInit, OnDestroy { private stepperService; private element; /** * Get/Set the animation type of the stepper when the orientation direction is vertical. * * @remarks * Default value is `grow`. Other possible values are `fade` and `none`. * * ```html * * * ``` */ get verticalAnimationType(): VerticalAnimationType; set verticalAnimationType(value: VerticalAnimationType); /** * Get/Set the animation type of the stepper when the orientation direction is horizontal. * * @remarks * Default value is `slide`. Other possible values are `fade` and `none`. * * ```html * * * ``` */ get horizontalAnimationType(): HorizontalAnimationType; set horizontalAnimationType(value: HorizontalAnimationType); /** * Get/Set the animation duration in milliseconds. * * @remarks * Default value is `320`. It is also used when the value is not a positive number. * * ```html * * * ``` */ get animationDuration(): number; set animationDuration(value: number); /** * Get/Set whether the stepper is linear. * * @remarks * If the stepper is in linear mode, the steps after the first invalid step that is not optional or disabled * cannot be reached until it becomes valid. The step activated through the API is not disabled. * * ```html * * ``` */ get linear(): boolean; set linear(value: boolean); /** * Get/Set the stepper orientation. * * ```typescript * this.stepper.orientation = IgxStepperOrientation.Vertical; * ``` */ get orientation(): IgxStepperOrientation; set orientation(value: IgxStepperOrientation); /** * Get/Set the type of the steps. * * ```typescript * this.stepper.stepType = IgxStepType.Indicator; * ``` */ stepType: IgxStepType; /** * Get/Set whether the content is displayed above the steps. * * @remarks * Default value is `false` and the content is below the steps. * * ```typescript * this.stepper.contentTop = true; * ``` */ contentTop: boolean; /** * Get/Set the position of the steps title. * * @remarks * The default value when the stepper is horizontally orientated is `bottom`. * In vertical layout the default title position is `end`. * * ```typescript * this.stepper.titlePosition = IgxStepperTitlePosition.Top; * ``` */ titlePosition: IgxStepperTitlePosition; /** @hidden @internal **/ cssClass: string; /** @hidden @internal **/ role: string; /** @hidden @internal **/ get directionClass(): boolean; /** * Emitted when the stepper's active step is changing. * *```html * * * ``` * *```typescript * public handleActiveStepChanging(event: IStepChangingEventArgs) { * if (event.newIndex < event.oldIndex) { * event.cancel = true; * } * } *``` */ activeStepChanging: EventEmitter; /** * Emitted when the active step is changed. * * @example * ``` * * ``` */ activeStepChanged: EventEmitter; /** @hidden @internal */ invalidIndicatorTemplate: TemplateRef; /** @hidden @internal */ completedIndicatorTemplate: TemplateRef; /** @hidden @internal */ activeIndicatorTemplate: TemplateRef; /** @hidden @internal */ private _steps; /** * Get all steps. * * ```typescript * const steps: IgxStepComponent[] = this.stepper.steps; * ``` */ get steps(): IgxStepComponent[]; /** @hidden @internal */ get nativeElement(): HTMLElement; /** @hidden @internal */ verticalAnimationSettings: ToggleAnimationSettings; /** @hidden @internal */ _defaultTitlePosition: IgxStepperTitlePosition; private destroy$; private _orientation; private _verticalAnimationType; private _linear; private readonly _defaultAnimationDuration; constructor(); /** @hidden @internal */ ngOnInit(): void; /** @hidden @internal */ ngAfterContentInit(): void; /** @hidden @internal */ ngOnDestroy(): void; /** * Activates the step at a given index. * *```typescript * this.stepper.navigateTo(1); *``` */ navigateTo(index: number): void; /** * Activates the next enabled step. * *```typescript * this.stepper.next(); *``` */ next(): void; /** * Activates the previous enabled step. * *```typescript * this.stepper.prev(); *``` */ prev(): void; /** * Resets the stepper to its initial state i.e. activates the first step. * * @remarks * The steps' content will not be automatically reset. *```typescript * this.stepper.reset(); *``` */ reset(): void; /** @hidden @internal */ playHorizontalAnimations(): void; protected getPreviousElement(): HTMLElement; protected getCurrentElement(): HTMLElement; private updateVerticalAnimationSettings; private updateStepAria; private handleStepChanges; private activateFirstStep; private moveToNextStep; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; static ngAcceptInputType_linear: unknown; static ngAcceptInputType_contentTop: unknown; } interface IgxStepper extends IgxCarouselComponentBase { steps: IgxStepComponent[]; /** @hidden @internal */ nativeElement: HTMLElement; /** @hidden @internal */ invalidIndicatorTemplate: TemplateRef; /** @hidden @internal */ completedIndicatorTemplate: TemplateRef; /** @hidden @internal */ activeIndicatorTemplate: TemplateRef; verticalAnimationType: VerticalAnimationType; horizontalAnimationType: HorizontalAnimationType; animationDuration: number; linear: boolean; orientation: IgxStepperOrientation; stepType: IgxStepType; contentTop: boolean; titlePosition: IgxStepperTitlePosition; /** @hidden @internal */ verticalAnimationSettings: ToggleAnimationSettings; /** @hidden @internal */ _defaultTitlePosition: IgxStepperTitlePosition; activeStepChanging: EventEmitter; activeStepChanged: EventEmitter; navigateTo(index: number): void; next(): void; prev(): void; reset(): void; /** @hidden @internal */ playHorizontalAnimations(): void; } interface IgxStep extends ToggleAnimationPlayer { id: string; /** @hidden @internal */ contentTemplate: TemplateRef; /** @hidden @internal */ customIndicatorTemplate: TemplateRef; /** @hidden @internal */ contentContainer: ElementRef; /** @hidden @internal */ indicator: IgxStepIndicatorDirective; /** @hidden @internal */ content: IgxStepContentDirective; /** @hidden @internal */ indicatorTemplate: TemplateRef; index: number; disabled: boolean; completed: boolean; isValid: boolean; optional: boolean; active: boolean; tabIndex: number; /** @hidden @internal */ contentId: string; /** @hidden @internal */ generalDisabled: boolean; /** @hidden @internal */ titlePositionTop: string; /** @hidden @internal */ direction: CarouselAnimationDirection; /** @hidden @internal */ isAccessible: boolean; /** @hidden @internal */ isHorizontal: boolean; /** @hidden @internal */ isTitleVisible: boolean; /** @hidden @internal */ isIndicatorVisible: boolean; /** @hidden @internal */ titlePosition: string; /** @hidden @internal */ linearDisabled: boolean; /** @hidden @internal */ collapsing: boolean; /** @hidden @internal */ animationSettings: ToggleAnimationSettings; /** @hidden @internal */ contentClasses: any; /** @hidden @internal */ nativeElement: HTMLElement; /** @hidden @internal */ previous: boolean; cdr: ChangeDetectorRef; activeChange: EventEmitter; } export interface IStepChangingEventArgs extends IBaseEventArgs, IBaseCancelableBrowserEventArgs { newIndex: number; oldIndex: number; owner: IgxStepper; } export interface IStepChangedEventArgs extends IBaseEventArgs { index: number; owner: IgxStepper; } export declare const IgxStepperOrientation: { readonly Horizontal: "horizontal"; readonly Vertical: "vertical"; }; export type IgxStepperOrientation = (typeof IgxStepperOrientation)[keyof typeof IgxStepperOrientation]; export declare const IgxStepType: { readonly Indicator: "indicator"; readonly Title: "title"; readonly Full: "full"; }; export type IgxStepType = (typeof IgxStepType)[keyof typeof IgxStepType]; export declare const IgxStepperTitlePosition: { readonly Bottom: "bottom"; readonly Top: "top"; readonly End: "end"; readonly Start: "start"; }; export type IgxStepperTitlePosition = (typeof IgxStepperTitlePosition)[keyof typeof IgxStepperTitlePosition]; export declare const VerticalAnimationType: { readonly Grow: "grow"; readonly Fade: "fade"; readonly None: "none"; }; export type VerticalAnimationType = (typeof VerticalAnimationType)[keyof typeof VerticalAnimationType]; export declare const HorizontalAnimationType: { readonly none: "none"; readonly slide: "slide"; readonly fade: "fade"; }; export type HorizontalAnimationType = (typeof HorizontalAnimationType)[keyof typeof HorizontalAnimationType]; declare const IGX_STEPPER_COMPONENT: InjectionToken; declare const IGX_STEP_COMPONENT: InjectionToken; /** @hidden @internal */ declare class IgxStepperService { previousActiveStep: IgxStepComponent; collapsingSteps: Set; linearDisabledSteps: Set; visitedSteps: Set; stepper: IgxStepper; /** * Signal-backed so that the bindings reading the active state (e.g. `aria-selected`) are refreshed * when it is changed after they were checked, e.g. by the stepper in `ngAfterContentInit`. */ private readonly _activeStep; get activeStep(): IgxStepComponent; set activeStep(value: IgxStepComponent); /** * Activates the step, fires the steps change event and plays animations. */ expand(step: IgxStepComponent): void; /** * Activates the step and fires the steps change event without playing animations. */ expandThroughApi(step: IgxStepComponent): void; /** * Collapses a step that is no longer active and fires its change event. */ collapse(step: IgxStepComponent): void; /** * Collapses all steps whose collapse animation has not finished yet. */ collapseAll(): void; /** * Removes the steps that are no longer in the stepper from its state. */ removeDetachedSteps(): void; /** * Determines the steps that should be marked as visited based on the active step. */ calculateVisitedSteps(): void; /** * Determines the steps that should be disabled in linear mode, i.e. the steps after the first step * which should be valid before moving forward. The active step is not disabled, as it can be activated * past that step through the API. */ calculateLinearDisabledSteps(): void; emitActivatingEvent(step: IgxStepComponent): boolean; private setActiveStep; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * The step is used within the stepper element and it holds the content of each step. * It also supports custom indicators, title and subtitle. * * @igxModule IgxStepperModule * * @igxKeywords step * * @example * ```html * * ... * * ... * * ... * * ``` */ export declare class IgxStepComponent extends ToggleAnimationPlayer implements IgxStep, AfterViewInit, OnDestroy, IgxSlideComponentBase { stepper: IgxStepper; cdr: ChangeDetectorRef; renderer: Renderer2; protected platform: PlatformUtil; protected stepperService: IgxStepperService; private element; /** * Get/Set the `id` of the step component. * Default value is `"igx-step-0"`; * ```html * * ``` * ```typescript * const stepId = this.step.id; * ``` */ id: string; /** * Get/Set whether the step is interactable. * * ```html * * ... * * ... * * ``` * * ```typescript * this.stepper.steps[1].disabled = true; * ``` */ set disabled(value: boolean); get disabled(): boolean; /** * Get/Set whether the step is completed. * * @remarks * When set to `true` the following separator is styled `solid`. * * ```html * * ... * * ... * * ``` * * ```typescript * this.stepper.steps[1].completed = true; * ``` */ completed: boolean; /** * Get/Set whether the step is valid. *```html * * ... *
*
* ... *
*
*
* ``` */ get isValid(): boolean; set isValid(value: boolean); /** * Get/Set whether the step is optional. * * @remarks * Optional steps validity does not affect the default behavior when the stepper is in linear mode i.e. * if optional step is invalid the user could still move to the next step. * * ```html * * ``` * ```typescript * this.stepper.steps[1].optional = true; * ``` */ set optional(value: boolean); get optional(): boolean; /** * Get/Set the active state of the step * * ```html * * ``` * * ```typescript * this.stepper.steps[1].active = true; * ``` * * @param value: boolean */ set active(value: boolean); get active(): boolean; /** @hidden @internal */ set tabIndex(value: number); get tabIndex(): number; /** @hidden @internal **/ role: string; /** @hidden @internal */ get contentId(): string; /** @hidden @internal */ cssClass: boolean; /** @hidden @internal */ get isVertical(): boolean; /** @hidden @internal */ get generalDisabled(): boolean; /** @hidden @internal */ get titlePositionTop(): string; /** @hidden @internal */ get isActive(): boolean; /** @hidden @internal */ get isInvalid(): boolean; /** @hidden @internal */ get stepHeaderClasses(): { [key: string]: boolean; }; /** * Emitted when the step's `active` property changes. Can be used for two-way binding. * * ```html * * * ``` * * ```typescript * const step: IgxStepComponent = this.stepper.step[0]; * step.activeChange.subscribe((e: boolean) => console.log("Step active state change to ", e)) * ``` */ activeChange: EventEmitter; /** @hidden @internal */ contentTemplate: TemplateRef; /** @hidden @internal */ customIndicatorTemplate: TemplateRef; /** @hidden @internal */ contentContainer: ElementRef; /** @hidden @internal */ indicator: IgxStepIndicatorDirective; /** @hidden @internal */ content: IgxStepContentDirective; /** * Get the step index inside of the stepper. * * ```typescript * const step = this.stepper.steps[1]; * const stepIndex: number = step.index; * ``` */ get index(): number; /** @hidden @internal */ get indicatorTemplate(): TemplateRef; /** @hidden @internal */ get direction(): CarouselAnimationDirection; /** @hidden @internal */ get isAccessible(): boolean; /** @hidden @internal */ get isHorizontal(): boolean; /** @hidden @internal */ get isTitleVisible(): boolean; /** @hidden @internal */ get isIndicatorVisible(): boolean; /** @hidden @internal */ get titlePosition(): string; /** @hidden @internal */ get linearDisabled(): boolean; /** @hidden @internal */ get collapsing(): boolean; /** @hidden @internal */ get animationSettings(): ToggleAnimationSettings; /** @hidden @internal */ get contentClasses(): any; /** @hidden @internal */ get nativeElement(): HTMLElement; /** @hidden @internal */ previous: boolean; /** * @hidden @internal * Signal-backed, like the tab index, so that the bindings reading it are refreshed * when it is set by the stepper after they were checked, e.g. in `ngAfterContentInit`. */ readonly _index: import("@angular/core").WritableSignal; private readonly _tabIndex; private _valid; private _focused; private _disabled; private _optional; /** @hidden @internal */ onFocus(): void; /** @hidden @internal */ onBlur(): void; /** @hidden @internal */ handleKeydown(event: KeyboardEvent): void; /** @hidden @internal */ ngAfterViewInit(): void; /** @hidden @internal */ onPointerDown(event: MouseEvent): void; /** @hidden @internal */ handleNavigation(key: string): void; /** * @hidden @internal * Activates the step, playing the animations for the current orientation. */ activate(): void; private get accessibleSteps(); /** The next accessible step, wrapping around to the first one */ private get nextStep(); /** The previous accessible step, wrapping around to the last one */ private get previousStep(); private activateWithoutAnimation; private changeHorizontalActiveStep; private changeVerticalActiveStep; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; static ngAcceptInputType_disabled: unknown; static ngAcceptInputType_completed: unknown; static ngAcceptInputType_isValid: unknown; static ngAcceptInputType_optional: unknown; static ngAcceptInputType_active: unknown; } export declare const IGX_STEPPER_DIRECTIVES: readonly [typeof IgxStepComponent, typeof IgxStepperComponent, typeof IgxStepTitleDirective, typeof IgxStepSubtitleDirective, typeof IgxStepIndicatorDirective, typeof IgxStepContentDirective, typeof IgxStepActiveIndicatorDirective, typeof IgxStepCompletedIndicatorDirective, typeof IgxStepInvalidIndicatorDirective]; /** * @hidden * IMPORTANT: The following is NgModule exported for backwards-compatibility before standalone components */ export declare class IgxStepperModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } export {};