ionic-team / ionic-team/ionic-framework

bug: scrollToPoint resolves, but `ionScroll` events are fired after

Open
#23,509 0 comments 0 reactions 0 assignees View on GitHub
package: core type: bug
Dominant language
TypeScript
Stars
52.7k
Forks
13.3k
Avg merge
1d 15h
Merged PRs (30d)
51

Description

# Bug Report

**Ionic version:**
[x] **5.x**

**Current behavior:**
When ion-content is scrolled using `scrollToPoint`, etc., even after finished waiting `scrollToPoint `(using await), the `ionScroll `event will be fired afterwards.

This is probably because the `ionScroll `event is issued by stencil's `readTask()`.
https://github.com/ionic-team/ionic-framework/blob/d5980354fa1672839fa7e89e8fc91cfa524e3f03/core/src/components/content/content.tsx#L169

**Expected behavior:**
If you await `scrollToPoint`, then the `ionScroll `event will not be fired after the await is completed.

I think this was done to avoid heavy processing by the `ionScroll `event, but I think the unintuitive timing/order of the event is a source of confusion.
Could you please consider the option of not firing the ionScroll event in the `readTask()`?

**Steps to reproduce:**
1. Open https://codepen.io/ugaya40/pen/abJeVBJ (from https://codepen.io/ionic/pen/wvwpbwV).
2. Push "AutoScroll !" Button.
3. View console.
![console](https://user-images.githubusercontent.com/1430166/123370425-aa233700-d5ba-11eb-8038-8153a8d93abf.png)
4. You can see that the scroll event handler is also executed after the display 'scrollFinished !!!'.

(If you have difficulty reproducing this phenomenon, you can use Chrome's CPU SlowDown feature to make it easier to reproduce.)

**Related code:**

I noticed this problem when I was trying to split the process depending on whether it was an auto-scroll or a manual-scroll.
As shown in the following code, it was inconvenient because it was distinguished as manual scrolling even though it was actually automatic scrolling.
https://codepen.io/ugaya40/pen/LYWwOvB

**Other information:**
Currently the only workaround currently seems to be to handle the scroll event of the element retrieved with `getScrollElement()`.

Contributor guide

Open the contributing guide

Research direction

Start with core/src/components/content/content.tsx at the linked readTask() location and reproduce the ordering with the provided CodePen example. Trace how scrollToPoint resolves relative to ionScroll dispatch, then verify that awaiting the scroll operation is followed by no later ionScroll event.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.