useHydration API

API reference for the useHydration composable.

Explore these related pages for additional context and usage patterns.

() => E

Creates a new hydration instance.

() => E

<_E>(_options?: HydrationContextOptions | undefined) => ContextTrinity<_E>

(_options?: HydrationContextOptions | undefined) => Plugin

<_E>(namespace?: string) => _E

Readonly<ShallowRef<boolean>>

True when root component has mounted (hydration complete)

Readonly<ShallowRef<boolean>>

True after first tick post-hydration (safe for animations after state restoration)

() => void

Mark hydration as complete

() => void

Mark as settled (called automatically after nextTick post-hydration)