Nostalgic Punchcard Missing
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

flying-pages

2.0.6 • Public • Published

Flying Pages

Flying Pages preload pages before the user click on it, making them load instantly

Quick Links

Buy Me A Coffee

Usage

Quickstart:

<script src="flying-pages.min.js"></script>
<script>
  flyingPages();
</script> 

With async/defer (recommended):

<script defer src="flying-pages.min.js"></script>
<script>
  window.addEventListener("load", () => {
    flyingPages();
  });
</script> 

With options:

<script defer src="flying-pages.min.js"></script>
<script>
  window.addEventListener("load", () => {
    flyingPages({
      delay: 0,
      ignoreKeywords: [],
      maxRPS: 3,
      hoverDelay: 50
    });
  });
</script> 

flyingPages accepts optional options object with the following parameters:

  • delay: Start prefetching after a delay (in seconds). Will be started when the browser becomes idle, using requestIdleCallback. Default to 0.
  • ignoreKeywords: An array of keywords to ignore from prefetching. Example ['/logout','/cart','about.html','sample.png','#'].
  • maxRPS: Maximum requests per second the queue should process. Set to 0 to process all requests immediately (without queue). Default to 3.
  • hoverDelay: Delay in prefetching links on mouse hover (in milliseconds). Default 50.

How it Works?

Flying Pages injects a tiny JavaScript code (1KB gzipped), waits until the browser becomes idle. Then it detects pages in the viewport and on mouse hover and preloads them.

Flying Pages is intelligent to make sure preloading doesn't crash your server or make it slow.

  • Preload pages in the viewport - Detect links within the viewport (current viewing area) using 'Intersection Observer' and tells the browser to preload them using 'prefetch', switch to xhr if not available (similar to Quicklink).

  • Preload pages on mouse hover - On hovering links, if it's not preloaded yet using above 'viewport', then Flying Pages will prefetch them instantly (similar to Instant page).

  • Limits the number of preloads per second - If your page has too many links, prefetching all at the same time will cause the server to crash or slow down the website to visitors. Flying Pages limits the number of preloads per second (3 req/sec by default) using an in-built queue. For example, if you've 10 links in the viewport, preloading all these are span into 4 seconds.

  • Stops preloading if the server is busy - In case the server starts to respond slowly or return errors, preloading will be stopped to reduce the server load.

  • Understands user's connection and preferences - Checks if the user is on a slow connection like 2G or has enabled data-saver. Flying Pages won't preload anything in this case.

Install

npm i flying-pages

DownloadsWeekly Downloads

1

Version

2.0.6

License

ISC

Unpacked Size

231 kB

Total Files

5

Last publish

Collaborators

  • avatar