Skip to content

fix(stepper): throw when out-of-bounds value is assigned to selectedIndex #9127

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 1 commit into from
Jan 26, 2018
Merged
Show file tree
Hide file tree
Changes from all 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
7 changes: 6 additions & 1 deletion src/cdk/stepper/stepper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,11 @@ export class CdkStepper implements OnDestroy {
get selectedIndex() { return this._selectedIndex; }
set selectedIndex(index: number) {
if (this._steps) {
// Ensure that the index can't be out of bounds.
if (index < 0 || index > this._steps.length - 1) {
throw Error('cdkStepper: Cannot assign out-of-bounds value to `selectedIndex`.');
}

if (this._anyControlsInvalidOrPending(index) || index < this._selectedIndex &&
!this._steps.toArray()[index].editable) {
// remove focus from clicked step header if the step is not able to be selected
Expand All @@ -167,7 +172,7 @@ export class CdkStepper implements OnDestroy {
this._selectedIndex = this._focusIndex = index;
}
}
private _selectedIndex: number = 0;
private _selectedIndex = 0;

/** The step that is selected. */
@Input()
Expand Down
20 changes: 20 additions & 0 deletions src/lib/stepper/stepper.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,26 @@ describe('MatHorizontalStepper', () => {
expect(stepperComponent.selectedIndex).toBe(0);
});

it('should throw when a negative `selectedIndex` is assigned', () => {
const stepperComponent: MatHorizontalStepper = fixture.debugElement
.query(By.css('mat-horizontal-stepper')).componentInstance;

expect(() => {
stepperComponent.selectedIndex = -10;
fixture.detectChanges();
}).toThrowError(/Cannot assign out-of-bounds/);
});

it('should throw when an out-of-bounds `selectedIndex` is assigned', () => {
const stepperComponent: MatHorizontalStepper = fixture.debugElement
.query(By.css('mat-horizontal-stepper')).componentInstance;

expect(() => {
stepperComponent.selectedIndex = 1337;
fixture.detectChanges();
}).toThrowError(/Cannot assign out-of-bounds/);
});

it('should change selected index on header click', () => {
let stepHeaders = fixture.debugElement.queryAll(By.css('.mat-horizontal-stepper-header'));
assertSelectionChangeOnHeaderClick(fixture, stepHeaders);
Expand Down