Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow access to native event in 'allowTouchMove' #226

Closed
wants to merge 1 commit into from

Conversation

lincolnthree
Copy link

@lincolnthree lincolnthree commented Jun 30, 2021

In order to facilitate more advanced types of event detection / decision-making when allowing touchmove events, it is sometimes necessary to have access to the Event itself in certain scenarios. For example, detection of Pen / Stylus (see example below), or if you want to use touch X/Y position instead of element.

(Currently B.S.L. breaks all stylus touches, and the only way I've figured out to fix it is to disable BSL on stylus touch events.)

That may be worth a separate issue in itself, but I still think there's value in exposing the native event regardless, since it would allow for much finer grained control over 'allowTouchMove' behavior.

        disableBodyScroll(mainElmt, {
          allowTouchMove: (el: HTMLElement, e: Event) => {
            const touch = e as TouchEvent;
            if (touch.touches?.[0]?.touchType === 'stylus') {
              return true;
            }
            // ...
          },
        });

The proposed changes should be backwards compatible. And, if it helps, we've been running this in production on over 100,000 devices so far with no issues on any platform/browser.

In order to facilitate more advanced types of event detection / decision-making when allowing `touchmove` events, it is sometimes necessary to have access to the `Event` itself in certain scenarios. For example, detection of Pen / Stylus (see example below).

(Currently B.S.L. breaks all stylus touches, and the only way I've figured out to fix it is to disable BSL on stylus touch events.)

That may be worth a separate issue in itself, but I still think there's value in exposing the native event, since it would allow for much finer grained control over 'allowTouchMove' behavior.

```
        disableBodyScroll(mainElmt, {
          allowTouchMove: (el: HTMLElement, e: Event) => {
            const touch = e as TouchEvent;
            if (touch.touches?.[0]?.touchType === 'stylus') {
              return true;
            }
            // ...
          },
        });
```
diachedelic pushed a commit that referenced this pull request Jul 1, 2021
The allowTouchMove handler now receives the touch event as an additional
parameter.

close #226
@diachedelic
Copy link
Collaborator

Thanks @lincolnthree , that's a good idea. Watch #227 for progress.

@diachedelic diachedelic closed this Jul 1, 2021
@lincolnthree
Copy link
Author

@diachedelic Sounds good. If you like how I implemented things in the PR, I wouldn't mind if you added me to the contributors or commit log. No big deal though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants