[11.x] Allow prefetch to start on custom event

[timacdonald]

In my initial design of the asset prefetching feature, I included a delay before prefetching started. I removed the delay to simplify the design in the final version.

Having not yet documented the feature, an initial delay has already being requested. I can see the advantage of having control of this.

Instead of introducing an arbitrary delay or configurable delay, I've instead opted for a configurable event name that triggers prefetching.

This allows for a custom delay or more dynamic prefetching control, e.g., start after an initial request.

// Service provider...

use Illuminate\Support\Facades\Vite;

Vite::prefetch(
    concurrency: 3,
    event: 'vite:prefetch',
]);

then...

<script>
    // prefetch Vite assets 1 second after the load event...

    addEventListener('load', () => {
        setTimeout(() => dispatchEvent(new Event('vite:prefetch')), 1000)
    })
</script>

or ...

<script>
    // prefetch Vite assets after downloading the user's profile information...

    const profile = await axios.get('/me').then(() => dispatchEvent(new Event('vite:prefetch'))
    
    // ...
</script>

[github-actions]

Thanks for submitting a PR!

Note that draft PR's are not reviewed. If you would like a review, please mark your pull request as ready for review in the GitHub user interface.

Pull requests that are abandoned in draft may be closed due to inactivity.