-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: improve link with prefetch (#12844)
* feat: improve link with prefetch * feat: support preload=render * feat: support preload=viewport * chore: throw error when prefetch props is invalid * chore: docs and default prefetch config * ci: fix
- Loading branch information
Showing
7 changed files
with
164 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,111 @@ | ||
| import React, { PropsWithChildren } from 'react'; | ||
| import React, { PropsWithChildren, useLayoutEffect } from 'react'; | ||
| import { Link, LinkProps } from 'react-router-dom'; | ||
| import { useAppData } from './appContext'; | ||
| import { useIntersectionObserver } from './useIntersectionObserver'; | ||
|
|
||
| export function LinkWithPrefetch( | ||
| props: PropsWithChildren< | ||
| { | ||
| prefetch?: boolean; | ||
| } & LinkProps & | ||
| React.RefAttributes<HTMLAnchorElement> | ||
| >, | ||
| ) { | ||
| const { prefetch, ...linkProps } = props; | ||
| const appData = useAppData(); | ||
| const to = typeof props.to === 'string' ? props.to : props.to?.pathname; | ||
| // compatible with old code | ||
| // which to might be undefined | ||
| if (!to) return null; | ||
| return ( | ||
| <Link | ||
| onMouseEnter={() => prefetch && to && appData.preloadRoute?.(to)} | ||
| {...linkProps} | ||
| > | ||
| {props.children} | ||
| </Link> | ||
| ); | ||
| function useForwardedRef<T>(ref?: React.ForwardedRef<T>) { | ||
| const innerRef = React.useRef<T>(null); | ||
| React.useEffect(() => { | ||
| if (!ref) return; | ||
| if (typeof ref === 'function') { | ||
| ref(innerRef.current); | ||
| } else { | ||
| ref.current = innerRef.current; | ||
| } | ||
| }); | ||
| return innerRef; | ||
| } | ||
|
|
||
| export const LinkWithPrefetch = React.forwardRef( | ||
| ( | ||
| props: PropsWithChildren< | ||
| { | ||
| prefetch?: boolean | 'intent' | 'render' | 'viewport' | 'none'; | ||
| prefetchTimeout?: number; | ||
| } & LinkProps & | ||
| React.RefAttributes<HTMLAnchorElement> | ||
| >, | ||
| forwardedRef, | ||
| ) => { | ||
| const { prefetch: prefetchProp, ...linkProps } = props; | ||
| const { defaultPrefetch, defaultPrefetchTimeout } = (typeof window !== | ||
| 'undefined' && // @ts-ignore | ||
| window.__umi_route_prefetch__) || { | ||
| defaultPrefetch: 'none', | ||
| defaultPrefetchTimeout: 50, | ||
| }; | ||
|
|
||
| const prefetch = | ||
| (prefetchProp === true | ||
| ? 'intent' | ||
| : prefetchProp === false | ||
| ? 'none' | ||
| : prefetchProp) || defaultPrefetch; | ||
| if (!['intent', 'render', 'viewport', 'none'].includes(prefetch)) { | ||
| throw new Error( | ||
| `Invalid prefetch value ${prefetch} found in Link component`, | ||
| ); | ||
| } | ||
| const appData = useAppData(); | ||
| const to = typeof props.to === 'string' ? props.to : props.to?.pathname; | ||
| const hasRenderFetched = React.useRef(false); | ||
| const ref = useForwardedRef(forwardedRef); | ||
| // prefetch intent | ||
| const handleMouseEnter = (e: React.MouseEvent<HTMLAnchorElement>) => { | ||
| if (prefetch !== 'intent') return; | ||
| const eventTarget = (e.target || {}) as HTMLElement & { | ||
| preloadTimeout?: NodeJS.Timeout | null; | ||
| }; | ||
| if (eventTarget.preloadTimeout) return; | ||
| eventTarget.preloadTimeout = setTimeout(() => { | ||
| eventTarget.preloadTimeout = null; | ||
| appData.preloadRoute?.(to!); | ||
| }, props.prefetchTimeout || defaultPrefetchTimeout); | ||
| }; | ||
| const handleMouseLeave = (e: React.MouseEvent<HTMLAnchorElement>) => { | ||
| if (prefetch !== 'intent') return; | ||
| const eventTarget = (e.target || {}) as HTMLElement & { | ||
| preloadTimeout?: NodeJS.Timeout | null; | ||
| }; | ||
| if (eventTarget.preloadTimeout) { | ||
| clearTimeout(eventTarget.preloadTimeout); | ||
| eventTarget.preloadTimeout = null; | ||
| } | ||
| }; | ||
|
|
||
| // prefetch render | ||
| useLayoutEffect(() => { | ||
| if (prefetch === 'render' && !hasRenderFetched.current) { | ||
| appData.preloadRoute?.(to!); | ||
| hasRenderFetched.current = true; | ||
| } | ||
| }, [prefetch, to]); | ||
|
|
||
| // prefetch viewport | ||
| useIntersectionObserver( | ||
| ref as React.RefObject<HTMLAnchorElement>, | ||
| (entry) => { | ||
| if (entry?.isIntersecting) { | ||
| appData.preloadRoute?.(to!); | ||
| } | ||
| }, | ||
| { rootMargin: '100px' }, | ||
| { disabled: prefetch !== 'viewport' }, | ||
| ); | ||
|
|
||
| // compatible with old code | ||
| // which to might be undefined | ||
| if (!to) return null; | ||
|
|
||
| return ( | ||
| <Link | ||
| onMouseEnter={handleMouseEnter} | ||
| onMouseLeave={handleMouseLeave} | ||
| ref={ref as React.RefObject<HTMLAnchorElement>} | ||
| {...linkProps} | ||
| > | ||
| {props.children} | ||
| </Link> | ||
| ); | ||
| }, | ||
| ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| import React from 'react'; | ||
|
|
||
| export function useIntersectionObserver<T extends Element>( | ||
| ref: React.RefObject<T>, | ||
| callback: (entry: IntersectionObserverEntry | undefined) => void, | ||
| intersectionObserverOptions: IntersectionObserverInit = {}, | ||
| options: { disabled?: boolean } = {}, | ||
| ): IntersectionObserver | null { | ||
| // check if IntersectionObserver is available | ||
| if (typeof IntersectionObserver !== 'function') return null; | ||
|
|
||
| const isIntersectionObserverAvailable = React.useRef( | ||
| typeof IntersectionObserver === 'function', | ||
| ); | ||
| const observerRef = React.useRef<IntersectionObserver | null>(null); | ||
| React.useEffect(() => { | ||
| if ( | ||
| !ref.current || | ||
| !isIntersectionObserverAvailable.current || | ||
| options.disabled | ||
| ) { | ||
| return; | ||
| } | ||
| observerRef.current = new IntersectionObserver(([entry]) => { | ||
| callback(entry); | ||
| }, intersectionObserverOptions); | ||
| observerRef.current.observe(ref.current); | ||
| return () => { | ||
| observerRef.current?.disconnect(); | ||
| }; | ||
| }, [callback, intersectionObserverOptions, options.disabled, ref]); | ||
| return observerRef.current; | ||
| } |