import { FocusKeyManager } from '@angular/cdk/a11y'; import { Directionality, BidiModule } from '@angular/cdk/bidi'; import { coerceBooleanProperty, coerceNumberProperty } from '@angular/cdk/coercion'; import { hasModifierKey, SPACE, ENTER } from '@angular/cdk/keycodes'; import { DOCUMENT } from '@angular/common'; import { Directive, ElementRef, TemplateRef, InjectionToken, EventEmitter, Component, ViewEncapsulation, ChangeDetectionStrategy, Inject, forwardRef, Optional, ContentChild, ViewChild, Input, Output, QueryList, ChangeDetectorRef, ContentChildren, HostListener, NgModule } from '@angular/core'; import { _getFocusedElementPierceShadowDom } from '@angular/cdk/platform'; import { Subject, of } from 'rxjs'; import { startWith, takeUntil } from 'rxjs/operators'; /** * @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 */ class CdkStepHeader { constructor(_elementRef) { this._elementRef = _elementRef; } /** Focuses the step header. */ focus() { this._elementRef.nativeElement.focus(); } } CdkStepHeader.decorators = [ { type: Directive, args: [{ selector: '[cdkStepHeader]', host: { 'role': 'tab', }, },] } ]; CdkStepHeader.ctorParameters = () => [ { type: ElementRef } ]; /** * @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 */ class CdkStepLabel { constructor(/** @docs-private */ template) { this.template = template; } } CdkStepLabel.decorators = [ { type: Directive, args: [{ selector: '[cdkStepLabel]', },] } ]; CdkStepLabel.ctorParameters = () => [ { type: TemplateRef } ]; /** * @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 */ /** Used to generate unique ID for each stepper component. */ let nextId = 0; /** Change event emitted on selection changes. */ class StepperSelectionEvent { } /** Enum to represent the different states of the steps. */ const STEP_STATE = { NUMBER: 'number', EDIT: 'edit', DONE: 'done', ERROR: 'error' }; /** InjectionToken that can be used to specify the global stepper options. */ const STEPPER_GLOBAL_OPTIONS = new InjectionToken('STEPPER_GLOBAL_OPTIONS'); class CdkStep { constructor(_stepper, stepperOptions) { this._stepper = _stepper; /** Whether user has attempted to move away from the step. */ this.interacted = false; /** Emits when the user has attempted to move away from the step. */ this.interactedStream = new EventEmitter(); this._editable = true; this._optional = false; this._completedOverride = null; this._customError = null; this._stepperOptions = stepperOptions ? stepperOptions : {}; this._displayDefaultIndicatorType = this._stepperOptions.displayDefaultIndicatorType !== false; } /** Whether the user can return to this step once it has been marked as completed. */ get editable() { return this._editable; } set editable(value) { this._editable = coerceBooleanProperty(value); } /** Whether the completion of step is optional. */ get optional() { return this._optional; } set optional(value) { this._optional = coerceBooleanProperty(value); } /** Whether step is marked as completed. */ get completed() { return this._completedOverride == null ? this._getDefaultCompleted() : this._completedOverride; } set completed(value) { this._completedOverride = coerceBooleanProperty(value); } _getDefaultCompleted() { return this.stepControl ? this.stepControl.valid && this.interacted : this.interacted; } /** Whether step has an error. */ get hasError() { return this._customError == null ? this._getDefaultError() : this._customError; } set hasError(value) { this._customError = coerceBooleanProperty(value); } _getDefaultError() { return this.stepControl && this.stepControl.invalid && this.interacted; } /** Selects this step component. */ select() { this._stepper.selected = this; } /** Resets the step to its initial state. Note that this includes resetting form data. */ reset() { this.interacted = false; if (this._completedOverride != null) { this._completedOverride = false; } if (this._customError != null) { this._customError = false; } if (this.stepControl) { this.stepControl.reset(); } } ngOnChanges() { // Since basically all inputs of the MatStep get proxied through the view down to the // underlying MatStepHeader, we have to make sure that change detection runs correctly. this._stepper._stateChanged(); } _markAsInteracted() { if (!this.interacted) { this.interacted = true; this.interactedStream.emit(this); } } /** Determines whether the error state can be shown. */ _showError() { var _a; // We want to show the error state either if the user opted into/out of it using the // global options, or if they've explicitly set it through the `hasError` input. return (_a = this._stepperOptions.showError) !== null && _a !== void 0 ? _a : this._customError != null; } } CdkStep.decorators = [ { type: Component, args: [{ selector: 'cdk-step', exportAs: 'cdkStep', template: '', encapsulation: ViewEncapsulation.None, changeDetection: ChangeDetectionStrategy.OnPush },] } ]; CdkStep.ctorParameters = () => [ { type: CdkStepper, decorators: [{ type: Inject, args: [forwardRef(() => CdkStepper),] }] }, { type: undefined, decorators: [{ type: Optional }, { type: Inject, args: [STEPPER_GLOBAL_OPTIONS,] }] } ]; CdkStep.propDecorators = { stepLabel: [{ type: ContentChild, args: [CdkStepLabel,] }], content: [{ type: ViewChild, args: [TemplateRef, { static: true },] }], stepControl: [{ type: Input }], interactedStream: [{ type: Output, args: ['interacted',] }], label: [{ type: Input }], errorMessage: [{ type: Input }], ariaLabel: [{ type: Input, args: ['aria-label',] }], ariaLabelledby: [{ type: Input, args: ['aria-labelledby',] }], state: [{ type: Input }], editable: [{ type: Input }], optional: [{ type: Input }], completed: [{ type: Input }], hasError: [{ type: Input }] }; class CdkStepper { constructor(_dir, _changeDetectorRef, _elementRef, /** * @deprecated No longer in use, to be removed. * @breaking-change 13.0.0 */ _document) { this._dir = _dir; this._changeDetectorRef = _changeDetectorRef; this._elementRef = _elementRef; /** Emits when the component is destroyed. */ this._destroyed = new Subject(); /** Steps that belong to the current stepper, excluding ones from nested steppers. */ this.steps = new QueryList(); /** List of step headers sorted based on their DOM order. */ this._sortedHeaders = new QueryList(); this._linear = false; this._selectedIndex = 0; /** Event emitted when the selected step has changed. */ this.selectionChange = new EventEmitter(); /** * @deprecated To be turned into a private property. Use `orientation` instead. * @breaking-change 13.0.0 */ this._orientation = 'horizontal'; this._groupId = nextId++; } /** Whether the validity of previous steps should be checked or not. */ get linear() { return this._linear; } set linear(value) { this._linear = coerceBooleanProperty(value); } /** The index of the selected step. */ get selectedIndex() { return this._selectedIndex; } set selectedIndex(index) { var _a; const newIndex = coerceNumberProperty(index); if (this.steps && this._steps) { // Ensure that the index can't be out of bounds. if (!this._isValidIndex(index) && (typeof ngDevMode === 'undefined' || ngDevMode)) { throw Error('cdkStepper: Cannot assign out-of-bounds value to `selectedIndex`.'); } (_a = this.selected) === null || _a === void 0 ? void 0 : _a._markAsInteracted(); if (this._selectedIndex !== newIndex && !this._anyControlsInvalidOrPending(newIndex) && (newIndex >= this._selectedIndex || this.steps.toArray()[newIndex].editable)) { this._updateSelectedItemIndex(index); } } else { this._selectedIndex = newIndex; } } /** The step that is selected. */ get selected() { return this.steps ? this.steps.toArray()[this.selectedIndex] : undefined; } set selected(step) { this.selectedIndex = (step && this.steps) ? this.steps.toArray().indexOf(step) : -1; } /** Orientation of the stepper. */ get orientation() { return this._orientation; } set orientation(value) { // This is a protected method so that `MatSteppter` can hook into it. this._orientation = value; if (this._keyManager) { this._keyManager.withVerticalOrientation(value === 'vertical'); } } ngAfterContentInit() { this._steps.changes .pipe(startWith(this._steps), takeUntil(this._destroyed)) .subscribe((steps) => { this.steps.reset(steps.filter(step => step._stepper === this)); this.steps.notifyOnChanges(); }); } ngAfterViewInit() { // If the step headers are defined outside of the `ngFor` that renders the steps, like in the // Material stepper, they won't appear in the `QueryList` in the same order as they're // rendered in the DOM which will lead to incorrect keyboard navigation. We need to sort // them manually to ensure that they're correct. Alternatively, we can change the Material // template to inline the headers in the `ngFor`, but that'll result in a lot of // code duplciation. See #23539. this._stepHeader.changes .pipe(startWith(this._stepHeader), takeUntil(this._destroyed)) .subscribe((headers) => { this._sortedHeaders.reset(headers.toArray().sort((a, b) => { const documentPosition = a._elementRef.nativeElement.compareDocumentPosition(b._elementRef.nativeElement); // `compareDocumentPosition` returns a bitmask so we have to use a bitwise operator. // https://developer.mozilla.org/en-US/docs/Web/API/Node/compareDocumentPosition // tslint:disable-next-line:no-bitwise return documentPosition & Node.DOCUMENT_POSITION_FOLLOWING ? -1 : 1; })); this._sortedHeaders.notifyOnChanges(); }); // Note that while the step headers are content children by default, any components that // extend this one might have them as view children. We initialize the keyboard handling in // AfterViewInit so we're guaranteed for both view and content children to be defined. this._keyManager = new FocusKeyManager(this._sortedHeaders) .withWrap() .withHomeAndEnd() .withVerticalOrientation(this._orientation === 'vertical'); (this._dir ? this._dir.change : of()) .pipe(startWith(this._layoutDirection()), takeUntil(this._destroyed)) .subscribe(direction => this._keyManager.withHorizontalOrientation(direction)); this._keyManager.updateActiveItem(this._selectedIndex); // No need to `takeUntil` here, because we're the ones destroying `steps`. this.steps.changes.subscribe(() => { if (!this.selected) { this._selectedIndex = Math.max(this._selectedIndex - 1, 0); } }); // The logic which asserts that the selected index is within bounds doesn't run before the // steps are initialized, because we don't how many steps there are yet so we may have an // invalid index on init. If that's the case, auto-correct to the default so we don't throw. if (!this._isValidIndex(this._selectedIndex)) { this._selectedIndex = 0; } } ngOnDestroy() { this.steps.destroy(); this._sortedHeaders.destroy(); this._destroyed.next(); this._destroyed.complete(); } /** Selects and focuses the next step in list. */ next() { this.selectedIndex = Math.min(this._selectedIndex + 1, this.steps.length - 1); } /** Selects and focuses the previous step in list. */ previous() { this.selectedIndex = Math.max(this._selectedIndex - 1, 0); } /** Resets the stepper to its initial state. Note that this includes clearing form data. */ reset() { this._updateSelectedItemIndex(0); this.steps.forEach(step => step.reset()); this._stateChanged(); } /** Returns a unique id for each step label element. */ _getStepLabelId(i) { return `cdk-step-label-${this._groupId}-${i}`; } /** Returns unique id for each step content element. */ _getStepContentId(i) { return `cdk-step-content-${this._groupId}-${i}`; } /** Marks the component to be change detected. */ _stateChanged() { this._changeDetectorRef.markForCheck(); } /** Returns position state of the step with the given index. */ _getAnimationDirection(index) { const position = index - this._selectedIndex; if (position < 0) { return this._layoutDirection() === 'rtl' ? 'next' : 'previous'; } else if (position > 0) { return this._layoutDirection() === 'rtl' ? 'previous' : 'next'; } return 'current'; } /** Returns the type of icon to be displayed. */ _getIndicatorType(index, state = STEP_STATE.NUMBER) { const step = this.steps.toArray()[index]; const isCurrentStep = this._isCurrentStep(index); return step._displayDefaultIndicatorType ? this._getDefaultIndicatorLogic(step, isCurrentStep) : this._getGuidelineLogic(step, isCurrentStep, state); } _getDefaultIndicatorLogic(step, isCurrentStep) { if (step._showError() && step.hasError && !isCurrentStep) { return STEP_STATE.ERROR; } else if (!step.completed || isCurrentStep) { return STEP_STATE.NUMBER; } else { return step.editable ? STEP_STATE.EDIT : STEP_STATE.DONE; } } _getGuidelineLogic(step, isCurrentStep, state = STEP_STATE.NUMBER) { if (step._showError() && step.hasError && !isCurrentStep) { return STEP_STATE.ERROR; } else if (step.completed && !isCurrentStep) { return STEP_STATE.DONE; } else if (step.completed && isCurrentStep) { return state; } else if (step.editable && isCurrentStep) { return STEP_STATE.EDIT; } else { return state; } } _isCurrentStep(index) { return this._selectedIndex === index; } /** Returns the index of the currently-focused step header. */ _getFocusIndex() { return this._keyManager ? this._keyManager.activeItemIndex : this._selectedIndex; } _updateSelectedItemIndex(newIndex) { const stepsArray = this.steps.toArray(); this.selectionChange.emit({ selectedIndex: newIndex, previouslySelectedIndex: this._selectedIndex, selectedStep: stepsArray[newIndex], previouslySelectedStep: stepsArray[this._selectedIndex], }); // If focus is inside the stepper, move it to the next header, otherwise it may become // lost when the active step content is hidden. We can't be more granular with the check // (e.g. checking whether focus is inside the active step), because we don't have a // reference to the elements that are rendering out the content. this._containsFocus() ? this._keyManager.setActiveItem(newIndex) : this._keyManager.updateActiveItem(newIndex); this._selectedIndex = newIndex; this._stateChanged(); } _onKeydown(event) { const hasModifier = hasModifierKey(event); const keyCode = event.keyCode; const manager = this._keyManager; if (manager.activeItemIndex != null && !hasModifier && (keyCode === SPACE || keyCode === ENTER)) { this.selectedIndex = manager.activeItemIndex; event.preventDefault(); } else { manager.onKeydown(event); } } _anyControlsInvalidOrPending(index) { if (this._linear && index >= 0) { return this.steps.toArray().slice(0, index).some(step => { const control = step.stepControl; const isIncomplete = control ? (control.invalid || control.pending || !step.interacted) : !step.completed; return isIncomplete && !step.optional && !step._completedOverride; }); } return false; } _layoutDirection() { return this._dir && this._dir.value === 'rtl' ? 'rtl' : 'ltr'; } /** Checks whether the stepper contains the focused element. */ _containsFocus() { const stepperElement = this._elementRef.nativeElement; const focusedElement = _getFocusedElementPierceShadowDom(); return stepperElement === focusedElement || stepperElement.contains(focusedElement); } /** Checks whether the passed-in index is a valid step index. */ _isValidIndex(index) { return index > -1 && (!this.steps || index < this.steps.length); } } CdkStepper.decorators = [ { type: Directive, args: [{ selector: '[cdkStepper]', exportAs: 'cdkStepper', },] } ]; CdkStepper.ctorParameters = () => [ { type: Directionality, decorators: [{ type: Optional }] }, { type: ChangeDetectorRef }, { type: ElementRef }, { type: undefined, decorators: [{ type: Inject, args: [DOCUMENT,] }] } ]; CdkStepper.propDecorators = { _steps: [{ type: ContentChildren, args: [CdkStep, { descendants: true },] }], _stepHeader: [{ type: ContentChildren, args: [CdkStepHeader, { descendants: true },] }], linear: [{ type: Input }], selectedIndex: [{ type: Input }], selected: [{ type: Input }], selectionChange: [{ type: Output }], orientation: [{ type: Input }] }; /** * @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 */ /** Button that moves to the next step in a stepper workflow. */ class CdkStepperNext { constructor(_stepper) { this._stepper = _stepper; /** Type of the next button. Defaults to "submit" if not specified. */ this.type = 'submit'; } // We have to use a `HostListener` here in order to support both Ivy and ViewEngine. // In Ivy the `host` bindings will be merged when this class is extended, whereas in // ViewEngine they're overwritten. // TODO(crisbeto): we move this back into `host` once Ivy is turned on by default. // tslint:disable-next-line:no-host-decorator-in-concrete _handleClick() { this._stepper.next(); } } CdkStepperNext.decorators = [ { type: Directive, args: [{ selector: 'button[cdkStepperNext]', host: { '[type]': 'type', } },] } ]; CdkStepperNext.ctorParameters = () => [ { type: CdkStepper } ]; CdkStepperNext.propDecorators = { type: [{ type: Input }], _handleClick: [{ type: HostListener, args: ['click',] }] }; /** Button that moves to the previous step in a stepper workflow. */ class CdkStepperPrevious { constructor(_stepper) { this._stepper = _stepper; /** Type of the previous button. Defaults to "button" if not specified. */ this.type = 'button'; } // We have to use a `HostListener` here in order to support both Ivy and ViewEngine. // In Ivy the `host` bindings will be merged when this class is extended, whereas in // ViewEngine they're overwritten. // TODO(crisbeto): we move this back into `host` once Ivy is turned on by default. // tslint:disable-next-line:no-host-decorator-in-concrete _handleClick() { this._stepper.previous(); } } CdkStepperPrevious.decorators = [ { type: Directive, args: [{ selector: 'button[cdkStepperPrevious]', host: { '[type]': 'type', } },] } ]; CdkStepperPrevious.ctorParameters = () => [ { type: CdkStepper } ]; CdkStepperPrevious.propDecorators = { type: [{ type: Input }], _handleClick: [{ type: HostListener, args: ['click',] }] }; /** * @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 */ class CdkStepperModule { } CdkStepperModule.decorators = [ { type: NgModule, args: [{ imports: [BidiModule], exports: [ CdkStep, CdkStepper, CdkStepHeader, CdkStepLabel, CdkStepperNext, CdkStepperPrevious, ], declarations: [ CdkStep, CdkStepper, CdkStepHeader, CdkStepLabel, CdkStepperNext, CdkStepperPrevious, ] },] } ]; /** * @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 */ /** * Generated bundle index. Do not edit. */ export { CdkStep, CdkStepHeader, CdkStepLabel, CdkStepper, CdkStepperModule, CdkStepperNext, CdkStepperPrevious, STEPPER_GLOBAL_OPTIONS, STEP_STATE, StepperSelectionEvent }; //# sourceMappingURL=stepper.js.map