Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2025-02-12 03:38:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Delete docs/3.api/3.utils/create-idle-loader.md

Browse Source
This commit is contained in:
Michael Brevard 2024-10-09 10:29:38 +03:00 committed by GitHub
parent 352d47c644
commit 725727f397
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 0 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/3.api/3.utils/create-idle-loader.md
View File

@ -1,33 +0,0 @@
---
title: 'createIdleLoader'
description: A utility function to customize delayed hydration based on network idle time.
links:
- label: Source
icon: i-simple-icons-github
to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/hydrate.ts
size: xs
---
You can use this utility to customize the timeout of delayed hydration components based on network idle time.
## Parameters
- `timeout` : `number`
## Example
If you would like to give a timeout of 5 seconds for the components:
```vue [pages/index.vue]
<template>
<div>
<LazyIdleMyComponent :hydrate="createIdleLoader(5000)"/>
</div>
<template>
```
::read-more{to="/docs/guide/directory-structure/components#delayed-hydration"}
::
::read-more{to="https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback"}
This is based on the `requestIdleCallback` web API, and therefore only accepts the time in milliseconds for the max idle callback duration, which should be a number.
::