---
title: CaptionDescriptor
framework: applenewsformat
role: symbol
role_heading: Object
path: applenewsformat/captiondescriptor
---

# CaptionDescriptor

The object you use in image components for displaying captions when the image is full-screen.

## Declaration

```data
object CaptionDescriptor
```

## Properties

text: The text to display in the caption, including any formatting tags or markup, depending on the format property. additions: An array of Link objects that provide additional information for ranges of the caption text in the text property. If you set format to html or markdown, Apple News Format doesnʼt support Additions or InlineTextStyles. format: The formatting or markup method applied to the text. If you set format to html or markdown, Apple News Format doesn’t support Additions or InlineTextStyles. inlineTextStyles: An array of InlineTextStyle objects you apply to ranges of the caption’s text. Apple News Format ignores InlineTextStyles when format is set to html or markdown. textStyle: An inline ComponentTextStyle object that contains styling information, or a string reference to a component text style object that you define at the top level of the document.

## Mentioned in

Using HTML with Apple News Format Using Markdown with Apple News Format

## Discussion

Discussion Use a CaptionDescriptor object to provide a caption or attribution for an image that’s displayed full screen. You can use a caption descriptor with a Figure, Portrait, or Photo component, and also with the individual items in a Gallery or Mosaic component. You can use this object in Figure, Portrait, Photo, and Gallery Item. Example {   "components": [     {       "role": "gallery",       "items": [         {           "URL": "bundle://gallery-01.jpg",           "caption": "Thanks to the record drought, mountain lions have begun to descend from the peaks, sometimes into urban settings."         },         {           "URL": "bundle://gallery-02.jpg",           "caption": "Coyotes are also seen in cities more often."         },         {           "URL": "bundle://gallery-03.jpg",           "caption": {             "text": "<i>Steenbok</i> typically lie low in vegetation cover at the first sign of threat.",             "format": "html"           }         }       ]     }   ] }

## See Also

### Related Documentation

- [Adding an Image and Captions](applenews/adding-an-image-and-captions.md)
- [Adding a Gallery of Images](applenews/adding-a-gallery-of-images.md)
- [Adding a Mosaic of Images](applenews/adding-a-mosaic-of-images.md)

### Images

- [Image](applenewsformat/image.md)
- [Photo](applenewsformat/photo.md)
- [Figure](applenewsformat/figure.md)
- [Portrait](applenewsformat/portrait.md)
- [Logo](applenewsformat/logo.md)
- [ReplicaAdvertisement](applenewsformat/replicaadvertisement.md)