Merge 6479a91928 into edc299a043

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.github/workflows/ci.yml

@@ -248,7 +248,7 @@ jobs:
           TEST_PAYLOAD: ${{ matrix.payload }}
           SKIP_BUNDLE_SIZE: ${{ github.event_name != 'push' || matrix.env == 'dev' || matrix.builder == 'webpack' || matrix.context == 'default' || matrix.payload == 'js' || runner.os == 'Windows' }}
 
-      - uses: codecov/codecov-action@5c47607acb93fed5485fdbf7232e8a31425f672a # v5.0.2
+      - uses: codecov/codecov-action@985343d70564a82044c1b7fcb84c2fa05405c1a2 # v5.0.4
         if: github.event_name != 'push' && matrix.env == 'built' && matrix.builder == 'vite' && matrix.context == 'default' && matrix.os == 'ubuntu-latest' && matrix.manifest == 'manifest-on'
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

docs/2.guide/2.directory-structure/1.components.md

@@ -123,6 +123,176 @@ const show = ref(false)
 </template>
 ```
 
+## Delayed Hydration
+
+Lazy components are great for controlling the chunk sizes in your app, but they don't enhance runtime performance, as they still load eagerly unless conditionally rendered. In real world applications, some pages may include a lot of content and a lot of components, and most of the time not all of them need to be interactive as soon as the page is loaded. Having them all load eagerly can negatively impact performance and increase bundle size.
+
+In order to optimize the page, you may want to delay the hydration of some components until they're visible, or until the browser is done with more important tasks for example. Delaying the hydration of components will ensure it is only loaded when necessary, which is great for making a good user experience and a performant app. Nuxt has first class support for delayed hydration to help with that, without requiring you to write all the related boilerplate.
+
+In order to use delayed hydration, you first need to enable it in your experimental config in `nuxt.config`
+
+```ts [nuxt.config.{ts,js}]
+export default defineNuxtConfig({
+  experimental: {
+    delayedHydration: true
+  }
+})
+```
+
+Nuxt has reserved component properties that will handle this delayed hydration for you, that extend dynamic imports. By using the `hydrate:visible` prop, Nuxt will automatically handle your component and delay its hydration until it will be on screen.
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent hydrate:visible />
+  </div>
+</template>
+```
+
+If you need the component to load as soon as possible, but not block the critical rendering path, you can use the `hdrate:idle` prop, which would handle your component's hydration whenever the browser goes idle.
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent hydrate:idle />
+  </div>
+</template>
+```
+
+If you would like the component to load after certain events occur, like a click or a mouse over, you can use the `hydrate:event` prop, which would only trigger the hydration when those events occur.
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent hydrate:event />
+  </div>
+</template>
+```
+
+If you would like to load the component when the window matches a media query, you can use the `hydrate:media` prop:
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent hydrate:media />
+  </div>
+</template>
+```
+
+If you would like to never hydrate a component, use the `hydrate:never` prop:
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent hydrate:never />
+  </div>
+</template>
+```
+
+If you would like to hydrate a component after a certain amount of time, use the `hydrate:time` prop:
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent hydrate:time />
+  </div>
+</template>
+```
+
+If you would like to hydrate a component once a promise is fulfilled, use the `hydrate:promise` prefix:
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent hydrate:promise />
+  </div>
+</template>
+```
+
+Nuxt's delayed hydration system is highly flexible, allowing each developer to build upon it and implement their own hydration strategy.
+If you have highly specific hydration triggers that aren't covered by the default strategies, or you want to have conditional hydration, you can use the general purpose `hydrate:if` prop:
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <button @click="myFunction">Click me to start the custom hydration strategy</button>
+    <LazyMyComponent :hydrate:if="myCondition" />
+  </div>
+</template>
+<script setup lang="ts">
+const myCondition = ref(false)
+function myFunction() {
+  // trigger custom hydration strategy...
+  myCondition.value = true
+}
+</script>
+```
+
+### Custom hydration triggers
+
+If you would like to override the default hydration triggers when dealing with delayed hydration, like changing the timeout, the options for the intersection observer, or the events to trigger the hydration, you can do so by supplying a value to the respetive props of your lazy components.
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent :hydrate:idle="3000" />
+    <LazyMyComponent :hydrate:visible="{threshold: 0.2}" />
+    <LazyMyComponent :hydrate:event="['click','mouseover']" />
+    <LazyMyComponent hydrate:media="(max-width: 500px)" />
+    <LazyMyComponent :hydrate:if="someCondition" />
+    <LazyMyComponent :hydrate:time="3000" />
+    <LazyMyComponent :hydrate:promise="promise" />
+  </div>
+</template>
+
+<script setup lang="ts">
+const someCondition = ref(true)
+const promise = Promise.resolve(42)
+</script>
+```
+
+::read-more{to="https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia"}
+Read more about using `LazyMedia` components and the accepted values.
+::
+
+### Listening to hydration events
+
+All delayed hydration components have a `@hydrated` event that is fired whenever they are hydrated. You can listen to this event to trigger some action that depends on the component:
+
+```vue [pages/index.vue]
+<template>
+  <div>
+    <LazyMyComponent hydrate:visible @hydrated="onHydrate" />
+  </div>
+</template>
+
+<script setup lang="ts">
+function onHydrate() {
+  console.log("Component has been hydrated!")
+}
+</script>
+```
+
+### Caveats and best practices
+
+Delayed hydration has many performance benefits, but in order to gain the most out of it, it's important to use it correctly:
+
+1. Avoid delayed hydration components as much as possible for in-viewport content - delayed hydration is best for content that is not immediately available and requires some interaction to get to. If it is present on screen and is meant to be available for use immediately, using it as a normal component would provide better performance and loading times. Use this feature sparingly to avoid hurting the user experience, as there are only a few cases that warrant delayed hydration for on-screen content.
+
+2. Delayed hydration with conditional rendering - when using `v-if` with delayed hydration components, note that `v-if` takes precedence. That means, the component will be hydrated when the `v-if` is truthy, as that will render exclusively on the client. If you need to render the component only when the condition is true, use a regular async component (`<LazyMyComponent />`) with a `v-if`. If you need it to hydrate when the condition is fulfilled, use a delayed hydration prop.
+
+3. Delayed hydration with a shared state - when using multiple components (for example, in a `v-for`) with the same `v-model`, where some components might get hydrated before others (for example, progressively increasing media queries), if one of the components updates the model, note that it will trigger hydration for all components with that same model. That is because Vue's reactivity system triggers an update for all the parts of the app that depend on that state, forcing hydration in the process. Props are unaffected by this. Try to avoid multiple components with the same model if that is not an intended side effect.
+
+4. Use each hydration strategy for its intended use case - each hydration strategy has built-in optimizations specifically designed for that strategy's purpose. Using them incorrectly could hurt performance and user experience. Examples include:
+
+- Using `hydrate:if` for always/never hydrated components (`:hydrate:if="true"`/`:hydrate:if="false"`) - you can use a regular component/`hydrate:never` respectively, which would provide better performance for each use case. Keep `LazyIf` for components that could get hydrated, but might not get hydrated immediately.
+
+- Using `hydrate:time` as an alternative to `hydrate:idle` - while these strategies share similarities, they are meant for different purposes. `hydrate:time` is specifically designed to hydrate a component immediately after a certain amount of time has passed. `hydrate:idle`, on the other hand, is meant to provide a limit for the browser to handle the hydration whenever it's idle. If you use `hydrate:time` for idle-based hydration, the browser might handle the component's hydration while handling other, potentially more important components at the same time. This could slow down the hydration for all components being handled.
+
+- \[ADVANCED\] Using only `hydrate:if` to manually implement existing hydration strategies - while an option, using only `hydrate:if` in stead of relying on the built-in supported strategies could impact the overall memory consumption and performance.
+For example, in stead of handling promises manually and setting a boolean indicator for when the promise was fulfilled, which would then get passed to `hydrate:if`, using `hydrate:promise` directly would handle it without requiring another ref, reducing the complexity and the amount of work Vue's reactivity system would need to handle and track.
+Always remember that while `hydrate:if` allows for implementation of custom, highly-tailored hydration strategies, it should mainly be used when either pure conditional hydration is required (for example, hydration of a component when a separate button is clicked), or when no built-in strategy matches your specific use case, due to the internal optimizations each existing hydration strategy has.
+
 ## Direct Imports
 
 You can also explicitly import components from `#components` if you want or need to bypass Nuxt's auto-importing functionality.

