angular / angular/components

Stepper (selectionChange) vs (selectionChanged) and [selectedIndex]

Open
#9,733 30 comments 29 reactions 0 assignees View on GitHub
area: cdk/stepper needs: discussion P3
Dominant language
TypeScript
Stars
25k
Forks
6.8k
Avg merge
1d 8h
Merged PRs (30d)
91

Description

#### Bug, feature request, or proposal:
```


Next


Previous (cancelled)


```
In the stepper control the (selectionChange) event cannot be used together with [selectedIndex], because changing the [selectedIndex] also triggers (selectionChange), so there is no way of cancelling the selection programatically, or implement other logic 'before' the change is executed.

Expected it to work as a standard html select control where:
- when changing the .selectedIndex the (change) event doesn't get automatically triggered
- the (change) event is triggered 'before' the change is finished, so it can be cancelled with event.preventDefault()

#### What is the expected behaviour?
- The current event should be renamed (selectionChange**d**) = 'after' the step has changed.
- Emit a new event (selectionChange) = 'before' the step has changed, with option to cancel the action, which doesn't get automatically triggered when selectedIndex changes.

#### What is the current behavior?
selectionChange = 'after' the step has changed, naming is confusing, gets triggered automatically with [selectedIndex]

#### What are the steps to reproduce?
![screen shot 2018-02-01 at 12 54 07](https://user-images.githubusercontent.com/30979663/35677213-0fd83322-074f-11e8-9029-7c629ecc6c38.png)

1. Select step 2
2. Press Previous button (the action is cancelled programatically) - ok
3. Press step 1 header (step 1 is still selected, the action cannot be cancelled, selectedIndex remains on step 2)

StackBlitz: https://stackblitz.com/edit/angular-material2-issue-9lskal

#### What is the use-case or motivation for changing an existing behavior?
Be able to programatically enable/disable certain steps

#### Which versions of Angular, Material, OS, TypeScript, browsers are affected?
Material 5.1.0

#### Is there anything else we should know?

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the behavior in the linked StackBlitz, focusing on mat-horizontal-stepper, selectedIndex, and selectionChange. Trace how user navigation differs from programmatic selectedIndex changes; done means the event semantics are distinct, the pre-change action can be cancelled, and the post-change notification remains available.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.