Skip to main content

ui:hydrationData

Declare arbitrarily hydration data that should be exposed to the client.

This ViewHelper allows you to define hydration data for like for a component that will be sent to the client for hydration purposes. The data is registered in the same registry and with the same structure as for component hydration data, so it can be consumed by the same hydration mechanisms.

See Hydration Guide for more information about how hydration data is used.

Example:

<ui:hydrationData name="some-block" props="{someProp: 'someValue', anotherProp: 123}" />

Arguments

Name Type Description Required Default
name string The name under which the hydration data should be exposed Yes null
id string An optional identifier for the hydration data. If not provided, a unique id will be generated. No null
props mixed The props/data to expose to the client Yes null
controlled boolean Whether the hydration data is for a controlled component No false