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.

Sign up for GitHub

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

Jump to bottom

Add handling for prefetching onTouchStart and initial mobile testing #38805

Merged
merged 4 commits into from Jul 25, 2022
Merged

Add handling for prefetching onTouchStart and initial mobile testing #38805

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf2cdcb
Add handling for prefetching onTouchStart
ijjk Jul 19, 2022
100c9c0
Merge branch 'canary' into add/touchstart-prefetching
ijjk Jul 25, 2022
dfb1fc9
migrate safarit testing to playwright and add mobile tests
ijjk Jul 25, 2022
d6d01cd
Merge branch 'canary' into add/touchstart-prefetching
ijjk Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 30 additions & 1 deletion packages/next/client/link.tsx
View file
Open in desktop
Expand Up @@ -48,6 +48,11 @@ type InternalLinkProps = {
*/
onMouseEnter?: (e: any) => void
// e: any because as it would otherwise overlap with existing types
/**
* requires experimental.newNextLinkBehavior
*/
onTouchStart?: (e: any) => void
// e: any because as it would otherwise overlap with existing types
/**
* requires experimental.newNextLinkBehavior
*/
Expand Down Expand Up @@ -215,6 +220,7 @@ const Link = React.forwardRef<HTMLAnchorElement, LinkPropsReal>(
locale: true,
onClick: true,
onMouseEnter: true,
onTouchStart: true,
legacyBehavior: true,
} as const
const optionalProps: LinkPropsOptional[] = Object.keys(
Expand All @@ -239,7 +245,11 @@ const Link = React.forwardRef<HTMLAnchorElement, LinkPropsReal>(
actual: valType,
})
}
} else if (key === 'onClick' || key === 'onMouseEnter') {
} else if (
key === 'onClick' ||
key === 'onMouseEnter' ||
key === 'onTouchStart'
) {
if (props[key] && valType !== 'function') {
throw createPropError({
key,
Expand Down Expand Up @@ -296,6 +306,7 @@ const Link = React.forwardRef<HTMLAnchorElement, LinkPropsReal>(
locale,
onClick,
onMouseEnter,
onTouchStart,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we consider using the onPointerEnter to handle all mouse/touch in the future? maybe we can use it to handle touch events first?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any quirks to using onPointerEnter vs onMouseEnter/onTouchStart? If not and it handles both definitely sounds ideal

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel the only blocker is browser support. Previously pointer event wasn't supported quite well among all browsers, I remembered years ago safari doesn't. but now it looks not bad, safari 13 has supported it since 2019.

https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can investigate using pointer events in a follow-up, seems onTouchStart should be a good start for compatibility.

legacyBehavior = Boolean(process.env.__NEXT_NEW_LINK_BEHAVIOR) !== true,
...restProps
} = props
Expand Down Expand Up @@ -411,6 +422,7 @@ const Link = React.forwardRef<HTMLAnchorElement, LinkPropsReal>(
}, [as, href, isVisible, locale, p, router])

const childProps: {
onTouchStart: React.TouchEventHandler
onMouseEnter: React.MouseEventHandler
onClick: React.MouseEventHandler
href?: string
Expand Down Expand Up @@ -466,6 +478,23 @@ const Link = React.forwardRef<HTMLAnchorElement, LinkPropsReal>(
prefetch(router, href, as, { priority: true })
}
},
onTouchStart: (e: React.TouchEvent<HTMLAnchorElement>) => {
if (!legacyBehavior && typeof onTouchStart === 'function') {
onTouchStart(e)
}

if (
legacyBehavior &&
child.props &&
typeof child.props.onTouchStart === 'function'
) {
child.props.onTouchStart(e)
}

if (isLocalURL(href)) {
prefetch(router, href, as, { priority: true })
}
},
}

// If child is an <a> tag and doesn't have a href attribute, or if the 'passHref' property is
Expand Down