ComponentRef
ComponentRef
A reference that includes persisted reusable component content. A ComponentRef may be authored wherever its containing contract permits a component reference. The referenced component is expanded once: persisted components may not contain another ComponentRef, including direct or indirect self-references.
Authoring guidance
Use when
Use when the same section or element group should appear
in multiple places, such as shared endcaps, disclosures, navigation
blocks, or calls to action.
Avoid when
The content is unique to one page or belongs globally in the site header/footer.
Properties
component
string
Key or source path of a non-nested persisted Component.
type
string
Identifies the Element type represented by this object.
"component"
Example
Required
{
"component": "example",
"type": "component"
}
Full
{
"component": "example",
"type": "component"
}
examples are generated from the schema.