Skip to content

[WIP] - replace preventDefaultTouchmoveEvent with touchEventOptions #235

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 15 additions & 41 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export {

const defaultProps = {
delta: 10,
preventDefaultTouchmoveEvent: false,
touchEventOptions: { passive: true },
rotationAngle: 0,
trackMouse: false,
trackTouch: true,
Expand Down Expand Up @@ -151,21 +151,6 @@ function getHandlers(

props.onSwiping && props.onSwiping(eventData);

// track if a swipe is cancelable(handler for swiping or swiped(dir) exists)
// so we can call preventDefault if needed
let cancelablePageSwipe = false;
if (props.onSwiping || props.onSwiped || `onSwiped${dir}` in props) {
cancelablePageSwipe = true;
}

if (
cancelablePageSwipe &&
props.preventDefaultTouchmoveEvent &&
props.trackTouch &&
event.cancelable
)
event.preventDefault();

return {
...state,
// first is now always false
Expand Down Expand Up @@ -205,29 +190,24 @@ function getHandlers(
onEnd(e);
};

/**
* Switch of "passive" property for now.
* When `preventDefaultTouchmoveEvent` is:
* - true => { passive: false }
* - false => { passive: true }
*
* Could take entire `addEventListener` options object as a param later?
*/
const attachTouch: AttachTouch = (el, passive) => {
const attachTouch: AttachTouch = (el, eventOptions) => {
let cleanup = () => {};
if (el && el.addEventListener) {
// attach touch event listeners and handlers
const tls: [
typeof touchStart | typeof touchMove | typeof touchEnd,
(e: HandledEvents) => void
(e: HandledEvents) => void,
AddEventListenerOptions
][] = [
[touchStart, onStart],
[touchMove, onMove],
[touchEnd, onEnd],
[touchStart, onStart, eventOptions],
[touchMove, onMove, eventOptions],
[touchEnd, onEnd, {}],
];
tls.forEach(([e, h]) => el.addEventListener(e, h, { passive }));
// return properly scoped cleanup method for removing listeners, options not required
cleanup = () => tls.forEach(([e, h]) => el.removeEventListener(e, h));

tls.forEach(([e, h, o]) => el.addEventListener(e, h, o));

cleanup = () =>
tls.forEach(([e, h, o]) => el.removeEventListener(e, h, o));
}
return cleanup;
};
Expand All @@ -248,10 +228,7 @@ function getHandlers(
}
// only attach if we want to track touch
if (props.trackTouch && el) {
addState.cleanUpTouch = attachTouch(
el,
!props.preventDefaultTouchmoveEvent
);
addState.cleanUpTouch = attachTouch(el, props.touchEventOptions);
}

// store event attached DOM el for comparison, clean up, and re-attachment
Expand All @@ -274,7 +251,7 @@ function getHandlers(

function updateTransientState(
state: SwipeableState,
props: SwipeableProps,
props: SwipeablePropsWithDefaultOptions,
attachTouch: AttachTouch
) {
const addState: { cleanUpTouch?(): void } = {};
Expand All @@ -285,10 +262,7 @@ function updateTransientState(
} else if (props.trackTouch && !state.cleanUpTouch) {
// attach/re-attach touch handlers
if (state.el) {
addState.cleanUpTouch = attachTouch(
state.el,
!props.preventDefaultTouchmoveEvent
);
addState.cleanUpTouch = attachTouch(state.el, props.touchEventOptions);
}
}
return { ...state, ...addState };
Expand Down
7 changes: 5 additions & 2 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export type SwipeableCallbacks = {
// Configuration Options
export interface ConfigurationOptions {
delta: number;
preventDefaultTouchmoveEvent: boolean;
touchEventOptions: AddEventListenerOptions;
rotationAngle: number;
trackMouse: boolean;
trackTouch: boolean;
Expand Down Expand Up @@ -73,4 +73,7 @@ export type StateSetter = (
props: SwipeablePropsWithDefaultOptions
) => SwipeableState;
export type Setter = (stateSetter: StateSetter) => void;
export type AttachTouch = (el: HTMLElement, passive: boolean) => () => void;
export type AttachTouch = (
el: HTMLElement,
eventOptions: AddEventListenerOptions
) => () => void;