Skip to main content

Interface: TemplateBlock

A content block within a hotspot information template.

This interface represents a single content section within a product hotspot information display. Templates can contain multiple blocks of different types, allowing for rich, multi-format presentations of product information that combine text descriptions, image galleries, and downloadable documents.

Hotspot templates with diverse content blocks enhance product education and highlight key features or specifications without cluttering the main product interface.

Properties​

blockId​

blockId: string

Unique identifier for this block.

This ID is used to reference and manipulate the block in template management operations.

blockName​

blockName: string

Display name for this content block.

This label identifies the block's purpose in editing interfaces and may appear as a section title when the block is rendered.

blockType​

blockType: HotspotBlockType

The type of content in this block.

This determines how the block's content is rendered and what kind of information it contains:

  • TEXT: Formatted text descriptions or explanations
  • GALLERY: Collection of product images
  • DOCUMENT: Downloadable files like specs or manuals

documents?​

optional documents: AssetFile[]

List of document files associated with this block.

Only present when blockType is DOCUMENT. These files can include technical specifications, user manuals, certifications, or other downloadable resources related to the highlighted product feature.

optional gallery: GalleryTabResponse

Image gallery data for this block.

Only present when blockType is GALLERY. This contains the configuration and image list for a visual showcase of the highlighted feature or component.

text?​

optional text: string

Formatted text content for this block.

Only present when blockType is TEXT. This typically contains HTML-formatted descriptive content explaining the feature, its benefits, specifications, usage instructions, or other relevant information.