Document turbo-prefetch meta tags
#174
Open
Conversation
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
* `<meta name="turbo-prefetch" content="false">` will opt-out of InstantClick prefetching for the entire page. * `<meta name="turbo-prefetch-cache-time" content="15000">` configures the time to live in milliseconds for an entry in the InstantClick prefetch cache. When omitted, the default value is 10 seconds. Co-authored-by: Steve Polito <stevepolito@hey.com> Co-authored-by: Stefanni Brasil <stefannibrasil@gmail.com>
MatheusRich
reviewed
Feb 23, 2024
| @@ -43,3 +43,5 @@ The following `meta` elements, added to the `head`, can be used to customize cac | |||
| * `<meta name="view-transition" content="same-origin">` to trigger view transitions on browsers that support the [View Transition API](https://caniuse.com/view-transitions). | |||
| * `<meta name="turbo-refresh-method" content="morph">` will configure [page refreshes with morphing](/handbook/page_refreshes.html). | |||
| * `<meta name="turbo-refresh-scroll" content="preserve">` will enable [scroll preservation during page refreshes](/handbook/page_refreshes.html). | |||
| * `<meta name="turbo-prefetch" content="false">` will [opt-out of InstantClick prefetching](/handbook/drive#instantclick) for the entire page. | |||
| * `<meta name="turbo-prefetch-cache-time" content="15000">` configures the time to live in milliseconds for an entry in the InstantClick prefetch cache. When omitted, the default value is 10 seconds. | |||
There was a problem hiding this comment.
What does entry refer to here in this case? The InstaClick entries for the current page?
If I change this value, does the cache limit change for all the already cached entries, or just the new ones in the current page?
afcapel
reviewed
Mar 25, 2024
| To avoid prefetching links that the user is briefly hovering, Turbo waits 100ms after the user hovers over the link before prefetching it. But you may want to disable the prefetching behavior on certain links leading to pages with expensive rendering. | ||
| To avoid prefetching links that the user is briefly hovering, Turbo waits 100 milliseconds after the user hovers over the link before prefetching it. But you may want to disable the prefetching behavior on certain links leading to pages with expensive rendering. | ||
|
|
||
| By default Turbo will cache requests for 10 seconds. Once that 10 seconds has passed, the value will expire, be cleared from the cache, and a new request will be issued on the next hover. |
There was a problem hiding this comment.
We remove the entry from the cache when the mouse moves away from the link. The 10 seconds TTL is in case you hover the link for more than 10 seconds and then click it. In that case we issue a new request, instead of using the cached one.
Thinking more about it, I don't think the 10 seconds TTL needs to be configured.
What do you think @seanpdoyle ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
<meta name="turbo-prefetch" content="false">will opt-out of InstantClick prefetching for the entire page.<meta name="turbo-prefetch-cache-time" content="15000">configures the time to live in milliseconds for an entry in the InstantClick prefetch cache. When omitted, the default value is 10 seconds.