useLazy API

API reference for the useLazy composable.

Explore these related pages for additional context and usage patterns.

Page	Category
useLazy	System
usePresence	System
useToggleScope	System
useIntersectionObserver	System

Functions

useLazy

(active: MaybeRefOrGetter<boolean>, options?: LazyOptions) => LazyContext

Deferred content rendering for performance optimization.

Options

eager

MaybeRefOrGetter<boolean> | undefined

When true, content renders immediately without waiting for activation.

Default: false

delay

number | undefined

Delay in milliseconds before activation. Prevents flash on quick hover-throughs by requiring the active state to persist for this duration before booting content.

Default: 0

Properties

isBooted

Readonly<ShallowRef<boolean>>

Whether the lazy content has been activated at least once.

hasContent

Readonly<Ref<boolean, boolean>>

Whether content should be rendered. True when: isBooted OR eager OR active

Methods

reset

() => void

Reset booted state. Call on leave transition if not eager.

onAfterLeave

() => void

Transition callback for after-leave. Resets if not eager.