Add a new gesture relation - `blocksHandlers` - working like `reversed waitFor` #2627

j-piasecki · 2023-10-10T13:36:21Z

Description

Introduces a new relation between gestures, which allows to set one gesture recognizer as blocking for another one. It's basically the same as waitFor but in the other direction - waitFor allows to specify which gestures must fail before this one can activate. The new prop allows to specify which gestures should require this one to fail before they can activate.

For the name, I think we've settled at blocksHandlers for the old API and .blocksExternalGesture() for the new API.

There's no need to add another type of composition since it accomplishes the same thing as Gesture.Exclusive, and is inherently a between-components relation.

Test plan

Tested on the Example app

Since it relies on already existing logic, I assume it will work correctly. I would like to do more testing nonetheless.
Also needs to be tested on physical iOS device with multi-touch gestures.

docs/docs/fundamentals/gesture-composition.md

kacperkapusciak · 2023-10-25T08:21:38Z

docs/docs/fundamentals/gesture-composition.md

+
+## requiredToFailByExternalGesture
+
+`requiredToFailByExternalGesture` works similarily to `requireExternalGestureToFail` but the direction of the relation is reversed - insted of making the gesture it's called on wait for failure of gestures passed as arguments, it's making gestures passed as arguments wait for the gesture it's called on. It's especially usefull for making lists where the `ScrollView` component needs to wait for every gesture underneath it. All that's required is passing a ref of the `ScrollView` to the gesture object, for example:


The first sentence is a complete gibberish :grief:

also, typos in insted and usefull

also, the last sentence I'd write something like:

All that's required to do is to pass a ref

Could you take a look at 03878fd and 5cf17b9?

kacperkapusciak · 2023-10-25T09:18:15Z

docs/docs/fundamentals/gesture-composition.md

+
+## simultaneousWithExternalGesture
+
+`simultaneousWithExternalGesture` allows gestures across different components to be recognized simultaneously. We can modify the example from `requireExternalGestureToFail` to showcase this: let's say you have two nested views, again both with tap gesture attached. This time, both of them require one tap, but tapping the inner one should also activate the gesture attached to the outer view:


People rarely read documentation from start to finish. They mostly skim the headings and code so refering to previous sections isn't that useful

It's better to repeat the full intent of the paragraph rather than refering to previous sections

kmagiera

Code changes look good. I wonder why is this marked as draft? Also would be good to explain the plans for adding this to web.

The only comment I have is around the naming. I understand that this aims to replicate the naming from the UIKit gesture recognizer API, but I find it very confusing. I'd consider going with some different naming convention not revolving around "waiting". Some ideas:
1)blocksRecognizer={ref} – this name would suggest that recognizer ref will be blocked by the current one, which IMO illustrates this relation pretty well
2) preempts={ref} – this will suggest that this recognizer will take precedence over ref

j-piasecki · 2023-10-26T12:00:10Z

Code changes look good. I wonder why is this marked as draft? Also would be good to explain the plans for adding this to web.

It's marked as a draft because it's not finished yet, as you noticed anything related to web is missing.

As for the name, blocksRecognizer sounds like the best option to me.

Co-authored-by: Kacper Kapuściak <[email protected]>

…t-native-gesture-handler into @jpiasecki/roFtiaw

kmagiera

Accepting this once again as the code looks good. Just wanted to note that my prev suggestion about the name might not be in line with the naming we use here, specifically, we don't use word "recognizers" elsewhere AFAIK and it should rather be blocksHandlers, similarily to "simultaniousHandlers", what do you think?

…t-native-gesture-handler into @jpiasecki/roFtiaw

j-piasecki · 2023-10-31T15:41:39Z

Just wanted to note that my prev suggestion about the name might not be in line with the naming we use here, specifically, we don't use word "recognizers" elsewhere AFAIK and it should rather be blocksHandlers, similarily to "simultaniousHandlers", what do you think?

"recognizers" is used in some places but only internally. In public APIs, we use "handlers", so the change makes perfect sense.

kacperkapusciak

j-piasecki added 2 commits October 10, 2023 14:51

Implement reversed waitFor

bf59199

Rename to requiredToFailBy

5e5aeeb

j-piasecki changed the title ~~Add a new gesture relation - shouldBeRequiredToFailBy - working like reversed waitFor~~ Add a new gesture relation - requiredToFailBy - working like reversed waitFor Oct 10, 2023

j-piasecki added 2 commits October 17, 2023 10:19