package.json

@@ -91,7 +91,7 @@
     "devalue": "5.1.1",
     "eslint": "9.15.0",
     "eslint-plugin-no-only-tests": "3.3.0",
-    "eslint-plugin-perfectionist": "4.0.2",
+    "eslint-plugin-perfectionist": "4.0.3",
     "eslint-typegen": "0.3.2",
     "h3": "npm:h3-nightly@2.0.0-1718872656.6765a6e",
     "happy-dom": "15.11.6",
@@ -118,7 +118,7 @@
     "vue-router": "4.4.5",
     "vue-tsc": "2.1.10"
   },
-  "packageManager": "pnpm@9.13.2",
+  "packageManager": "pnpm@9.14.1",
   "engines": {
     "node": "^16.10.0 || >=18.0.0"
   },

packages/nuxt/src/app/components/nuxt-link.ts

@@ -481,7 +481,7 @@ type CallbackFn = () => void
 type ObserveFn = (element: Element, callback: CallbackFn) => () => void
 
 function useObserver (): { observe: ObserveFn } | undefined {
-  if (import.meta.server) { return }
+  if (import.meta.server) { return { observe: () => () => {} } }
 
   const nuxtApp = useNuxtApp()
   if (nuxtApp._observer) {
@@ -489,7 +489,6 @@ function useObserver (): { observe: ObserveFn } | undefined {
   }
 
   let observer: IntersectionObserver | null = null
-
   const callbacks = new Map<Element, CallbackFn>()
 
   const observe: ObserveFn = (element, callback) => {

packages/nuxt/src/components/module.ts

@@ -13,6 +13,7 @@ import { ComponentsChunkPlugin, IslandsTransformPlugin } from './plugins/islands
 import { TransformPlugin } from './plugins/transform'
 import { TreeShakeTemplatePlugin } from './plugins/tree-shake'
 import { ComponentNamePlugin } from './plugins/component-names'
+import { DelayedHydrationPlugin } from './plugins/delayed-hydration'
 
 const isPureObjectOrString = (val: any) => (!Array.isArray(val) && typeof val === 'object') || typeof val === 'string'
 const isDirectory = (p: string) => { try { return statSync(p).isDirectory() } catch { return false } }
@@ -223,13 +224,17 @@ export default defineNuxtModule<ComponentsOptions>({
       addBuildPlugin(ClientFallbackAutoIdPlugin({ sourcemap: !!nuxt.options.sourcemap.server, rootDir: nuxt.options.rootDir }), { client: false })
     }
 
+    const clientDelayedComponentRuntime = await findPath(join(distDir, 'components/runtime/client-delayed-component')) ?? join(distDir, 'components/runtime/client-delayed-component')
     const sharedLoaderOptions = {
       getComponents,
       serverComponentRuntime,
       transform: typeof nuxt.options.components === 'object' && !Array.isArray(nuxt.options.components) ? nuxt.options.components.transform : undefined,
       experimentalComponentIslands: !!nuxt.options.experimental.componentIslands,
+      clientDelayedComponentRuntime,
+    }
+    if (nuxt.options.experimental.delayedHydration) {
+      addBuildPlugin(DelayedHydrationPlugin({ sourcemap: !!nuxt.options.sourcemap.server || !!nuxt.options.sourcemap.client }))
     }
-
     addBuildPlugin(LoaderPlugin({ ...sharedLoaderOptions, sourcemap: !!nuxt.options.sourcemap.client, mode: 'client' }), { server: false })
     addBuildPlugin(LoaderPlugin({ ...sharedLoaderOptions, sourcemap: !!nuxt.options.sourcemap.server, mode: 'server' }), { client: false })
 

packages/nuxt/src/components/plugins/delayed-hydration.ts

@@ -0,0 +1,35 @@
+import { createUnplugin } from 'unplugin'
+import { logger } from '@nuxt/kit'
+import MagicString from 'magic-string'
+import { isVue } from '../../core/utils'
+
+export const DelayedHydrationPlugin = (options: { sourcemap: boolean }) => createUnplugin(() => {
+  const DELAYED_HYDRATION_RE = /<(?:Lazy|lazy-)([A-Z]\w*|[\w-]+)\b([^>]+)hydrate:(\w+)(="([^"]+)")?([ />])([^>]*(?:(?<=\/)|>[\s\S]+?<\/Lazy[A-Z]\w*|lazy-[\w-]+))>/g
+  const types = new Map([['time', 'Time'], ['promise', 'Promise'], ['if', 'If'], ['event', 'Event'], ['visible', 'Visible'], ['media', 'Media'], ['never', 'Never'], ['idle', 'Idle']])
+  const correctVals = new Map([['time', 'number'], ['promise', 'Promise'], ['event', 'string | string[]'], ['visible', 'IntersectionObserverInit'], ['media', 'string'], ['idle', 'number']])
+  return {
+    name: 'nuxt:delayed-hydration',
+    enforce: 'pre',
+    transformInclude (id) {
+      return isVue(id)
+    },
+    transform (code, id) {
+      const s = new MagicString(code)
+      s.replace(DELAYED_HYDRATION_RE, (_, comp, pre, type, selfOrValue, val, nearEndChar, post) => {
+        const shouldDefault = type !== 'if' && (val === 'true' || val === 'false')
+        if (!types.has(type)) { logger.warn(`Unexpected hydration strategy \`${type}\` when parsing \`${_}\` in \`${id}\`, this will default to visibility. For custom strategies, please use \`v-hydrate:if\` in stead.`) }
+        if (type === 'never' && selfOrValue) { logger.warn('`hydrate:never` does not accept any value. It is meant to be used as is, and the value will not affect its runtime behavior.') }
+        if (shouldDefault) { logger.warn(`Invalid value \`${val}\` for \`hydrate:${type}\` when parsing \`${_}\` in \`${id}\`. The prop is not meant to be assigned a boolean, but used as is or given ${type === 'never' ? 'no value' : `a value of type \`${correctVals.get(type) ?? 'unknown'}\``}. This will not affect runtime behavior and the defaults will be used in stead.`) }
+        return `<Lazy${types.get(type) ?? 'Visible'}${comp}${pre}${type == 'never' || shouldDefault ? '' : `:hydrate="${val}"`}${nearEndChar}${post}>`
+      })
+      if (s.hasChanged()) {
+        return {
+          code: s.toString(),
+          map: options.sourcemap
+            ? s.generateMap({ hires: true })
+            : undefined,
+        }
+      }
+    },
+  }
+})

packages/nuxt/src/components/plugins/loader.ts

@@ -12,12 +12,13 @@ interface LoaderOptions {
   getComponents (): Component[]
   mode: 'server' | 'client'
   serverComponentRuntime: string
+  clientDelayedComponentRuntime: string
   sourcemap?: boolean
   transform?: ComponentsOptions['transform']
   experimentalComponentIslands?: boolean
 }
 
-const REPLACE_COMPONENT_TO_DIRECT_IMPORT_RE = /(?<=[ (])_?resolveComponent\(\s*["'](lazy-|Lazy(?=[A-Z]))?([^'"]*)["'][^)]*\)/g
+const REPLACE_COMPONENT_TO_DIRECT_IMPORT_RE = /(?<=[ (])_?resolveComponent\(\s*["'](lazy-|Lazy(?=[A-Z]))?(Idle|Visible|idle-|visible-|Event|event-|Media|media-|If|if-|Never|never-|Time|time-|Promise|promise-)?([^'"]*)["'][^)]*\)/g
 export const LoaderPlugin = (options: LoaderOptions) => createUnplugin(() => {
   const exclude = options.transform?.exclude || []
   const include = options.transform?.include || []
@@ -42,12 +43,13 @@ export const LoaderPlugin = (options: LoaderOptions) => createUnplugin(() => {
       const imports = new Set<string>()
       const map = new Map<Component, string>()
       const s = new MagicString(code)
-
       // replace `_resolveComponent("...")` to direct import
-      s.replace(REPLACE_COMPONENT_TO_DIRECT_IMPORT_RE, (full: string, lazy: string, name: string) => {
-        const component = findComponent(components, name, options.mode)
+      s.replace(REPLACE_COMPONENT_TO_DIRECT_IMPORT_RE, (full: string, lazy: string, modifier: string, name: string) => {
+        const normalComponent = findComponent(components, name, options.mode)
+        const modifierComponent = !normalComponent && modifier ? findComponent(components, modifier + name, options.mode) : null
+        const component = normalComponent || modifierComponent
+
         if (component) {
-          // TODO: refactor to nuxi
           const internalInstall = ((component as any)._internal_install) as string
           if (internalInstall && nuxt?.options.test === false) {
             if (!nuxt.options.dev) {
@@ -77,9 +79,63 @@ export const LoaderPlugin = (options: LoaderOptions) => createUnplugin(() => {
           }
 
           if (lazy) {
-            imports.add(genImport('vue', [{ name: 'defineAsyncComponent', as: '__defineAsyncComponent' }]))
-            identifier += '_lazy'
-            imports.add(`const ${identifier} = __defineAsyncComponent(${genDynamicImport(component.filePath, { interopDefault: false })}.then(c => c.${component.export ?? 'default'} || c)${isClientOnly ? '.then(c => createClientOnly(c))' : ''})`)
+            const dynamicImport = `${genDynamicImport(component.filePath, { interopDefault: false })}.then(c => c.${component.export ?? 'default'} || c)`
+            if (modifier && normalComponent && nuxt?.options.experimental.delayedHydration === true) {
+              switch (modifier) {
+                case 'Visible':
+                case 'visible-':
+                  imports.add(genImport(options.clientDelayedComponentRuntime, [{ name: 'createLazyIOComponent' }]))
+                  identifier += '_delayedIO'
+                  imports.add(`const ${identifier} = createLazyIOComponent(${dynamicImport})`)
+                  break
+                case 'Event':
+                case 'event-':
+                  imports.add(genImport(options.clientDelayedComponentRuntime, [{ name: 'createLazyEventComponent' }]))
+                  identifier += '_delayedEvent'
+                  imports.add(`const ${identifier} = createLazyEventComponent(${dynamicImport})`)
+                  break
+                case 'Idle':
+                case 'idle-':
+                  imports.add(genImport(options.clientDelayedComponentRuntime, [{ name: 'createLazyNetworkComponent' }]))
+                  identifier += '_delayedNetwork'
+                  imports.add(`const ${identifier} = createLazyNetworkComponent(${dynamicImport})`)
+                  break
+                case 'Media':
+                case 'media-':
+                  imports.add(genImport(options.clientDelayedComponentRuntime, [{ name: 'createLazyMediaComponent' }]))
+                  identifier += '_delayedMedia'
+                  imports.add(`const ${identifier} = createLazyMediaComponent(${dynamicImport})`)
+                  break
+                case 'If':
+                case 'if-':
+                  imports.add(genImport(options.clientDelayedComponentRuntime, [{ name: 'createLazyIfComponent' }]))
+                  identifier += '_delayedIf'
+                  imports.add(`const ${identifier} = createLazyIfComponent(${dynamicImport})`)
+                  break
+                case 'Never':
+                case 'never-':
+                  imports.add(genImport('vue', [{ name: 'defineAsyncComponent', as: '__defineAsyncComponent' }]))
+                  identifier += '_delayedNever'
+                  imports.add(`const ${identifier} = __defineAsyncComponent({loader: ${dynamicImport}, hydrate: () => {}})`)
+                  break
+                case 'Time':
+                case 'time-':
+                  imports.add(genImport(options.clientDelayedComponentRuntime, [{ name: 'createLazyTimeComponent' }]))
+                  identifier += '_delayedTime'
+                  imports.add(`const ${identifier} = createLazyTimeComponent(${dynamicImport})`)
+                  break
+                case 'Promise':
+                case 'promise-':
+                  imports.add(genImport(options.clientDelayedComponentRuntime, [{ name: 'createLazyPromiseComponent' }]))
+                  identifier += '_delayedPromise'
+                  imports.add(`const ${identifier} = createLazyPromiseComponent(${dynamicImport})`)
+                  break
+              }
+            } else {
+              imports.add(genImport('vue', [{ name: 'defineAsyncComponent', as: '__defineAsyncComponent' }]))
+              identifier += '_lazy'
+              imports.add(`const ${identifier} = __defineAsyncComponent(${dynamicImport}${isClientOnly ? '.then(c => createClientOnly(c))' : ''})`)
+            }
           } else {
             imports.add(genImport(component.filePath, [{ name: component._raw ? 'default' : component.export, as: identifier }]))
 

packages/nuxt/src/components/runtime/client-delayed-component.ts

@@ -0,0 +1,175 @@
+import { defineAsyncComponent, defineComponent, h, hydrateOnIdle, hydrateOnInteraction, hydrateOnMediaQuery, hydrateOnVisible, mergeProps, watch } from 'vue'
+import type { AsyncComponentLoader, HydrationStrategy } from 'vue'
+
+/* @__NO_SIDE_EFFECTS__ */
+export const createLazyIOComponent = (loader: AsyncComponentLoader) => {
+  return defineComponent({
+    inheritAttrs: false,
+    props: {
+      hydrate: {
+        type: Object,
+        required: false,
+      },
+    },
+    emits: ['hydrated'],
+    setup (props, { attrs, emit }) {
+      const hydrated = () => { emit('hydrated') }
+      const comp = defineAsyncComponent({ loader, hydrate: hydrateOnVisible(props.hydrate as IntersectionObserverInit | undefined) })
+      // TODO: fix hydration mismatches on Vue's side. The data-allow-mismatch is ideally a temporary solution due to Vue's SSR limitation with hydrated content.
+      return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+    },
+  })
+}
+
+/* @__NO_SIDE_EFFECTS__ */
+export const createLazyNetworkComponent = (loader: AsyncComponentLoader) => {
+  return defineComponent({
+    inheritAttrs: false,
+    props: {
+      hydrate: {
+        type: Number,
+        required: false,
+      },
+    },
+    emits: ['hydrated'],
+    setup (props, { attrs, emit }) {
+      const hydrated = () => { emit('hydrated') }
+      if (props.hydrate === 0) {
+        const comp = defineAsyncComponent(loader)
+        return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+      }
+      const comp = defineAsyncComponent({ loader, hydrate: hydrateOnIdle(props.hydrate) })
+      // TODO: fix hydration mismatches on Vue's side. The data-allow-mismatch is ideally a temporary solution due to Vue's SSR limitation with hydrated content.
+      return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+    },
+  })
+}
+
+/* @__NO_SIDE_EFFECTS__ */
+export const createLazyEventComponent = (loader: AsyncComponentLoader) => {
+  return defineComponent({
+    inheritAttrs: false,
+    props: {
+      hydrate: {
+        type: [String, Array],
+        required: false,
+        default: 'mouseover',
+      },
+    },
+    emits: ['hydrated'],
+    setup (props, { attrs, emit }) {
+      const hydrated = () => { emit('hydrated') }
+      // @ts-expect-error Cannot type HTMLElementEventMap in props
+      const comp = defineAsyncComponent({ loader, hydrate: hydrateOnInteraction(props.hydrate) })
+      // TODO: fix hydration mismatches on Vue's side. The data-allow-mismatch is ideally a temporary solution due to Vue's SSR limitation with hydrated content.
+      return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+    },
+  })
+}
+
+/* @__NO_SIDE_EFFECTS__ */
+export const createLazyMediaComponent = (loader: AsyncComponentLoader) => {
+  return defineComponent({
+    inheritAttrs: false,
+    props: {
+      hydrate: {
+        type: String,
+        required: false,
+        default: '(min-width: 1px)',
+      },
+    },
+    emits: ['hydrated'],
+    setup (props, { attrs, emit }) {
+      const hydrated = () => { emit('hydrated') }
+      const comp = defineAsyncComponent({ loader, hydrate: hydrateOnMediaQuery(props.hydrate) })
+      // TODO: fix hydration mismatches on Vue's side. The data-allow-mismatch is ideally a temporary solution due to Vue's SSR limitation with hydrated content.
+      return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+    },
+  })
+}
+
+/* @__NO_SIDE_EFFECTS__ */
+export const createLazyIfComponent = (loader: AsyncComponentLoader) => {
+  return defineComponent({
+    inheritAttrs: false,
+    props: {
+      hydrate: {
+        type: Boolean,
+        required: false,
+        default: true,
+      },
+    },
+    emits: ['hydrated'],
+    setup (props, { attrs, emit }) {
+      const hydrated = () => { emit('hydrated') }
+      if (props.hydrate) {
+        const comp = defineAsyncComponent(loader)
+        // TODO: fix hydration mismatches on Vue's side. The data-allow-mismatch is ideally a temporary solution due to Vue's SSR limitation with hydrated content.
+        return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+      }
+      const strategy: HydrationStrategy = (hydrate) => {
+        const unwatch = watch(() => props.hydrate, () => hydrate(), { once: true })
+        return () => unwatch()
+      }
+      const comp = defineAsyncComponent({ loader, hydrate: strategy })
+      return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+    },
+  })
+}
+
+/* @__NO_SIDE_EFFECTS__ */
+export const createLazyTimeComponent = (loader: AsyncComponentLoader) => {
+  return defineComponent({
+    inheritAttrs: false,
+    props: {
+      hydrate: {
+        type: Number,
+        required: false,
+        default: 2000,
+      },
+    },
+    emits: ['hydrated'],
+    setup (props, { attrs, emit }) {
+      const hydrated = () => { emit('hydrated') }
+      if (props.hydrate === 0) {
+        const comp = defineAsyncComponent(loader)
+        return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+      }
+      const strategy: HydrationStrategy = (hydrate) => {
+        const id = setTimeout(hydrate, props.hydrate)
+        return () => clearTimeout(id)
+      }
+      const comp = defineAsyncComponent({ loader, hydrate: strategy })
+      // TODO: fix hydration mismatches on Vue's side. The data-allow-mismatch is ideally a temporary solution due to Vue's SSR limitation with hydrated content.
+      return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+    },
+  })
+}
+
+/* @__NO_SIDE_EFFECTS__ */
+export const createLazyPromiseComponent = (loader: AsyncComponentLoader) => {
+  return defineComponent({
+    inheritAttrs: false,
+    props: {
+      hydrate: {
+        type: Promise,
+        required: false,
+      },
+    },
+    emits: ['hydrated'],
+    setup (props, { attrs, emit }) {
+      const hydrated = () => { emit('hydrated') }
+      if (!props.hydrate) {
+        const comp = defineAsyncComponent(loader)
+        // TODO: fix hydration mismatches on Vue's side. The data-allow-mismatch is ideally a temporary solution due to Vue's SSR limitation with hydrated content.
+        return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+      }
+      const strategy: HydrationStrategy = (hydrate) => {
+        props.hydrate!.then(hydrate)
+        return () => {}
+      }
+      const comp = defineAsyncComponent({ loader, hydrate: strategy })
+      return () => h(comp, mergeProps(attrs, { 'data-allow-mismatch': '', 'onVnodeMounted': hydrated }))
+    },
+  })
+}

packages/nuxt/src/components/templates.ts

@@ -116,14 +116,15 @@ export const componentsTypeTemplate = {
         c.island || c.mode === 'server' ? `IslandComponent<${type}>` : type,
       ]
     })
-
     const islandType = 'type IslandComponent<T extends DefineComponent> = T & DefineComponent<{}, {refresh: () => Promise<void>}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, SlotsType<{ fallback: { error: unknown } }>>'
+    const delayedType = `type TypeWithDefault<T> = boolean | T\ntype HydrationStrategy = "idle" | "event" | "promise" | "if" | "visible" | "time" | "never"\ntype HydrationMap = { idle: number, event: string | string[], promise: Promise<unknown>, if: boolean | unknown, visible: IntersectionObserverInit, time: number, never: boolean }\ntype DelayedComponent<T extends DefineComponent> = T & DefineComponent<{[K in keyof HydrationMap as \`hydrate:$\{K}\`]?: TypeWithDefault<HydrationMap[K]>},{},{},{},{},{},{hydrated: void},{},{},{},{},{},{},{},{hydrate:{}}>`
     return `
 import type { DefineComponent, SlotsType } from 'vue'
 ${nuxt.options.experimental.componentIslands ? islandType : ''}
+${nuxt.options.experimental.delayedHydration ? delayedType : ''}
 interface _GlobalComponents {
   ${componentTypes.map(([pascalName, type]) => `    '${pascalName}': ${type}`).join('\n')}
-  ${componentTypes.map(([pascalName, type]) => `    'Lazy${pascalName}': ${type}`).join('\n')}
+  ${componentTypes.map(([pascalName, type]) => `    'Lazy${pascalName}': DelayedComponent<${type}>`).join('\n')}
 }
 
 declare module 'vue' {
@@ -131,7 +132,7 @@ declare module 'vue' {
 }
 
 ${componentTypes.map(([pascalName, type]) => `export const ${pascalName}: ${type}`).join('\n')}
-${componentTypes.map(([pascalName, type]) => `export const Lazy${pascalName}: ${type}`).join('\n')}
+${componentTypes.map(([pascalName, type]) => `export const Lazy${pascalName}: DelayedComponent<${type}>`).join('\n')}
 
 export const componentNames: string[]
 `

packages/schema/src/config/experimental.ts

@@ -219,6 +219,13 @@ export default defineUntypedSchema({
       },
     },
 
+    /**
+     * Delayed component hydration
+     *
+     * @type {boolean}
+     */
+    delayedHydration: false,
+
     /** Resolve `~`, `~~`, `@` and `@@` aliases located within layers with respect to their layer source and root directories. */
     localLayerAliases: true,
 

pnpm-lock.yaml

@@ -114,8 +114,8 @@ importers:
         specifier: 3.3.0
         version: 3.3.0
       eslint-plugin-perfectionist:
-        specifier: 4.0.2
-        version: 4.0.2(eslint@9.15.0(jiti@2.4.0))(typescript@5.6.3)
+        specifier: 4.0.3
+        version: 4.0.3(eslint@9.15.0(jiti@2.4.0))(typescript@5.6.3)
       eslint-typegen:
         specifier: 0.3.2
         version: 0.3.2(eslint@9.15.0(jiti@2.4.0))
@@ -4373,8 +4373,8 @@ packages:
     resolution: {integrity: sha512-brcKcxGnISN2CcVhXJ/kEQlNa0MEfGRtwKtWA16SkqXHKitaKIMrfemJKLKX1YqDU5C/5JY3PvZXd5jEW04e0Q==}
     engines: {node: '>=5.0.0'}
 
-  eslint-plugin-perfectionist@4.0.2:
-    resolution: {integrity: sha512-zWdgyg2SdHqhp/P9d9vKwo5qD9is28xMAGzBslHqkZz5mVIikjyz1qvuJ4yS7Wrsf4KlbGorORefb4Kbe7Puzg==}
+  eslint-plugin-perfectionist@4.0.3:
+    resolution: {integrity: sha512-CyafnreF6boy4lf1XaF72U8NbkwrfjU/mOf1y6doaDMS9zGXhUU1DSk+ZPf/rVwCf1PL1m+rhHqFs+IcB8kDmA==}
     engines: {node: ^18.0.0 || >=20.0.0}
     peerDependencies:
       eslint: '>=8.0.0'
@@ -11519,7 +11519,7 @@ snapshots:
 
   eslint-plugin-no-only-tests@3.3.0: {}
 
-  eslint-plugin-perfectionist@4.0.2(eslint@9.15.0(jiti@2.4.0))(typescript@5.6.3):
+  eslint-plugin-perfectionist@4.0.3(eslint@9.15.0(jiti@2.4.0))(typescript@5.6.3):
     dependencies:
       '@typescript-eslint/types': 8.15.0
       '@typescript-eslint/utils': 8.15.0(eslint@9.15.0(jiti@2.4.0))(typescript@5.6.3)

test/basic.test.ts

@@ -2808,6 +2808,80 @@ describe('lazy import components', () => {
   it('lazy load named component with mode server', () => {
     expect(html).toContain('lazy-named-comp-server')
   })
+
+  it('lazy load delayed hydration comps at the right time', async () => {
+    expect(html).toContain('This should be visible at first with network!')
+    const { page } = await renderPage('/lazy-import-components')
+    await page.waitForLoadState('networkidle')
+    expect(await page.locator('body').getByText('This shouldn\'t be visible at first with network!').all()).toHaveLength(1)
+    expect(await page.locator('body').getByText('This should be visible at first with viewport!').all()).toHaveLength(1)
+    expect(await page.locator('body').getByText('This should be visible at first with events!').all()).toHaveLength(2)
+    // The default value is immediately truthy, however, there is a hydration mismatch without the hack
+    expect(await page.locator('body').getByText('This should be visible at first with conditions!').all()).toHaveLength(1)
+    const component = page.locator('#lazyevent')
+    const rect = (await component.boundingBox())!
+    await page.mouse.move(rect.x + rect.width / 2, rect.y + rect.height / 2)
+    await page.waitForLoadState('networkidle')
+    expect(await page.locator('body').getByText('This shouldn\'t be visible at first with events!').all()).toHaveLength(1)
+    await page.locator('#conditionbutton').click()
+    await page.waitForLoadState('networkidle')
+    expect(await page.locator('body').getByText('This shouldn\'t be visible at first with conditions!').all()).toHaveLength(2)
+    await page.evaluate(() => window.scrollTo(0, document.body.scrollHeight))
+    await page.waitForTimeout(300) // Wait for the intersection observer to fire the callback
+    expect(await page.locator('body').getByText('This shouldn\'t be visible at first with viewport!').all()).toHaveLength(2)
+    expect(await page.locator('body').getByText('This should always be visible!').all()).toHaveLength(1)
+    await page.close()
+  })
+
+  it('respects custom delayed hydration triggers and overrides defaults', async () => {
+    const { page } = await renderPage('/lazy-import-components')
+    await page.waitForLoadState('networkidle')
+    const component = page.locator('#lazyevent2')
+    const rect = (await component.boundingBox())!
+    await page.mouse.move(rect.x + rect.width / 2, rect.y + rect.height / 2)
+    await page.waitForTimeout(500)
+    await page.waitForLoadState('networkidle')
+    expect(await page.locator('body').getByText('This should be visible at first with events!').all()).toHaveLength(2)
+    await page.locator('#lazyevent2').click()
+    await page.waitForLoadState('networkidle')
+    expect(await page.locator('body').getByText('This should be visible at first with events!').all()).toHaveLength(1)
+    expect(await page.locator('body').getByText('This shouldn\'t be visible at first with events!').all()).toHaveLength(1)
+    await page.close()
+  })
+  it('does not delay hydration of components named after modifiers', async () => {
+    const { page } = await renderPage('/lazy-import-components')
+    expect(await page.locator('body').getByText('This fake lazy event should be visible!').all()).toHaveLength(1)
+    expect(await page.locator('body').getByText('This fake lazy event shouldn\'t be visible!').all()).toHaveLength(0)
+  })
+  it('handles time-based hydration correctly', async () => {
+    const { page } = await renderPage('/lazy-import-components/time')
+    expect(await page.locator('body').getByText('This should be visible at first with time!').all()).toHaveLength(2)
+    await page.waitForTimeout(500)
+    expect(await page.locator('body').getByText('This should be visible at first with time!').all()).toHaveLength(1)
+    await page.waitForTimeout(1600) // Some room for falkiness and intermittent lag
+    expect(await page.locator('body').getByText('This should be visible at first with time!').all()).toHaveLength(0)
+  })
+  it('handles promise-based hydration correctly', async () => {
+    const { page } = await renderPage('/lazy-import-components/promise')
+    expect(await page.locator('body').getByText('This should be visible at first with promise!').all()).toHaveLength(1)
+    await page.waitForTimeout(2100) // Some room for falkiness and intermittent lag
+    expect(await page.locator('body').getByText('This should be visible at first with promise!').all()).toHaveLength(0)
+  })
+  it('keeps reactivity with models', async () => {
+    const { page } = await renderPage('/lazy-import-components/model-event')
+    expect(await page.locator('#count').textContent()).toBe('0')
+    for (let i = 0; i < 10; i++) {
+      expect(await page.locator('#count').textContent()).toBe(`${i}`)
+      await page.locator('#inc').click()
+    }
+    expect(await page.locator('#count').textContent()).toBe('10')
+  })
+  it('emits hydration events', async () => {
+    const { page, consoleLogs } = await renderPage('/lazy-import-components/model-event')
+    expect(consoleLogs.some(log => log.type === 'log' && log.text === 'Component hydrated')).toBeFalsy()
+    await page.locator('#count').click()
+    expect(consoleLogs.some(log => log.type === 'log' && log.text === 'Component hydrated')).toBeTruthy()
+  })
 })
 
 describe('defineNuxtComponent watch duplicate', () => {

test/fixtures/basic/components/DelayedCondition.client.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This shouldn't be visible at first with conditions!
+  </div>
+</template>

test/fixtures/basic/components/DelayedCondition.server.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This should be visible at first with conditions!
+  </div>
+</template>

test/fixtures/basic/components/DelayedEvent.client.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This shouldn't be visible at first with events!
+  </div>
+</template>

test/fixtures/basic/components/DelayedEvent.server.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This should be visible at first with events!
+  </div>
+</template>

test/fixtures/basic/components/DelayedModel.vue

@@ -0,0 +1,15 @@
+<template>
+  <div>
+    <span id="count">{{ model }}</span>
+    <button
+      id="inc"
+      @click="model++"
+    >
+      Increment
+    </button>
+  </div>
+</template>
+
+<script setup lang="ts">
+const model = defineModel()
+</script>

test/fixtures/basic/components/DelayedNetwork.client.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This shouldn't be visible at first with network!
+  </div>
+</template>

test/fixtures/basic/components/DelayedNetwork.server.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This should be visible at first with network!
+  </div>
+</template>

test/fixtures/basic/components/DelayedNever.client.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This should never be visible!
+  </div>
+</template>

test/fixtures/basic/components/DelayedNever.server.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This should always be visible!
+  </div>
+</template>

test/fixtures/basic/components/DelayedPromise.client.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This shouldn't be visible at first with promise!
+  </div>
+</template>

test/fixtures/basic/components/DelayedPromise.server.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This should be visible at first with promise!
+  </div>
+</template>

test/fixtures/basic/components/DelayedTime.client.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This shouldn't be visible at first with time!
+  </div>
+</template>

test/fixtures/basic/components/DelayedTime.server.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This should be visible at first with time!
+  </div>
+</template>

test/fixtures/basic/components/DelayedVisible.client.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This shouldn't be visible at first with viewport!
+  </div>
+</template>

test/fixtures/basic/components/DelayedVisible.server.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This should be visible at first with viewport!
+  </div>
+</template>

test/fixtures/basic/components/EventView.client.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This fake lazy event should be visible!
+  </div>
+</template>

test/fixtures/basic/components/EventView.server.vue

@@ -0,0 +1,5 @@
+<template>
+  <div>
+    This fake lazy event shouldn't be visible!
+  </div>
+</template>

test/fixtures/basic/nuxt.config.ts

@@ -172,6 +172,7 @@ export default defineNuxtConfig({
     renderJsonPayloads: process.env.TEST_PAYLOAD !== 'js',
     headNext: true,
     inlineRouteRules: true,
+    delayedHydration: true,
   },
   compatibilityDate: '2024-06-28',
   nitro: {

test/fixtures/basic/pages/lazy-import-components/index.vue

@@ -3,5 +3,37 @@
     <LazyNCompAll message="lazy-named-comp-all" />
     <LazyNCompClient message="lazy-named-comp-client" />
     <LazyNCompServer message="lazy-named-comp-server" />
+    <LazyDelayedEvent
+      id="lazyevent"
+      hydrate:event
+    />
+    <LazyEventView />
+    <LazyDelayedVisible hydrate:visible />
+    <LazyDelayedNever hydrate:never />
+    <LazyDelayedEvent
+      id="lazyevent2"
+      :hydrate:event="['click']"
+    />
+    <LazyDelayedCondition
+      id="lazycondition"
+      hydrate:if
+    />
+    <button
+      id="conditionbutton"
+      @click="state++"
+    />
+    <LazyDelayedCondition
+      id="lazycondition2"
+      :hydrate:if="state > 1"
+    />
+    <LazyDelayedNetwork hydrate:idle />
+    <div style="height:3000px">
+      This is a very tall div
+    </div>
+    <LazyDelayedVisible hydrate:visible />
   </div>
 </template>
+
+<script setup lang="ts">
+const state = useState('delayedHydrationCondition', () => 1)
+</script>

test/fixtures/basic/pages/lazy-import-components/model-event.vue

@@ -0,0 +1,16 @@
+<template>
+  <div>
+    <LazyDelayedModel
+      v-model="model"
+      hydrate:event
+      @hydrated="log"
+    />
+  </div>
+</template>
+
+<script setup lang="ts">
+const model = ref(0)
+function log () {
+  console.log('Component hydrated')
+}
+</script>

test/fixtures/basic/pages/lazy-import-components/promise.vue

@@ -0,0 +1,15 @@
+<script setup lang="ts">
+const pr = new Promise((resolve) => { setTimeout(resolve, 500) })
+const prImmediate = Promise.resolve(42)
+</script>
+
+<template>
+  <div>
+    <LazyDelayedPromise
+      :hydrate:promise="pr"
+    />
+    <LazyDelayedPromise
+      :hydrate:promise="prImmediate"
+    />
+  </div>
+</template>

test/fixtures/basic/pages/lazy-import-components/time.vue

@@ -0,0 +1,8 @@
+<template>
+  <div>
+    <LazyDelayedTime hydrate:time />
+    <LazyDelayedTime
+      :hydrate:time="500"
+    />
+  </div>
+</template>