Contents

Image

The component for displaying JPEG, WebP, PNG, or GIF images.

Declaration

object Image

Properties

NameTypeDescription
role Requiredstring

Always image for this component.

URL Requireduri

The URL of an image file.

Image URLs can begin with http://, https://, or bundle://. If the image URL begins with bundle://, the image file must be in the same directory as the document.

Encode image filenames as URLs.

See Preparing Image, Video, Audio, Music, and ARKit Assets.

accessibilityCaptionstring

A caption that describes the image. VoiceOver uses this text. For more information about VoiceOver, see the Vision page in Accessibility. If you don’t provide accessibilityCaption, VoiceOver uses the caption value.

additions[ComponentLink]

An array of ComponentLink objects you can use to create a ComponentLink, allowing a link to anywhere in News.

anchorAnchor

An object that defines vertical alignment with another component.

animation(ComponentAnimation | string("none"))

An object that defines an animation you apply to the component.

Use the none value for conditional design elements. Adding it here has no effect.

behavior(Behavior | string("none"))

An object that defines behavior for a component, like Parallax or Springy.

Use the none value for conditional design elements. Adding it here has no effect.

caption(CaptionDescriptor | string)

A caption that describes the image. The article displays this text when the image is full screen, and VoiceOver uses this text if you don’t provide accessibilityCaption text. For more information about VoiceOver, see the Vision page in Accessibility. The caption text doesn’t appear in the main article view. To display a caption in the main article view, use the Caption component.

conditional(ConditionalComponent | [ConditionalComponent])

An instance or array of component properties that you can apply conditionally, and the conditions that cause Apple News Format to apply them.

explicitContentboolean

A Boolean value that indicates the image may contain explicit content.

hiddenboolean

A Boolean value that determines whether the component is hidden.

identifierstring

An optional unique identifier for this component. If you use identifier, it must be unique across the entire document. You need an identifier for your component if you want to anchor other components to it.

layout(ComponentLayout | string)

An inline ComponentLayout object that contains layout information, or a string reference to a ComponentLayout object that you define at the top level of the document.

If you don’t define layout, size and position are based on various factors, such as the device type, the length of the content, and the role of this component.

style(ComponentStyle | string | string("none"))

An inline ComponentStyle object that defines the appearance of this component, or a string reference to a ComponentStyle object that you define at the top level of the document.

Use the none value for conditional design elements. Adding it here has no effect.

Mentioned in

Discussion

Image is the general component for images in an article. If possible, choose one of the more specific image-related components such as Figure, Logo, Portrait, or Photo.

See Preparing Image, Video, Audio, Music, and ARKit Assets.

Example

{
  "components": [
    {
      "role": "title",
      "text": "Article Title"
    },
    {
      "role": "image",
      "URL": "bundle://summer.jpg",
      "caption": "Thanks to the record drought, mountain lions have begun to descend from the peaks."
    }
  ]
}

See Also

Images