Components

Prefetch

GitHub

A Stimulus controller that prefetch in-viewport links.

If you have Turbo >=8 enabled in your app, you don't need this component because it's now a built-in feature.

Installation

  1. Install the package

    Terminal
    $ yarn add @stimulus-components/prefetch

  2. Register the controller in your application

    app/javascript/controllers/index.js
    import { Application } from '@hotwired/stimulus'
import Prefetch from '@stimulus-components/prefetch'

const application = Application.start()
application.register('prefetch', Prefetch)

Usage

app/views/index.html
<a href="/about" data-controller="prefetch">About</a>.

Note: To improve performance, links will only be prefetched if they are in the viewport and if the user isn't on a slow connection.

Extending Controller

You can use inheritance to extend the functionality of any Stimulus component:

app/javascript/controllers/prefetch_controller.js
import Prefetch from "@stimulus-components/prefetch"

export default class extends Prefetch {
  connect() {
    super.connect()
    console.log("Do what you want here.")
  }
}

This controller will automatically have access to targets defined in the parent class.

If you override the connect, disconnect or any other methods from the parent, you'll want to call super.method() to make sure the parent functionality is executed.