Contents

Aside

The component for setting apart content that is not directly related to the article, such as promotional content.

Declaration

object Aside

Properties

NameTypeDescription
role Requiredstring

Always aside for this component.

additions[ComponentLink]

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

You can add a link to a Container component to make the entire component tappable. Any links used in its child components are not interactable.

allowAutoplacedAdsboolean

A Boolean value that allows the placement of ad banners between components. Nested components inherit the value of the outermost container that explicitly sets allowAutoplacedAds. The default value is false.

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.

The none value is used for conditional design elements. Adding it here has no effect.

components[Component]

An array of components to display as child components. Child components are positioned and rendered relative to their parent component.

conditional(ConditionalContainer | [ConditionalContainer])

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

contentDisplay(CollectionDisplay | HorizontalStackDisplay | string("none"))

An object that defines how to position child components within this aside component. A HorizontalStackDisplay, for example, allows for displaying child components side by side.

In versions of News prior to iOS 11, child components are positioned as if contentDisplay were not defined.

The none value is used for conditional design elements. Adding it here has no effect.

hiddenboolean

A Boolean value that determines whether the component is hidden.

identifierstring

An optional unique identifier for this component. If used, this identifier must be unique across the entire document. You will 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 is defined at the top level of the document.

If layout is not defined, 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 is defined at the top level of the document.

The none value is used for conditional design elements. Adding it here has no effect.

Mentioned in

Discussion

Use an aside component to hold information not directly related to your article. Use an aside to help Siri make the most informed content recommendations to people using Apple News and to provide better accuracy for placing your content within feeds, such as the Today feed, channel feeds, and topic feeds.

When News recommends content, it ignores any content in the aside component, so you can put content there that is not directly related to the article, such as promotional content, links to other articles, or author biographies.

Example

{
  "components": [
    {
      "role": "aside",
      "components": [
        {
          "role": "body",
          "text": "<a href=\"https://www.apple.com/newsroom/2017/06/swift-playgrounds-expands-coding-education-to-robots-drones-and-musical-instruments/\">Swift Playgrounds expands coding education to robots, drones and musical instruments</a>",
          "format": "html"
        }
      ]
    }
  ]
}

See Also

Related Documentation

Article Structure