Adds hook for view managers to capture pointer events by rozele · Pull Request #8495 · microsoft/react-native-windows

Eric Rozell (rozele) · 2021-08-27T19:07:23Z

Currently, there is no way for ViewManagers to capture the pointer to perform it's own pointer event handling. This change introduces a new interface, IViewManagerWithPointerEvents, so third party modules can be notified when the ReactRootView receives pointer events. The behavior is as follows:

ViewManagerBase adds a virtual method:
OnPointerEvent(object sender, ReactPointerEventArgs args)

We have a ReactPointerEventArgs wrapper around PointerRoutedEventArgs that view managers can use to:

Call PreventDefault to suppress the corresponding React event from being emitted
Call ReleaseCapture to force the TouchEventEmitter to release pointer capture (triggering an onTouchCancel event to React Native)
Update the Target property to refine for hit testing

The ReactPointerEventArgs wrapper also includes an enum Kind value for the type of pointer event so we can reduce the number of methods that need to be implemented for this interface.

TODO:

Only release pointer in OnPointerMoved rather than invoking OnPointerConcluded.
Consolidate parent traversals so we only traverse shadow node tree once per event.
~~Add custom view manager example that uses this API.~~ N/A since we now leverage these APIs in core view managers
Determine if IViewManagerWithPointerEvents should participate in onMouseEnter / onMouseLeave events: The current approach should start onMouseEnter / onMouseLeave events at the ReactPointerEventArgs.Target() element.

We will need to update a few other PRs to leverage these APIs once they merge:

Update Refines algorithm for hit testing Text #7553 and Introduces TextVisitor to consolidate text traversal algorithms #8454 to use the OnPointer* APIs for Text hit testing
Update Allow pointer events on selectable Text #7813 to use PreventDefault to suppress OnPointerCaptureLost from firing an onTouchCancel event

Microsoft Reviewers: Open in CodeFlow

acoates-ms · 2021-08-27T20:29:58Z

Alicia Drummond (@FalseLobster) you might want to look at this - Anyone else that should be looped into this?

Alexander Sklar (asklar) · 2021-08-27T20:50:42Z

Steven Moyes (@stmoy) Chris Glein (@chrisglein) fyi
Eric Rozell (@rozele) I created an issue to track discussing the design: #8499

…t#8495

…e captured in the PointerPressed event

… always called when a child captures the pointer

Nick Gerleman (NickGerleman)

Lgtm, in current form with minimal API surface.

Nick Gerleman (NickGerleman) · 2021-09-28T20:32:11Z

@msftbot merge in 24 hours

Deleted user (ghost) · 2021-09-28T20:32:15Z

Hello Nick Gerleman (@NickGerleman)!

Because you've given me some instructions on how to help merge this pull request, I'll be modifying my merge approach. Here's how I understand your requirements for merging this pull request:

I won't merge this pull request until after the UTC date Wed, 29 Sep 2021 20:32:14 GMT, which is in 1 day

If this doesn't seem right to you, you can tell me to cancel these instructions and use the auto-merge policy that has been configured for this repository. Try telling me "forget everything I just told you".

Alexander Sklar (asklar)

LGTM, let's just update the doc strings so it's a little more clear when these things are triggered/used

Eric Rozell (rozele) · 2021-09-29T00:17:28Z

Alexander Sklar (@asklar) - Updated the DOC_STRINGS in 235e110

Alexander Sklar (asklar)

thanks Eric Rozell (@rozele), and for updating the docs : )

Deleted user (ghost) · 2021-09-29T19:04:15Z

Hello Alexander Sklar (@asklar)!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

In microsoft#8495, we added an interface for 3rd party view managers to override pointer event handling in the TouchEventHandler module from RNW. The features of this PR supported press events on selectable text, but to generalize this further, we need to allow 3rd party view managers to conditionally cancel pointer event sequences and prevent press events. This change adds the ability for view managers implementing the IViewManagerWithPointerEvents interface to change an "End" event to a "Cancel" event to achieve just that. Fixes microsoft#10202

* Adds gesture cancellation to pointer event handling In #8495, we added an interface for 3rd party view managers to override pointer event handling in the TouchEventHandler module from RNW. The features of this PR supported press events on selectable text, but to generalize this further, we need to allow 3rd party view managers to conditionally cancel pointer event sequences and prevent press events. This change adds the ability for view managers implementing the IViewManagerWithPointerEvents interface to change an "End" event to a "Cancel" event to achieve just that. Fixes #10202 * Change files

…#10203) In microsoft#8495, we added an interface for 3rd party view managers to override pointer event handling in the TouchEventHandler module from RNW. The features of this PR supported press events on selectable text, but to generalize this further, we need to allow 3rd party view managers to conditionally cancel pointer event sequences and prevent press events. This change adds the ability for view managers implementing the IViewManagerWithPointerEvents interface to change an "End" event to a "Cancel" event to achieve just that. Fixes microsoft#10202

Eric Rozell (rozele) requested a review from a team as a code owner August 27, 2021 19:07

Alexander Sklar (asklar) linked an issue Aug 27, 2021 that may be closed by this pull request

View managers should be able to handle/capture pointer events #8499

Closed

This was referenced Aug 28, 2021

View managers should be able to handle/capture pointer events #8499

Closed

Allow pointer events on selectable Text #7813

Merged

Eric Rozell (rozele) commented Aug 29, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/ABIViewManager.cpp

