|
| 1 | +/// useBeforeUnload.ts |
| 2 | +'use client' |
| 3 | + |
| 4 | +import { useEffect, useId } from 'react' |
| 5 | +import { useRouter } from 'next/navigation' |
| 6 | + |
| 7 | +let isForceRouting = false |
| 8 | +const activeIds: string[] = [] |
| 9 | +let lastKnownHref: string |
| 10 | + |
| 11 | +export const useBeforeUnload = (isActive = true) => { |
| 12 | + const id = useId() |
| 13 | + |
| 14 | + // Handle <Link> clicks & onbeforeunload(attemptimg to close/refresh browser) |
| 15 | + useEffect(() => { |
| 16 | + if (!isActive) return |
| 17 | + lastKnownHref = window.location.href |
| 18 | + |
| 19 | + activeIds.push(id) |
| 20 | + |
| 21 | + const handleAnchorClick = (e: Event) => { |
| 22 | + const targetUrl = (e.currentTarget as HTMLAnchorElement).href, |
| 23 | + currentUrl = window.location.href |
| 24 | + |
| 25 | + if (targetUrl !== currentUrl) { |
| 26 | + const res = beforeUnloadFn() |
| 27 | + if (!res) e.preventDefault() |
| 28 | + lastKnownHref = window.location.href |
| 29 | + } |
| 30 | + } |
| 31 | + |
| 32 | + let anchorElements: HTMLAnchorElement[] = [] |
| 33 | + |
| 34 | + const disconnectAnchors = () => { |
| 35 | + anchorElements.forEach((anchor) => { |
| 36 | + anchor.removeEventListener('click', handleAnchorClick) |
| 37 | + }) |
| 38 | + } |
| 39 | + |
| 40 | + const handleMutation = () => { |
| 41 | + disconnectAnchors() |
| 42 | + |
| 43 | + anchorElements = Array.from(document.querySelectorAll('a[href]')) |
| 44 | + anchorElements.forEach((anchor) => { |
| 45 | + anchor.addEventListener('click', handleAnchorClick) |
| 46 | + }) |
| 47 | + } |
| 48 | + |
| 49 | + const mutationObserver = new MutationObserver(handleMutation) |
| 50 | + mutationObserver.observe(document.body, { childList: true, subtree: true }) |
| 51 | + addEventListener('beforeunload', beforeUnloadFn) |
| 52 | + |
| 53 | + return () => { |
| 54 | + removeEventListener('beforeunload', beforeUnloadFn) |
| 55 | + disconnectAnchors() |
| 56 | + mutationObserver.disconnect() |
| 57 | + |
| 58 | + activeIds.splice(activeIds.indexOf(id), 1) |
| 59 | + } |
| 60 | + }, [isActive, id]) |
| 61 | +} |
| 62 | + |
| 63 | +const beforeUnloadFn = (event?: BeforeUnloadEvent) => { |
| 64 | + if (isForceRouting) return true |
| 65 | + |
| 66 | + const message = 'Discard unsaved changes?' |
| 67 | + |
| 68 | + if (event) { |
| 69 | + event.returnValue = message |
| 70 | + return message |
| 71 | + } else { |
| 72 | + return confirm(message) |
| 73 | + } |
| 74 | +} |
| 75 | + |
| 76 | +const BeforeUnloadProvider = ({ children }: React.PropsWithChildren) => { |
| 77 | + const router = useRouter() |
| 78 | + useEffect(() => { |
| 79 | + lastKnownHref = window.location.href |
| 80 | + }) |
| 81 | + |
| 82 | + // Hack nextjs13 popstate impl, so it will include route cancellation. |
| 83 | + // This Provider has to be rendered in the layout phase wrapping the page. |
| 84 | + useEffect(() => { |
| 85 | + let nextjsPopStateHandler: (...args: any[]) => void |
| 86 | + |
| 87 | + function popStateHandler(...args: any[]) { |
| 88 | + useBeforeUnload.ensureSafeNavigation( |
| 89 | + () => { |
| 90 | + nextjsPopStateHandler(...args) |
| 91 | + lastKnownHref = window.location.href |
| 92 | + }, |
| 93 | + () => { |
| 94 | + router.replace(lastKnownHref, { scroll: false }) |
| 95 | + }, |
| 96 | + ) |
| 97 | + } |
| 98 | + |
| 99 | + addEventListener('popstate', popStateHandler) |
| 100 | + const originalAddEventListener = window.addEventListener |
| 101 | + window.addEventListener = (...args: any[]) => { |
| 102 | + if (args[0] === 'popstate') { |
| 103 | + nextjsPopStateHandler = args[1] |
| 104 | + window.addEventListener = originalAddEventListener |
| 105 | + } else { |
| 106 | + // eslint-disable-next-line @typescript-eslint/ban-ts-comment |
| 107 | + // @ts-ignore |
| 108 | + originalAddEventListener(...args) |
| 109 | + } |
| 110 | + } |
| 111 | + |
| 112 | + originalAddEventListener('popstate', (e) => { |
| 113 | + e.preventDefault() |
| 114 | + }) |
| 115 | + |
| 116 | + // window.addEventListener('popstate', () => { |
| 117 | + // history.pushState(null, '', null) |
| 118 | + // }) |
| 119 | + return () => { |
| 120 | + window.addEventListener = originalAddEventListener |
| 121 | + removeEventListener('popstate', popStateHandler) |
| 122 | + } |
| 123 | + }, []) |
| 124 | + |
| 125 | + return children |
| 126 | +} |
| 127 | + |
| 128 | +useBeforeUnload.Provider = BeforeUnloadProvider |
| 129 | + |
| 130 | +useBeforeUnload.forceRoute = async (cb: () => void | Promise<void>) => { |
| 131 | + try { |
| 132 | + isForceRouting = true |
| 133 | + await cb() |
| 134 | + } finally { |
| 135 | + isForceRouting = false |
| 136 | + } |
| 137 | +} |
| 138 | + |
| 139 | +useBeforeUnload.ensureSafeNavigation = ( |
| 140 | + onPerformRoute: () => void, |
| 141 | + onRouteRejected?: () => void, |
| 142 | +) => { |
| 143 | + if (activeIds.length === 0 || beforeUnloadFn()) { |
| 144 | + onPerformRoute() |
| 145 | + } else { |
| 146 | + onRouteRejected?.() |
| 147 | + } |
| 148 | +} |
0 commit comments