-
Notifications
You must be signed in to change notification settings - Fork 26.9k
/
link.tsx
312 lines (269 loc) · 8.28 KB
/
link.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
declare const __NEXT_DATA__: any
import { resolve, parse, UrlObject } from 'url'
import React, { Component, Children } from 'react'
import PropTypes from 'prop-types'
import Router from './router'
import { rewriteUrlForNextExport } from '../next-server/lib/router/rewrite-url-for-export'
import {
execOnce,
formatWithValidation,
getLocationOrigin,
} from '../next-server/lib/utils'
function isLocal(href: string) {
const url = parse(href, false, true)
const origin = parse(getLocationOrigin(), false, true)
return (
!url.host || (url.protocol === origin.protocol && url.host === origin.host)
)
}
type Url = string | UrlObject
type FormatResult = { href: string; as?: string }
function memoizedFormatUrl(formatFunc: (href: Url, as?: Url) => FormatResult) {
let lastHref: null | Url = null
let lastAs: undefined | null | Url = null
let lastResult: null | FormatResult = null
return (href: Url, as?: Url) => {
if (lastResult && href === lastHref && as === lastAs) {
return lastResult
}
const result = formatFunc(href, as)
lastHref = href
lastAs = as
lastResult = result
return result
}
}
function formatUrl(url: Url) {
return url && typeof url === 'object' ? formatWithValidation(url) : url
}
export type LinkProps = {
href: Url
as?: Url
replace?: boolean
scroll?: boolean
shallow?: boolean
passHref?: boolean
prefetch?: boolean
}
let observer: IntersectionObserver
const listeners = new Map()
const IntersectionObserver =
typeof window !== 'undefined' ? (window as any).IntersectionObserver : null
function getObserver() {
// Return shared instance of IntersectionObserver if already created
if (observer) {
return observer
}
// Only create shared IntersectionObserver if supported in browser
if (!IntersectionObserver) {
return undefined
}
return (observer = new IntersectionObserver(
(entries: any) => {
entries.forEach((entry: any) => {
if (!listeners.has(entry.target)) {
return
}
const cb = listeners.get(entry.target)
if (entry.isIntersecting || entry.intersectionRatio > 0) {
observer.unobserve(entry.target)
listeners.delete(entry.target)
cb()
}
})
},
{ rootMargin: '200px' }
))
}
const listenToIntersections = (el: any, cb: any) => {
const observer = getObserver()
if (!observer) {
return () => {}
}
observer.observe(el)
listeners.set(el, cb)
return () => {
try {
observer.unobserve(el)
} catch (err) {
console.error(err)
}
listeners.delete(el)
}
}
class Link extends Component<LinkProps> {
static propTypes?: any
p: boolean
constructor(props: LinkProps) {
super(props)
if (process.env.NODE_ENV !== 'production') {
if (props.prefetch) {
console.warn(
'Next.js auto-prefetches automatically based on viewport. The prefetch attribute is no longer needed. More: https://err.sh/zeit/next.js/prefetch-true-deprecated'
)
}
}
this.p = props.prefetch !== false
}
cleanUpListeners = () => {}
componentWillUnmount() {
this.cleanUpListeners()
}
getHref() {
const { pathname } = window.location
const { href: parsedHref } = this.formatUrls(this.props.href, this.props.as)
return resolve(pathname, parsedHref)
}
handleRef(ref: Element) {
const isPrefetched = (Router.router as any).pageLoader.prefetched[
this.getHref()
]
if (this.p && IntersectionObserver && ref && ref.tagName) {
this.cleanUpListeners()
if (!isPrefetched) {
this.cleanUpListeners = listenToIntersections(ref, () => {
this.prefetch()
})
}
}
}
// The function is memoized so that no extra lifecycles are needed
// as per https://reactjs.org/blog/2018/06/07/you-probably-dont-need-derived-state.html
formatUrls = memoizedFormatUrl((href, asHref) => {
return {
href: formatUrl(href),
as: asHref ? formatUrl(asHref) : asHref,
}
})
linkClicked = (e: React.MouseEvent) => {
// @ts-ignore target exists on currentTarget
const { nodeName, target } = e.currentTarget
if (
nodeName === 'A' &&
((target && target !== '_self') ||
e.metaKey ||
e.ctrlKey ||
e.shiftKey ||
(e.nativeEvent && e.nativeEvent.which === 2))
) {
// ignore click for new tab / new window behavior
return
}
let { href, as } = this.formatUrls(this.props.href, this.props.as)
if (!isLocal(href)) {
// ignore click if it's outside our scope (e.g. https://google.com)
return
}
const { pathname } = window.location
href = resolve(pathname, href)
as = as ? resolve(pathname, as) : href
e.preventDefault()
// avoid scroll for urls with anchor refs
let { scroll } = this.props
if (scroll == null) {
scroll = as.indexOf('#') < 0
}
// replace state instead of push if prop is present
Router[this.props.replace ? 'replace' : 'push'](href, as, {
shallow: this.props.shallow,
}).then((success: boolean) => {
if (!success) return
if (scroll) {
window.scrollTo(0, 0)
document.body.focus()
}
})
}
prefetch() {
if (!this.p || typeof window === 'undefined') return
// Prefetch the JSON page if asked (only in the client)
Router.prefetch(this.getHref())
}
render() {
let { children } = this.props
const { href, as } = this.formatUrls(this.props.href, this.props.as)
// Deprecated. Warning shown by propType check. If the children provided is a string (<Link>example</Link>) we wrap it in an <a> tag
if (typeof children === 'string') {
children = <a>{children}</a>
}
// This will return the first child, if multiple are provided it will throw an error
const child: any = Children.only(children)
const props: {
onMouseEnter: React.MouseEventHandler
onClick: React.MouseEventHandler
href?: string
ref?: any
} = {
ref: (el: any) => {
this.handleRef(el)
if (child && typeof child === 'object' && child.ref) {
if (typeof child.ref === 'function') child.ref(el)
else if (typeof child.ref === 'object') {
child.ref.current = el
}
}
},
onMouseEnter: (e: React.MouseEvent) => {
if (child.props && typeof child.props.onMouseEnter === 'function') {
child.props.onMouseEnter(e)
}
this.prefetch()
},
onClick: (e: React.MouseEvent) => {
if (child.props && typeof child.props.onClick === 'function') {
child.props.onClick(e)
}
if (!e.defaultPrevented) {
this.linkClicked(e)
}
},
}
// If child is an <a> tag and doesn't have a href attribute, or if the 'passHref' property is
// defined, we specify the current 'href', so that repetition is not needed by the user
if (
this.props.passHref ||
(child.type === 'a' && !('href' in child.props))
) {
props.href = as || href
}
// Add the ending slash to the paths. So, we can serve the
// "<page>/index.html" directly.
if (process.env.__NEXT_EXPORT_TRAILING_SLASH) {
if (
props.href &&
typeof __NEXT_DATA__ !== 'undefined' &&
__NEXT_DATA__.nextExport
) {
props.href = rewriteUrlForNextExport(props.href)
}
}
return React.cloneElement(child, props)
}
}
if (process.env.NODE_ENV === 'development') {
const warn = execOnce(console.error)
// This module gets removed by webpack.IgnorePlugin
const exact = require('prop-types-exact')
Link.propTypes = exact({
href: PropTypes.oneOfType([PropTypes.string, PropTypes.object]).isRequired,
as: PropTypes.oneOfType([PropTypes.string, PropTypes.object]),
prefetch: PropTypes.bool,
replace: PropTypes.bool,
shallow: PropTypes.bool,
passHref: PropTypes.bool,
scroll: PropTypes.bool,
children: PropTypes.oneOfType([
PropTypes.element,
(props: any, propName) => {
const value = props[propName]
if (typeof value === 'string') {
warn(
`Warning: You're using a string directly inside <Link>. This usage has been deprecated. Please add an <a> tag as child of <Link>`
)
}
return null
},
]).isRequired,
})
}
export default Link