Skip to content

feat(stepper): Add support for linear stepper #6116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 8, 2017
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions src/cdk/stepper/stepper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
} from '@angular/core';
import {LEFT_ARROW, RIGHT_ARROW, ENTER, SPACE} from '@angular/cdk/keyboard';
import {CdkStepLabel} from './step-label';
import {coerceBooleanProperty} from '@angular/cdk/coercion';

/** Used to generate unique ID for each stepper component. */
let nextId = 0;
Expand All @@ -45,7 +46,7 @@ export class CdkStepperSelectionEvent {

@Component({
selector: 'cdk-step',
templateUrl: 'step.html',
templateUrl: 'step.html'
})
export class CdkStep {
/** Template for step label if it exists. */
Expand All @@ -54,6 +55,18 @@ export class CdkStep {
/** Template for step content. */
@ViewChild(TemplateRef) content: TemplateRef<any>;

// TODO(jwshin): use disabled mixin when moved to cdk.
/** Whether step is disabled or not. */
@Input()
get disabled() { return this._disabled; }
set disabled(value: any) {
this._disabled = coerceBooleanProperty(value);
}
private _disabled = false;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a TODO to use the disabled mixin when it's moved to the cdk?


/** Whether user has seen the expanded step content or not . */
interacted = false;

/** Label of the step. */
@Input()
label: string;
Expand Down Expand Up @@ -84,7 +97,8 @@ export class CdkStepper {
@Input()
get selectedIndex() { return this._selectedIndex; }
set selectedIndex(index: number) {
if (this._selectedIndex != index) {
this._steps.toArray()[this._selectedIndex].interacted = true;
if (this._selectedIndex != index && !this._steps.toArray()[index].disabled) {
this._emitStepperSelectionEvent(index);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we only want to emit a change event if the selected index changes due to user interaction, therefore this should be moved to one of the user event handlers

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought this is commonly called by all user interactions and that's why we decided to delegate emitting a change event here. Is this not what you meant?

this._focusStep(this._selectedIndex);
}
Expand Down Expand Up @@ -153,7 +167,7 @@ export class CdkStepper {
break;
case SPACE:
case ENTER:
this._emitStepperSelectionEvent(this._focusIndex);
this.selectedIndex = this._focusIndex;
break;
default:
// Return to avoid calling preventDefault on keys that are not explicitly handled.
Expand Down
3 changes: 2 additions & 1 deletion src/cdk/stepper/tsconfig-build.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"outDir": "../../../dist/packages/cdk",
"baseUrl": ".",
"paths": {
"@angular/cdk/keyboard": ["../../../dist/packages/cdk/keyboard/public_api"]
"@angular/cdk/keyboard": ["../../../dist/packages/cdk/keyboard/public_api"],
"@angular/cdk/coercion": ["../../../dist/packages/cdk/coercion/public_api"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should be able to delete the entire paths property in this tsconfig now

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

possibly... depends where her stepper branch is synced to

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jelbourn @mmalerba The stepper branch is not synced up-to-date with the master branch yet. I was going to finish merging the two form control PRs that are already out, then do the syncing all together.

}
},
"files": [
Expand Down
47 changes: 47 additions & 0 deletions src/demo-app/stepper/stepper-demo.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,50 @@
<h2>Linear Vertical Stepper Demo</h2>
<form [formGroup]="formGroup">
<md-vertical-stepper formArrayName="formArray">
<md-step formGroupName="0">
<ng-template mdStepLabel>Fill out your name</ng-template>
<md-input-container>
<input mdInput placeholder="First Name" formControlName="firstNameFormCtrl" required>
<md-error>This field is required</md-error>
</md-input-container>

<md-input-container>
<input mdInput placeholder="Last Name" formControlName="lastNameFormCtrl" required>
<md-error>This field is required</md-error>
</md-input-container>
<div>
<button md-button mdStepperNext type="button">Next</button>
</div>
</md-step>

<md-step formGroupName="1"
[disabled]="formArray.hasError('invalid step') ?
formArray.getError('invalid step').index <= 1 : false">
<ng-template mdStepLabel>
<div>Fill out your phone number</div>
</ng-template>
<md-input-container>
<input mdInput placeholder="Phone number" formControlName="phoneFormCtrl">
<md-error>This field is required</md-error>
</md-input-container>
<div>
<button md-button mdStepperPrevious type="button">Back</button>
<button md-button mdStepperNext type="button">Next</button>
</div>
</md-step>

<md-step
[disabled]="formArray.hasError('invalid step') ?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't really seem to have made the disabled logic much easier... is that what you had in mind @kara or is there a better way to organize the custom validator?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mmalerba wouldn't it be better to not direct;y use the previous step form validity on the disabled input and instead use a @Input() valid which you would pass the current step validity and internally check the validation so you would have <md-step [valid]="formGroup.controls.formArray.controls[0].valid">.

It's going to be more complex than just checking if the previous is valid because it's going to need to validate against disabled, editable, optional and completed.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joejordanbrown The changed code no longer only checks for the previous step's validity. Now it uses the custom step validation function stepValidator to check for the validity of all the previous steps. If there's a step that is invalid, it will return the smallest index of the step that is invalid to compare with the index of the step that is being triggered.

@mmalerba : Waiting for @kara 's response on additional suggestions regarding this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@g1shin I see that, but I think it's too complex for the end user to have to add that to each step. It's going to get confusing for people when you use that with *ngFor and people will make mistakes. Especially when it's going to have a lot more options added in future for [editable] and [optionial].

You should be using less than operator < instead of less than or equal operator <= for your disabled logic. The second step should be [disabled]="formArray.hasError('invalid step') ? formArray.getError('invalid step').index < 1 : false" you are also missing the required validation on your second step to be able to test this.

 phoneFormCtrl: ['', Validators.required],

Do you have the design document for the stepper? I don't see it on the wiki.

formArray.getError('invalid step').index <= 2 : false">
<ng-template mdStepLabel>Confirm your information</ng-template>
Everything seems correct.
<div>
<button md-button>Done</button>
</div>
</md-step>
</md-vertical-stepper>
</form>

<h2>Horizontal Stepper Demo</h2>
<md-horizontal-stepper>
<md-step *ngFor="let step of steps" [label]="step.label">
Expand Down
23 changes: 23 additions & 0 deletions src/demo-app/stepper/stepper-demo.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import {Component} from '@angular/core';
import {Validators, FormBuilder, FormGroup} from '@angular/forms';
import {stepValidator} from '@angular/material';

@Component({
moduleId: module.id,
Expand All @@ -7,10 +9,31 @@ import {Component} from '@angular/core';
styleUrls: ['stepper-demo.scss'],
})
export class StepperDemo {
formGroup: FormGroup;

steps = [
{label: 'Confirm your name', content: 'Last name, First name.'},
{label: 'Confirm your contact information', content: '123-456-7890'},
{label: 'Confirm your address', content: '1600 Amphitheater Pkwy MTV'},
{label: 'You are now done', content: 'Finished!'}
];

/** Returns a FormArray with the name 'formArray'. */
get formArray() { return this.formGroup.get('formArray'); }

constructor(private _formBuilder: FormBuilder) { }

ngOnInit() {
this.formGroup = this._formBuilder.group({
formArray: this._formBuilder.array([
this._formBuilder.group({
firstNameFormCtrl: ['', Validators.required],
lastNameFormCtrl: ['', Validators.required],
}),
this._formBuilder.group({
phoneFormCtrl: [''],
})
], stepValidator)
});
}
}
59 changes: 56 additions & 3 deletions src/lib/stepper/stepper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,79 @@ import {
// considers such imports as unused (https://github.com/Microsoft/TypeScript/issues/14953)
// tslint:disable-next-line:no-unused-variable
ElementRef,
Inject,
Optional,
QueryList,
SkipSelf,
ViewChildren
}from '@angular/core';
import {MdStepLabel} from './step-label';
import {
defaultErrorStateMatcher,
ErrorOptions,
MD_ERROR_GLOBAL_OPTIONS,
ErrorStateMatcher
} from '../core/error/error-options';
import {
FormArray, FormControl, FormGroupDirective, NgForm, ValidationErrors,
ValidatorFn
} from '@angular/forms';

/**
* Form array validator to check if all form groups in form array are valid.
* If not, it will return the index of the first invalid form group.
*/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this comment left over from a previous implementation? Doesn't seem to go with MdStep.

export const stepValidator: ValidatorFn = (formArray: FormArray): ValidationErrors | null => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should probably be called stepperValidator since it's attached to the FormArray representing the whole stepper, not the FormGroups representing the steps.

for (let i = 0; i < formArray.length; i++) {
if (formArray.at(i).invalid) {
return {'invalid step': {'index': i}};
}
}
return null;
};

/**
* Form array validator to check if all form groups in form array are valid.
* If not, it will return the index of the first invalid form group.
*/

@Component({
moduleId: module.id,
selector: 'md-step, mat-step',
templateUrl: 'step.html',
providers: [{provide: MD_ERROR_GLOBAL_OPTIONS, useExisting: MdStep}]
})
export class MdStep extends CdkStep {
export class MdStep extends CdkStep implements ErrorOptions {
/** Content for step label given by <ng-template matStepLabel> or <ng-template mdStepLabel>. */
@ContentChild(MdStepLabel) stepLabel: MdStepLabel;

constructor(mdStepper: MdStepper) {
/** Original ErrorStateMatcher that checks the validity of form control. */
private _originalErrorStateMatcher: ErrorStateMatcher;

constructor(mdStepper: MdStepper,
@Optional() @SkipSelf() @Inject(MD_ERROR_GLOBAL_OPTIONS) errorOptions: ErrorOptions) {
super(mdStepper);
this._originalErrorStateMatcher =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, #6147 should make this easier

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw the PR, but should this change be made after that PR is merged into master and 'stepper' branch has synced to upstream master?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, just an fyi

errorOptions ? errorOptions.errorStateMatcher || defaultErrorStateMatcher
: defaultErrorStateMatcher;
}

/** Custom error state matcher that additionally checks for validity of interacted form. */
errorStateMatcher = (control: FormControl, form: FormGroupDirective | NgForm) => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The class should implement ErrorOptions

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it work if this is a prototype method rather than a property?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No because the ErrorOptions stuff is implemented kind of strangely and the context would be lost if we did it as a prototype method. I would like to refactor it, probably not as part of this PR though

let originalErrorState = this._originalErrorStateMatcher(control, form);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a comment that explains the background for why we are doing this custom error matcher stuff? (i.e., everything we talked about in the meeting)


/**
* Custom error state checks for the validity of form that is not submitted or touched
* since user can trigger a form change by calling for another step without directly
* interacting with the current form.
*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use inline-style (//) comments for local variables

let customErrorState = control.invalid && this.interacted;

return originalErrorState || customErrorState;
}
}

export class MdStepper extends CdkStepper {
export class MdStepper extends CdkStepper implements ErrorOptions {
/** The list of step headers of the steps in the stepper. */
@ViewChildren('stepHeader') _stepHeader: QueryList<ElementRef>;

Expand Down
8 changes: 7 additions & 1 deletion src/lib/table/cell.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@
*/

import {Directive, ElementRef, Input, Renderer2} from '@angular/core';
import {CdkCell, CdkCellDef, CdkColumnDef, CdkHeaderCell, CdkHeaderCellDef} from '@angular/cdk/table';
import {
CdkCell,
CdkCellDef,
CdkColumnDef,
CdkHeaderCell,
CdkHeaderCellDef
} from '@angular/cdk/table';

/** Workaround for https://github.com/angular/angular/issues/17849 */
export const _MdCellDef = CdkCellDef;
Expand Down
8 changes: 7 additions & 1 deletion src/lib/table/row.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@
*/

import {ChangeDetectionStrategy, Component, Directive} from '@angular/core';
import {CdkHeaderRow, CdkRow, CDK_ROW_TEMPLATE, CdkRowDef, CdkHeaderRowDef} from '@angular/cdk/table';
import {
CdkHeaderRow,
CdkRow,
CDK_ROW_TEMPLATE,
CdkRowDef,
CdkHeaderRowDef
} from '@angular/cdk/table';

/** Workaround for https://github.com/angular/angular/issues/17849 */
export const _MdHeaderRowDef = CdkHeaderRowDef;
Expand Down