feat: user event scroll #1445

siepra · 2023-08-08T14:59:25Z

Summary

API for user event scrolling

Solves #1441, solves #1450

codecov · 2023-08-08T15:01:29Z

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.17% 🎉

Comparison is base (1592d35) 97.91% compared to head (4508d9d) 98.08%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1445      +/-   ##
==========================================
+ Coverage   97.91%   98.08%   +0.17%     
==========================================
  Files          85       93       +8     
  Lines        5120     5590     +470     
  Branches      792      864      +72     
==========================================
+ Hits         5013     5483     +470     
  Misses        107      107

Files Changed	Coverage Δ
src/config.ts	`100.00% <100.00%> (ø)`
src/helpers/accessiblity.ts	`100.00% <100.00%> (ø)`
src/helpers/host-component-names.tsx	`100.00% <100.00%> (ø)`
src/helpers/object.ts	`100.00% <100.00%> (ø)`
src/matchers/extend-expect.ts	`100.00% <100.00%> (ø)`
src/matchers/to-be-busy.tsx	`100.00% <100.00%> (ø)`
src/matchers/to-be-selected.ts	`100.00% <100.00%> (ø)`
src/matchers/to-have-style.tsx	`100.00% <100.00%> (ø)`
src/test-utils/events.ts	`100.00% <100.00%> (ø)`
src/user-event/event-builder/index.ts	`100.00% <100.00%> (ø)`
... and 7 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/user-event/scroll/__tests__/scroll.test.tsx

siepra · 2023-08-10T16:21:00Z

~~NOTE: Right now the tests are failing due to <ScrollView />'s scroll state being shared between all the test cases~~

mdjastrzebski · 2023-08-14T07:56:44Z

Rebased on main

mdjastrzebski · 2023-08-17T14:57:59Z

Working on adapting the code and test to the API proposal #1450

mdjastrzebski · 2023-08-19T14:17:39Z

Ready for review. I've:

transformed API to match the API Proposal: User Event scroll function #1450
descoped scrollToTop
added missing tests

Pls help review this after my changes: @siepra, @pierrezimmermannbam, @MattAgn, @AugustinLF

src/user-event/scroll/__tests__/scrollTo.test.tsx

pierrezimmermannbam · 2023-08-21T12:26:31Z

Sorry I just got back from my vacations, I just responded to the api proposal, I think it will be faster to discuss there and align on API before finishing reviewing this pr

mdjastrzebski · 2023-08-22T09:25:33Z

Rebased on FlatList fix #1467

mdjastrzebski · 2023-09-03T19:01:45Z

I've added initial docs for the scrollTo event.
I've also decided to descope scrollToTop variant from this PR, as we should focus on creating solid base API first and then we can add more rarely-used variants.

siepra

LGTM. I cannot approve as I'm one of the authors. I wish I was more involved in polishing the final API next time!

pierrezimmermannbam · 2023-09-06T07:48:25Z

website/docs/UserEvent.md

+
+Scroll interaction should match host `ScrollView` direction. For vertical scroll view (`horizontal={false}`) you should pass only `y` (or `momentumY`) options, for horizontal scroll view (`horizontal={true}`) you should pass only `x` (or `momentumX`) options.
+
+Each scroll interaction consists of mandatory drag scroll part which simulates user dragging the scroll view with his finger (`y` or `x` option). This may optinally be followed by momentum scroll movement which simulates the inertial movement of scroll view content after user lifts his finger up (`momentumY` or `momentumX` options).


Maybe it could be worth mentioning that we don't have access to content size and so props that rely on it like onViewableItemsChanged or onEndReached will never be called?

That being said the sequence of events is detailed at the end so it may not be necessary

@pierrezimmermannbam good idea to mention content size thing as the current state of things. In the future we could actually work on improving the FlatList features, e.g. by allowing user to pass mock content size props or do some reasonable defaults, etc. I think it might be a topic worth exploring.

mdjastrzebski

After long review and discussion this PR is finally ready! ✅ That was a long one. Thank you to @siepra for initial version of the PR 🥇, thanks to @pierrezimmermannbam and @MattAgn and others ❤️ for participating in discussion on API shape and implementation. It's time to finally merge it 🌊🏄‍♂️

mdjastrzebski · 2023-10-24T16:19:03Z

This PR has been released v12.3.1 🚀

mdjastrzebski reviewed Aug 8, 2023

View reviewed changes

src/user-event/scroll/__tests__/scroll.test.tsx Outdated Show resolved Hide resolved

mdjastrzebski reviewed Aug 8, 2023

View reviewed changes

src/user-event/scroll/__tests__/scroll.test.tsx Outdated Show resolved Hide resolved

mdjastrzebski reviewed Aug 8, 2023

View reviewed changes

src/user-event/scroll/__tests__/scroll.test.tsx Outdated Show resolved Hide resolved

siepra changed the title ~~feat: setup dummy scroll endpoint~~ feat: user event scroll Aug 8, 2023

siepra mentioned this pull request Aug 10, 2023

feature: UserEvent scroll() #1441

Closed

siepra marked this pull request as ready for review August 10, 2023 20:45

mdjastrzebski force-pushed the feat/scroll branch from 3bc1ae6 to 9b0100d Compare August 14, 2023 07:56

mdjastrzebski mentioned this pull request Aug 14, 2023

API Proposal: User Event scroll function #1450

