Object

ArticleLink

The container component for creating a link to an article.

Properties

articleIdentifier
SupportedArticleIdentifier
string
(Required)

The shareable URL or CloudKit ID of an article that is navigated to, and that is used as the default title and thumbnail.

role
string
(Required)

Always article_link for this component.

additions

An array of ComponentLink objects. additions is automatically added to the ArticleLink container. Any link additions defined here or in any of the child components (ArticleTitle and ArticleThumbnail) have no effect.

anchor

An object that defines vertical alignment with another component.

animation
*

An object that defines an animation to be applied to the component.

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

behavior
*

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

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

conditional
*

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

contentDisplay
*

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

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

hidden
boolean

A Boolean value that determines whether the component is hidden.

identifier
string

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. See Anchor.

layout
*

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
*

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.

Discussion

Use the ArticleLink component to link a user to the article specified using the articleIdentifier property. Use ArticleThumbnail and ArticleTitle as child components instead of Image or Text to provide semantic value to the linked article. You can use these components to provide content, styling, and layout, like you do with any other Apple News Format component. Apple News automatically populates the content based on nested child elements. A ComponentAddition is automatically added to the component to allow the user to navigate to the referenced article.

Example

{ "components": [ { "role": "article_link", "articleIdentifier": "https://apple.news/AT6kNQslCQy6EE4bF8hpOoQ", "components": [ { "role": "article_thumbnail", "aspectRatio": 1, "fillMode": "cover", "verticalAlignment": "top" }, { "role": "article_title" } ] } ]}

Relationships

Inherits From

See Also

Article Structure

Nesting Components in an Article

Use container components to create the component hierarchies you need for special article designs.

Adding a Scene to a Chapter or a Section Header

Add a scene to your article to create special effects.

Creating an Article Link

Link to an article by using the article-linking container component.

Displaying Components Side By Side

Configure a side-by-side, horizontal arrangement of components for your article.

object Header

The component for defining the top area of an article, chapter, or section.

object Container

Properties shared by all container types.

object Section

The component for organizing an article into sections.

object Chapter

The component for organizing an article into chapters.

object Aside

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

object CollectionDisplay

An object used in any container component type to define how the collection of child components is presented.

object HorizontalStackDisplay

The object for displaying components side by side in a Container component.

object FlexibleSpacer

The component for redistributing empty space inside a horizontal stack collection.

object Divider

The component for defining a horizontal line to visually divide parts of your article.

type SupportedArticleIdentifier

The patterns supported for article identifiers in UUID format.

object ArticleTitle

The component for displaying an article title in the ArticleLink component.

object ArticleThumbnail

The component for displaying a thumbnail image with an article link.

object LinkButton

The component for opening a link in a button.