useHydration API

API reference for the useHydration composable.

Functions

() => E

Creates a new hydration instance.

() => E

(_options?: HydrationContextOptions) => ContextTrinity<E>

Creates a new hydration context trinity.

(_options?: HydrationPluginOptions) => any

Creates a new hydration plugin.

(namespace?: string) => E

Returns the current hydration instance.

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)