Closed

mdjastrzebski changed the title ~~feat: user event scroll~~ feat: user event scroll [WIP] Aug 17, 2023

mdjastrzebski marked this pull request as draft August 17, 2023 14:58

mdjastrzebski force-pushed the feat/scroll branch from ec12982 to 3ad5ec4 Compare August 19, 2023 14:15

mdjastrzebski changed the title ~~feat: user event scroll [WIP]~~ feat: user event scroll Aug 19, 2023

mdjastrzebski requested review from AugustinLF, MattAgn and pierrezimmermannbam August 19, 2023 14:15

mdjastrzebski marked this pull request as ready for review August 19, 2023 14:17

pierrezimmermannbam reviewed Aug 21, 2023

View reviewed changes

src/user-event/scroll/__tests__/scrollTo.test.tsx Outdated Show resolved Hide resolved

mdjastrzebski force-pushed the feat/scroll branch from 3ad5ec4 to 0d18303 Compare August 22, 2023 09:25

mdjastrzebski force-pushed the feat/scroll branch 2 times, most recently from dc1fddd to 6a24183 Compare September 3, 2023 18:40

siepra commented Sep 5, 2023

View reviewed changes

pierrezimmermannbam reviewed Sep 6, 2023

View reviewed changes

mdjastrzebski added 17 commits September 12, 2023 12:08

chore: fix typecheck

9379408

refactor: improve typing

5d43697

refactor: momentumY, momentumX options

0f772e5

docs: initial docs for scrollTo

aa1949b

refactor: descope scrollToTop variant

4f7b643

docs: tweaks

69e4423

refactor: improve TS typing by separating vertical/horizontal scroll

81d4c85

refactor: wrap scroll event in nativeEvent wrapper

fe844e2

refactor: clean up implementation

75cb44a

chore: add FlatList tests

960227d

refactor: remove explicit steps

d5eaaa6

refactor: introduce inertial interpolator for momentum scroll

5d8d628

docs: update docs

c5ad927

chore: update snapshots

6487035

refactor: code review changes

38e60c5

feat: validate scroll direction

9304856

docs: tweaks

7ce9fd3

mdjastrzebski force-pushed the feat/scroll branch from d0a8794 to 7ce9fd3 Compare September 12, 2023 10:23

mdjastrzebski added 6 commits September 12, 2023 12:26

docs: tweak

32d4ee1

refactor: add more tests to improve code cov

3477ea6

refactor: improve errors

be8e0f4

refactor: code review tweaks

4e4c1df

refactor: add wait calls

0f41835

refactor: tweaks, tweaks, tweaks

474aef2

mdjastrzebski requested a review from pierrezimmermannbam September 12, 2023 15:02

refactor: final tweaks

4508d9d

mdjastrzebski approved these changes Sep 13, 2023

View reviewed changes

mdjastrzebski merged commit a7ea95d into callstack:main Sep 13, 2023
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: user event scroll #1445

feat: user event scroll #1445

siepra commented Aug 8, 2023 •

edited by mdjastrzebski

codecov bot commented Aug 8, 2023 •

edited

siepra commented Aug 10, 2023 •

edited

mdjastrzebski commented Aug 14, 2023

mdjastrzebski commented Aug 17, 2023

mdjastrzebski commented Aug 19, 2023

pierrezimmermannbam commented Aug 21, 2023

mdjastrzebski commented Aug 22, 2023

mdjastrzebski commented Sep 3, 2023

siepra left a comment

pierrezimmermannbam Sep 6, 2023

pierrezimmermannbam Sep 6, 2023

mdjastrzebski Sep 7, 2023

mdjastrzebski left a comment

mdjastrzebski commented Oct 24, 2023


		Scroll interaction should match host `ScrollView` direction. For vertical scroll view (`horizontal={false}`) you should pass only `y` (or `momentumY`) options, for horizontal scroll view (`horizontal={true}`) you should pass only `x` (or `momentumX`) options.

		Each scroll interaction consists of mandatory drag scroll part which simulates user dragging the scroll view with his finger (`y` or `x` option). This may optinally be followed by momentum scroll movement which simulates the inertial movement of scroll view content after user lifts his finger up (`momentumY` or `momentumX` options).

feat: user event scroll #1445

feat: user event scroll #1445

Conversation

siepra commented Aug 8, 2023 • edited by mdjastrzebski

Summary

codecov bot commented Aug 8, 2023 • edited

Codecov Report

siepra commented Aug 10, 2023 • edited

mdjastrzebski commented Aug 14, 2023

mdjastrzebski commented Aug 17, 2023

mdjastrzebski commented Aug 19, 2023

pierrezimmermannbam commented Aug 21, 2023

mdjastrzebski commented Aug 22, 2023

mdjastrzebski commented Sep 3, 2023

siepra left a comment

Choose a reason for hiding this comment

pierrezimmermannbam Sep 6, 2023

Choose a reason for hiding this comment

pierrezimmermannbam Sep 6, 2023

Choose a reason for hiding this comment

mdjastrzebski Sep 7, 2023

Choose a reason for hiding this comment

mdjastrzebski left a comment

Choose a reason for hiding this comment

mdjastrzebski commented Oct 24, 2023

siepra commented Aug 8, 2023 •

edited by mdjastrzebski

codecov bot commented Aug 8, 2023 •

edited

siepra commented Aug 10, 2023 •

edited