| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766 |
- /**
- * @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
- */
- import { Directive, ElementRef, TemplateRef, ChangeDetectionStrategy, ChangeDetectorRef, Component, ContentChild, ContentChildren, EventEmitter, forwardRef, Inject, InjectionToken, Input, Optional, Output, ViewChild, ViewEncapsulation, HostListener, NgModule } from '@angular/core';
- import { FocusKeyManager } from '@angular/cdk/a11y';
- import { Directionality, BidiModule } from '@angular/cdk/bidi';
- import { coerceBooleanProperty, coerceNumberProperty } from '@angular/cdk/coercion';
- import { END, ENTER, hasModifierKey, HOME, SPACE } from '@angular/cdk/keycodes';
- import { DOCUMENT, CommonModule } from '@angular/common';
- import { of, Subject } from 'rxjs';
- import { startWith, takeUntil } from 'rxjs/operators';
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- class CdkStepHeader {
- /**
- * @param {?} _elementRef
- */
- constructor(_elementRef) {
- this._elementRef = _elementRef;
- }
- /**
- * Focuses the step header.
- * @return {?}
- */
- focus() {
- this._elementRef.nativeElement.focus();
- }
- }
- CdkStepHeader.decorators = [
- { type: Directive, args: [{
- selector: '[cdkStepHeader]',
- host: {
- 'role': 'tab',
- },
- },] },
- ];
- /** @nocollapse */
- CdkStepHeader.ctorParameters = () => [
- { type: ElementRef }
- ];
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- class CdkStepLabel {
- /**
- * @param {?} template
- */
- constructor(/** @docs-private */ template) {
- this.template = template;
- }
- }
- CdkStepLabel.decorators = [
- { type: Directive, args: [{
- selector: '[cdkStepLabel]',
- },] },
- ];
- /** @nocollapse */
- CdkStepLabel.ctorParameters = () => [
- { type: TemplateRef }
- ];
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * Used to generate unique ID for each stepper component.
- * @type {?}
- */
- let nextId = 0;
- /**
- * Change event emitted on selection changes.
- */
- class StepperSelectionEvent {
- }
- /**
- * Enum to represent the different states of the steps.
- * @type {?}
- */
- const STEP_STATE = {
- NUMBER: 'number',
- EDIT: 'edit',
- DONE: 'done',
- ERROR: 'error'
- };
- /**
- * InjectionToken that can be used to specify the global stepper options.
- * @type {?}
- */
- const STEPPER_GLOBAL_OPTIONS = new InjectionToken('STEPPER_GLOBAL_OPTIONS');
- /**
- * InjectionToken that can be used to specify the global stepper options.
- * @deprecated Use `STEPPER_GLOBAL_OPTIONS` instead.
- * \@breaking-change 8.0.0.
- * @type {?}
- */
- const MAT_STEPPER_GLOBAL_OPTIONS = STEPPER_GLOBAL_OPTIONS;
- class CdkStep {
- /**
- * \@breaking-change 8.0.0 remove the `?` after `stepperOptions`
- * @param {?} _stepper
- * @param {?=} stepperOptions
- */
- constructor(_stepper, stepperOptions) {
- this._stepper = _stepper;
- /**
- * Whether user has seen the expanded step content or not.
- */
- this.interacted = false;
- this._editable = true;
- this._optional = false;
- this._completedOverride = null;
- this._customError = null;
- this._stepperOptions = stepperOptions ? stepperOptions : {};
- this._displayDefaultIndicatorType = this._stepperOptions.displayDefaultIndicatorType !== false;
- this._showError = !!this._stepperOptions.showError;
- }
- /**
- * Whether the user can return to this step once it has been marked as completed.
- * @return {?}
- */
- get editable() {
- return this._editable;
- }
- /**
- * @param {?} value
- * @return {?}
- */
- set editable(value) {
- this._editable = coerceBooleanProperty(value);
- }
- /**
- * Whether the completion of step is optional.
- * @return {?}
- */
- get optional() {
- return this._optional;
- }
- /**
- * @param {?} value
- * @return {?}
- */
- set optional(value) {
- this._optional = coerceBooleanProperty(value);
- }
- /**
- * Whether step is marked as completed.
- * @return {?}
- */
- get completed() {
- return this._completedOverride == null ? this._getDefaultCompleted() : this._completedOverride;
- }
- /**
- * @param {?} value
- * @return {?}
- */
- set completed(value) {
- this._completedOverride = coerceBooleanProperty(value);
- }
- /**
- * @private
- * @return {?}
- */
- _getDefaultCompleted() {
- return this.stepControl ? this.stepControl.valid && this.interacted : this.interacted;
- }
- /**
- * Whether step has an error.
- * @return {?}
- */
- get hasError() {
- return this._customError == null ? this._getDefaultError() : this._customError;
- }
- /**
- * @param {?} value
- * @return {?}
- */
- set hasError(value) {
- this._customError = coerceBooleanProperty(value);
- }
- /**
- * @private
- * @return {?}
- */
- _getDefaultError() {
- return this.stepControl && this.stepControl.invalid && this.interacted;
- }
- /**
- * Selects this step component.
- * @return {?}
- */
- select() {
- this._stepper.selected = this;
- }
- /**
- * Resets the step to its initial state. Note that this includes resetting form data.
- * @return {?}
- */
- reset() {
- this.interacted = false;
- if (this._completedOverride != null) {
- this._completedOverride = false;
- }
- if (this._customError != null) {
- this._customError = false;
- }
- if (this.stepControl) {
- this.stepControl.reset();
- }
- }
- /**
- * @return {?}
- */
- 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();
- }
- }
- CdkStep.decorators = [
- { type: Component, args: [{selector: 'cdk-step',
- exportAs: 'cdkStep',
- template: '<ng-template><ng-content></ng-content></ng-template>',
- encapsulation: ViewEncapsulation.None,
- changeDetection: ChangeDetectionStrategy.OnPush,
- },] },
- ];
- /** @nocollapse */
- CdkStep.ctorParameters = () => [
- { type: CdkStepper, decorators: [{ type: Inject, args: [forwardRef((/**
- * @return {?}
- */
- () => CdkStepper)),] }] },
- { type: undefined, decorators: [{ type: Optional }, { type: Inject, args: [STEPPER_GLOBAL_OPTIONS,] }] }
- ];
- CdkStep.propDecorators = {
- stepLabel: [{ type: ContentChild, args: [CdkStepLabel, { static: false },] }],
- content: [{ type: ViewChild, args: [TemplateRef, { static: true },] }],
- stepControl: [{ type: Input }],
- 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 {
- /**
- * @param {?} _dir
- * @param {?} _changeDetectorRef
- * @param {?=} _elementRef
- * @param {?=} _document
- */
- constructor(_dir, _changeDetectorRef, _elementRef, _document) {
- this._dir = _dir;
- this._changeDetectorRef = _changeDetectorRef;
- this._elementRef = _elementRef;
- /**
- * Emits when the component is destroyed.
- */
- this._destroyed = new Subject();
- this._linear = false;
- this._selectedIndex = 0;
- /**
- * Event emitted when the selected step has changed.
- */
- this.selectionChange = new EventEmitter();
- this._orientation = 'horizontal';
- this._groupId = nextId++;
- this._document = _document;
- }
- /**
- * The list of step components that the stepper is holding.
- * @return {?}
- */
- get steps() {
- return this._steps;
- }
- /**
- * Whether the validity of previous steps should be checked or not.
- * @return {?}
- */
- get linear() {
- return this._linear;
- }
- /**
- * @param {?} value
- * @return {?}
- */
- set linear(value) {
- this._linear = coerceBooleanProperty(value);
- }
- /**
- * The index of the selected step.
- * @return {?}
- */
- get selectedIndex() {
- return this._selectedIndex;
- }
- /**
- * @param {?} index
- * @return {?}
- */
- set selectedIndex(index) {
- /** @type {?} */
- const newIndex = coerceNumberProperty(index);
- if (this.steps) {
- // Ensure that the index can't be out of bounds.
- if (newIndex < 0 || newIndex > this.steps.length - 1) {
- throw Error('cdkStepper: Cannot assign out-of-bounds value to `selectedIndex`.');
- }
- 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.
- * @return {?}
- */
- get selected() {
- // @breaking-change 8.0.0 Change return type to `CdkStep | undefined`.
- return this.steps ? this.steps.toArray()[this.selectedIndex] : (/** @type {?} */ (undefined));
- }
- /**
- * @param {?} step
- * @return {?}
- */
- set selected(step) {
- this.selectedIndex = this.steps ? this.steps.toArray().indexOf(step) : -1;
- }
- /**
- * @return {?}
- */
- ngAfterViewInit() {
- // Note that while the step headers are content children by default, any components that
- // extend this one might have them as view chidren. 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._stepHeader)
- .withWrap()
- .withVerticalOrientation(this._orientation === 'vertical');
- (this._dir ? ((/** @type {?} */ (this._dir.change))) : of())
- .pipe(startWith(this._layoutDirection()), takeUntil(this._destroyed))
- .subscribe((/**
- * @param {?} direction
- * @return {?}
- */
- direction => this._keyManager.withHorizontalOrientation(direction)));
- this._keyManager.updateActiveItemIndex(this._selectedIndex);
- this.steps.changes.pipe(takeUntil(this._destroyed)).subscribe((/**
- * @return {?}
- */
- () => {
- if (!this.selected) {
- this._selectedIndex = Math.max(this._selectedIndex - 1, 0);
- }
- }));
- }
- /**
- * @return {?}
- */
- ngOnDestroy() {
- this._destroyed.next();
- this._destroyed.complete();
- }
- /**
- * Selects and focuses the next step in list.
- * @return {?}
- */
- next() {
- this.selectedIndex = Math.min(this._selectedIndex + 1, this.steps.length - 1);
- }
- /**
- * Selects and focuses the previous step in list.
- * @return {?}
- */
- previous() {
- this.selectedIndex = Math.max(this._selectedIndex - 1, 0);
- }
- /**
- * Resets the stepper to its initial state. Note that this includes clearing form data.
- * @return {?}
- */
- reset() {
- this._updateSelectedItemIndex(0);
- this.steps.forEach((/**
- * @param {?} step
- * @return {?}
- */
- step => step.reset()));
- this._stateChanged();
- }
- /**
- * Returns a unique id for each step label element.
- * @param {?} i
- * @return {?}
- */
- _getStepLabelId(i) {
- return `cdk-step-label-${this._groupId}-${i}`;
- }
- /**
- * Returns unique id for each step content element.
- * @param {?} i
- * @return {?}
- */
- _getStepContentId(i) {
- return `cdk-step-content-${this._groupId}-${i}`;
- }
- /**
- * Marks the component to be change detected.
- * @return {?}
- */
- _stateChanged() {
- this._changeDetectorRef.markForCheck();
- }
- /**
- * Returns position state of the step with the given index.
- * @param {?} index
- * @return {?}
- */
- _getAnimationDirection(index) {
- /** @type {?} */
- 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.
- * @param {?} index
- * @param {?=} state
- * @return {?}
- */
- _getIndicatorType(index, state = STEP_STATE.NUMBER) {
- /** @type {?} */
- const step = this.steps.toArray()[index];
- /** @type {?} */
- const isCurrentStep = this._isCurrentStep(index);
- return step._displayDefaultIndicatorType ? this._getDefaultIndicatorLogic(step, isCurrentStep) :
- this._getGuidelineLogic(step, isCurrentStep, state);
- }
- /**
- * @private
- * @param {?} step
- * @param {?} isCurrentStep
- * @return {?}
- */
- _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;
- }
- }
- /**
- * @private
- * @param {?} step
- * @param {?} isCurrentStep
- * @param {?=} state
- * @return {?}
- */
- _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;
- }
- }
- /**
- * @private
- * @param {?} index
- * @return {?}
- */
- _isCurrentStep(index) {
- return this._selectedIndex === index;
- }
- /**
- * Returns the index of the currently-focused step header.
- * @return {?}
- */
- _getFocusIndex() {
- return this._keyManager ? this._keyManager.activeItemIndex : this._selectedIndex;
- }
- /**
- * @private
- * @param {?} newIndex
- * @return {?}
- */
- _updateSelectedItemIndex(newIndex) {
- /** @type {?} */
- 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.updateActiveItemIndex(newIndex);
- this._selectedIndex = newIndex;
- this._stateChanged();
- }
- /**
- * @param {?} event
- * @return {?}
- */
- _onKeydown(event) {
- /** @type {?} */
- const hasModifier = hasModifierKey(event);
- /** @type {?} */
- const keyCode = event.keyCode;
- /** @type {?} */
- const manager = this._keyManager;
- if (manager.activeItemIndex != null && !hasModifier &&
- (keyCode === SPACE || keyCode === ENTER)) {
- this.selectedIndex = manager.activeItemIndex;
- event.preventDefault();
- }
- else if (keyCode === HOME) {
- manager.setFirstItemActive();
- event.preventDefault();
- }
- else if (keyCode === END) {
- manager.setLastItemActive();
- event.preventDefault();
- }
- else {
- manager.onKeydown(event);
- }
- }
- /**
- * @private
- * @param {?} index
- * @return {?}
- */
- _anyControlsInvalidOrPending(index) {
- /** @type {?} */
- const steps = this.steps.toArray();
- steps[this._selectedIndex].interacted = true;
- if (this._linear && index >= 0) {
- return steps.slice(0, index).some((/**
- * @param {?} step
- * @return {?}
- */
- step => {
- /** @type {?} */
- const control = step.stepControl;
- /** @type {?} */
- const isIncomplete = control ? (control.invalid || control.pending || !step.interacted) : !step.completed;
- return isIncomplete && !step.optional && !step._completedOverride;
- }));
- }
- return false;
- }
- /**
- * @private
- * @return {?}
- */
- _layoutDirection() {
- return this._dir && this._dir.value === 'rtl' ? 'rtl' : 'ltr';
- }
- /**
- * Checks whether the stepper contains the focused element.
- * @private
- * @return {?}
- */
- _containsFocus() {
- if (!this._document || !this._elementRef) {
- return false;
- }
- /** @type {?} */
- const stepperElement = this._elementRef.nativeElement;
- /** @type {?} */
- const focusedElement = this._document.activeElement;
- return stepperElement === focusedElement || stepperElement.contains(focusedElement);
- }
- }
- CdkStepper.decorators = [
- { type: Directive, args: [{
- selector: '[cdkStepper]',
- exportAs: 'cdkStepper',
- },] },
- ];
- /** @nocollapse */
- 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,] }],
- _stepHeader: [{ type: ContentChildren, args: [CdkStepHeader,] }],
- linear: [{ type: Input }],
- selectedIndex: [{ type: Input }],
- selected: [{ type: Input }],
- selectionChange: [{ type: Output }]
- };
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * Button that moves to the next step in a stepper workflow.
- */
- class CdkStepperNext {
- /**
- * @param {?} _stepper
- */
- 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
- /**
- * @return {?}
- */
- _handleClick() {
- this._stepper.next();
- }
- }
- CdkStepperNext.decorators = [
- { type: Directive, args: [{
- selector: 'button[cdkStepperNext]',
- host: {
- '[type]': 'type',
- }
- },] },
- ];
- /** @nocollapse */
- 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 {
- /**
- * @param {?} _stepper
- */
- 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
- /**
- * @return {?}
- */
- _handleClick() {
- this._stepper.previous();
- }
- }
- CdkStepperPrevious.decorators = [
- { type: Directive, args: [{
- selector: 'button[cdkStepperPrevious]',
- host: {
- '[type]': 'type',
- }
- },] },
- ];
- /** @nocollapse */
- CdkStepperPrevious.ctorParameters = () => [
- { type: CdkStepper }
- ];
- CdkStepperPrevious.propDecorators = {
- type: [{ type: Input }],
- _handleClick: [{ type: HostListener, args: ['click',] }]
- };
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- class CdkStepperModule {
- }
- CdkStepperModule.decorators = [
- { type: NgModule, args: [{
- imports: [BidiModule, CommonModule],
- exports: [
- CdkStep,
- CdkStepper,
- CdkStepHeader,
- CdkStepLabel,
- CdkStepperNext,
- CdkStepperPrevious,
- ],
- declarations: [
- CdkStep,
- CdkStepper,
- CdkStepHeader,
- CdkStepLabel,
- CdkStepperNext,
- CdkStepperPrevious,
- ]
- },] },
- ];
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- export { StepperSelectionEvent, STEP_STATE, STEPPER_GLOBAL_OPTIONS, MAT_STEPPER_GLOBAL_OPTIONS, CdkStep, CdkStepper, CdkStepLabel, CdkStepperNext, CdkStepperPrevious, CdkStepperModule, CdkStepHeader };
- //# sourceMappingURL=stepper.js.map
|