Contents

Instagram

The component for adding an Instagram post.

Declaration

object Instagram

Properties

NameTypeDescription
role Requiredstring

Always instagram for this component.

URL Requireduri

The URL of the Instagram post you want to embed.

Apple News supports the following URL formats for Instagram posts:

  • https://www.instagram.com/p/{media-shortcode}

  • https://www.instagram.com/tv/{media-shortcode}

  • https://www.instagram.com/reel/{media-shortcode}

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.

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.

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.

Discussion

Use the instagram object to include an Instagram post by specifying a URL for the post.

Example

{
  "components": [
    {
      "role": "title",
      "text": "iTunes"
    },
    {
      "role": "body",
      "text": "iTunes is the best way to organize and enjoy the music, movies, and TV shows you already have — and shop for the ones you want."
    },
    {
      "role": "heading2",
      "text": "Instagram"
    },
    {
      "role": "instagram",
      "URL": "https://www.instagram.com/p/BpiRTBYlkY5/"
    }
  ]
}

See Also

Social Media