Reverse logic

73ae79b

Update docs

be695e0

kacperkapusciak requested changes Oct 25, 2023

View reviewed changes

kmagiera approved these changes Oct 26, 2023

View reviewed changes

j-piasecki and others added 9 commits October 31, 2023 10:34

Update docs/docs/fundamentals/gesture-composition.md

c78c8b9

Co-authored-by: Kacper Kapuściak <[email protected]>

Update docs/docs/fundamentals/gesture-composition.md

39581dc

Co-authored-by: Kacper Kapuściak <[email protected]>

Update composition docs

03878fd

Merge branch '@jpiasecki/roFtiaw' of github.com:software-mansion/reac…

6115bd6

…t-native-gesture-handler into @jpiasecki/roFtiaw

Update last sentence

5cf17b9

Rename to blocksRecognizers

5888b71

We actually have the relevant method on Android

235615f

Add web implementation

4ecbf39

Update other interactions

e3ecbab

j-piasecki changed the title ~~Add a new gesture relation - requiredToFailBy - working like reversed waitFor~~ Add a new gesture relation - blocksRecognizers - working like reversed waitFor Oct 31, 2023

Merge branch 'main' into @jpiasecki/roFtiaw

9e2a3f2

j-piasecki marked this pull request as ready for review October 31, 2023 10:35

kmagiera approved these changes Oct 31, 2023

View reviewed changes

j-piasecki added 2 commits October 31, 2023 16:39

Rename to blocksHandlers

0385cf3

Merge branch '@jpiasecki/roFtiaw' of github.com:software-mansion/reac…

fc5c940

…t-native-gesture-handler into @jpiasecki/roFtiaw

j-piasecki changed the title ~~Add a new gesture relation - blocksRecognizers - working like reversed waitFor~~ Add a new gesture relation - blocksHandlers - working like reversed waitFor Oct 31, 2023

kacperkapusciak approved these changes Nov 21, 2023

View reviewed changes

j-piasecki merged commit 510905e into main Nov 21, 2023
7 checks passed

j-piasecki deleted the @jpiasecki/roFtiaw branch November 21, 2023 09:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a new gesture relation - `blocksHandlers` - working like `reversed waitFor` #2627

Add a new gesture relation - `blocksHandlers` - working like `reversed waitFor` #2627

j-piasecki commented Oct 10, 2023 •

edited

Loading

kacperkapusciak Oct 25, 2023

j-piasecki Oct 31, 2023

kacperkapusciak Oct 25, 2023

kmagiera left a comment

j-piasecki commented Oct 26, 2023

kmagiera left a comment

j-piasecki commented Oct 31, 2023

kacperkapusciak left a comment


		## requiredToFailByExternalGesture

		`requiredToFailByExternalGesture` works similarily to `requireExternalGestureToFail` but the direction of the relation is reversed - insted of making the gesture it's called on wait for failure of gestures passed as arguments, it's making gestures passed as arguments wait for the gesture it's called on. It's especially usefull for making lists where the `ScrollView` component needs to wait for every gesture underneath it. All that's required is passing a ref of the `ScrollView` to the gesture object, for example:


		## simultaneousWithExternalGesture

		`simultaneousWithExternalGesture` allows gestures across different components to be recognized simultaneously. We can modify the example from `requireExternalGestureToFail` to showcase this: let's say you have two nested views, again both with tap gesture attached. This time, both of them require one tap, but tapping the inner one should also activate the gesture attached to the outer view:

Add a new gesture relation - blocksHandlers - working like reversed waitFor #2627

Add a new gesture relation - blocksHandlers - working like reversed waitFor #2627

Conversation

j-piasecki commented Oct 10, 2023 • edited Loading

Description

Test plan

kacperkapusciak Oct 25, 2023

Choose a reason for hiding this comment

j-piasecki Oct 31, 2023

Choose a reason for hiding this comment

kacperkapusciak Oct 25, 2023

Choose a reason for hiding this comment

kmagiera left a comment

Choose a reason for hiding this comment

j-piasecki commented Oct 26, 2023

kmagiera left a comment

Choose a reason for hiding this comment

j-piasecki commented Oct 31, 2023

kacperkapusciak left a comment

Choose a reason for hiding this comment

Add a new gesture relation - `blocksHandlers` - working like `reversed waitFor` #2627

Add a new gesture relation - `blocksHandlers` - working like `reversed waitFor` #2627

j-piasecki commented Oct 10, 2023 •

edited

Loading