Skip to main content

Caption


The Caption element displays brief labels or indicators within the interface. It typically accompanies other content types such as message groups or status lines. Captions support plain text and icon pairing. Use captions for annotations, alerts, or contextual hints where space is limited.

Properties

PropertyValueDescription
TypeCaptionUI component type
GroupTextBelongs to the "Text" group in UI catalog
Identifier3Unique element ID
PreviewSee image preview above
Text, IconYSupports optional icon alongside text
MaxLinesSupports line constraints (e.g., truncation rules)

Usage Example

<Caption label="New messages" />

SDK Integration

This element appears in the User Chat interface.

Method: /messages/user-chat

Used to label dividers between older and unread messages.


Example UI Placement

LevelReferenceTypeValuePlacement
2new-messageCaptionNew messagesAbove divider in chat view

Notes

  • Used to enhance clarity in chat threads.
  • Often paired with Line or Spacer elements.
  • Does not trigger events or validation.