ghost added the Area: Mouse label Aug 31, 2021

Eric Rozell (rozele) mentioned this pull request Aug 31, 2021

Generalizes hit testing so all view managers can participate #8493

Closed

Alexander Sklar (asklar) reviewed Aug 31, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/ReactPointerEventArgs.idl Outdated

Alexander Sklar (asklar) reviewed Aug 31, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/ReactPointerEventArgs.idl

Eric Rozell (rozele) mentioned this pull request Aug 31, 2021

Fixes bugs for pointerEvents prop #8500

Merged

Eric Rozell (rozele) force-pushed the viewManagerPointerEvents branch from fadfd81 to 1200440 Compare August 31, 2021 19:03

Eric Rozell (rozele) commented Aug 31, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/ABIViewManager.cpp Outdated

Eric Rozell (rozele) commented Aug 31, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/ABIViewManager.cpp Outdated

Eric Rozell (rozele) commented Aug 31, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/ReactPointerEventArgs.h Outdated

Eric Rozell (rozele) added a commit to rozele/react-native-windows that referenced this pull request Sep 1, 2021

Migrates selectable text pressability to use APIs defined in microsof…

6474426

…t#8495

Eric Rozell (rozele) force-pushed the viewManagerPointerEvents branch from 641de1a to 19bf044 Compare September 1, 2021 19:11

Nick Gerleman (NickGerleman) reviewed Sep 2, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/Views/TouchEventHandler.cpp Outdated

Eric Rozell (rozele) force-pushed the viewManagerPointerEvents branch 7 times, most recently from 9c89083 to 2397fcc Compare September 3, 2021 02:19

Eric Rozell (rozele) commented Sep 7, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/Views/TouchEventHandler.cpp

Eric Rozell (rozele) force-pushed the viewManagerPointerEvents branch from ad73947 to 5c04d1d Compare September 7, 2021 15:58

Eric Rozell (rozele) commented Sep 7, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/Views/TouchEventHandler.cpp Outdated

Eric Rozell (rozele) force-pushed the viewManagerPointerEvents branch from 5c04d1d to 0649e71 Compare September 8, 2021 14:58

Eric Rozell (rozele) added 5 commits September 28, 2021 11:02

Fixes bug with nested text hit testing

3512a7e

Replace ReleaseCapture with AllowUncaptured given pointers can only b…

3541d49

…e captured in the PointerPressed event

Allow override of CaptureLost event to End event since Release is not…

237f9ce

… always called when a child captures the pointer

Fix crash due to moving vector before using

c51e9cc

Reducing to minimum API surface to support fixes for pointerEvents

1e5e303

Eric Rozell (rozele) force-pushed the viewManagerPointerEvents branch from 5646df0 to 1e5e303 Compare September 28, 2021 15:02

Nick Gerleman (NickGerleman) approved these changes Sep 28, 2021

View reviewed changes

ghost added the AutoMerge Causes a PR to be automatically merged once all requirements are passed (label drives bot activity) label Sep 28, 2021

Alexander Sklar (asklar) reviewed Sep 28, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/IViewManager.idl

Alexander Sklar (asklar) reviewed Sep 28, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/ReactPointerEventArgs.idl Outdated

Alexander Sklar (asklar) reviewed Sep 28, 2021

View reviewed changes

Comment thread vnext/Microsoft.ReactNative/ReactPointerEventArgs.idl Outdated

Alexander Sklar (asklar) suggested changes Sep 28, 2021

View reviewed changes

Eric Rozell (rozele) force-pushed the viewManagerPointerEvents branch 2 times, most recently from 1903618 to 235e110 Compare September 29, 2021 00:27

DOC_STRING updates for new IViewManager APIs

856e8e5

Eric Rozell (rozele) force-pushed the viewManagerPointerEvents branch from 235e110 to 856e8e5 Compare September 29, 2021 14:35

Alexander Sklar (asklar) approved these changes Sep 29, 2021

View reviewed changes

Alexander Sklar (asklar) added the AutoMerge Causes a PR to be automatically merged once all requirements are passed (label drives bot activity) label Sep 29, 2021

ghost merged commit 4bc8637 into microsoft:main Sep 29, 2021

Eric Rozell (rozele) mentioned this pull request Jun 27, 2022

Adds gesture cancellation to pointer event handling #10203

Merged

This pull request was closed.

Conversation

Eric Rozell (rozele) commented Aug 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Microsoft Reviewers: Open in CodeFlow

Uh oh!

acoates-ms commented Aug 27, 2021

Uh oh!

Alexander Sklar (asklar) commented Aug 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nick Gerleman (NickGerleman) left a comment

Choose a reason for hiding this comment

Uh oh!

Nick Gerleman (NickGerleman) commented Sep 28, 2021

Uh oh!

Deleted user (ghost) commented Sep 28, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Alexander Sklar (asklar) left a comment

Choose a reason for hiding this comment

Uh oh!

Eric Rozell (rozele) commented Sep 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Alexander Sklar (asklar) left a comment

Choose a reason for hiding this comment

Uh oh!

Deleted user (ghost) commented Sep 29, 2021

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Eric Rozell (rozele) commented Aug 27, 2021 •

edited

Loading

Alexander Sklar (asklar) commented Aug 27, 2021 •

edited

Loading

Eric Rozell (rozele) commented Sep 29, 2021 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.