Skip to content

Commit 38db85b

Browse files
committed
fix(stepper): throw when out-of-bounds value is assigned to selectedIndex
Throws better error when an out-of-bounds value is assigned to the `selectedIndex`.
1 parent c3d7cd9 commit 38db85b

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

src/cdk/stepper/stepper.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,11 @@ export class CdkStepper implements OnDestroy {
152152
get selectedIndex() { return this._selectedIndex; }
153153
set selectedIndex(index: number) {
154154
if (this._steps) {
155+
// Ensure that the index can't be out of bounds.
156+
if (index < 0 || index > this._steps.length - 1) {
157+
throw Error('cdkStepper: Cannot assign out-of-bounds value to `selectedIndex`.');
158+
}
159+
155160
if (this._anyControlsInvalidOrPending(index) || index < this._selectedIndex &&
156161
!this._steps.toArray()[index].editable) {
157162
// remove focus from clicked step header if the step is not able to be selected
@@ -164,7 +169,7 @@ export class CdkStepper implements OnDestroy {
164169
this._selectedIndex = this._focusIndex = index;
165170
}
166171
}
167-
private _selectedIndex: number = 0;
172+
private _selectedIndex = 0;
168173

169174
/** The step that is selected. */
170175
@Input()

src/lib/stepper/stepper.spec.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,26 @@ describe('MatHorizontalStepper', () => {
5151
expect(stepperComponent.selectedIndex).toBe(0);
5252
});
5353

54+
it('should throw when a negative `selectedIndex` is assigned', () => {
55+
const stepperComponent: MatHorizontalStepper = fixture.debugElement
56+
.query(By.css('mat-horizontal-stepper')).componentInstance;
57+
58+
expect(() => {
59+
stepperComponent.selectedIndex = -10;
60+
fixture.detectChanges();
61+
}).toThrowError(/Cannot assign out-of-bounds/);
62+
});
63+
64+
it('should throw when an out-of-bounds `selectedIndex` is assigned', () => {
65+
const stepperComponent: MatHorizontalStepper = fixture.debugElement
66+
.query(By.css('mat-horizontal-stepper')).componentInstance;
67+
68+
expect(() => {
69+
stepperComponent.selectedIndex = 1337;
70+
fixture.detectChanges();
71+
}).toThrowError(/Cannot assign out-of-bounds/);
72+
});
73+
5474
it('should change selected index on header click', () => {
5575
let stepHeaders = fixture.debugElement.queryAll(By.css('.mat-horizontal-stepper-header'));
5676
assertSelectionChangeOnHeaderClick(fixture, stepHeaders);

0 commit comments

Comments
 (0)