docs(Link): precise how prefetch works (#11792)

* docs(Link): precise how prefetch works After this discussion: https://twitter.com/timneutkens/status/1243572726998188036 This might not be the exact good wording though. Let me know! * Update docs/api-reference/next/link.md Co-Authored-By: Luis Alvarez D. <[email protected]> Co-authored-by: Luis Alvarez D. <[email protected]>
vercel · Apr 15, 2020 · 7d2ee3b · 7d2ee3b
1 parent 90ffdcc
commit 7d2ee3b
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/api-reference/next/link.md b/docs/api-reference/next/link.md
@@ -45,7 +45,7 @@ export default Home
 - `href` - The path inside `pages` directory. This is the only required prop
 - `as` - The path that will be rendered in the browser URL bar. Used for dynamic routes
 - [`passHref`](#forcing-Link-to-expose-href-to-its-child) - Forces `Link` to send the `href` property to its child. Defaults to `false`
-- `prefetch` - Prefetch the page in the background. Defaults to `true`
+- `prefetch` - Prefetch the page in the background. Defaults to `true`. Any `<Link />` that is in the viewport (initially or through scroll) will be preloaded. Pages with data requirements will preload `JSON` files with the data for faster page transitions.
 - [`replace`](#replace-the-url-instead-of-push) - Replace the current `history` state instead of adding a new url into the stack. Defaults to `false`
 - [`scroll`](#disable-scrolling-to-the-top-of-the-page) - Scroll to the top of the page after a navigation. Defaults to `true`