Object

ComponentLink

The component addition object for making a component interactive and opening a link to another location in News.

Properties

(Required)

The URL to open when a user interacts with the component.

type
string
(Required)

The type of addition. Use link.

Discussion

Use the ComponentLink object to define a link for a component by specifying the URL. Links that cannot be resolved to a valid entity are ignored.

This object can be used in Aside, Chapter, Container, Logo, Image, and Section.

Example

{ "components": [ { "role": "image", "URL": "bundle://image.jpg", "additions": [ { "type": "link", "URL": "https://apple.news/TqT-jfrI0QXaYqGoz68HYeQ" } ] } ]}

Relationships

Inherits From

See Also

Links

object LinkAddition

The addition object for defining links in text components that don’t use HTML or Markdown formatting.

object Addition

Properties shared by all addition types.

object ComponentAddition

Properties shared by all types of component additions.

type SupportedURLs

Links that go to Apple News, other Apple apps, and external sites.

type SupportedInternalURLs

Links that go to Apple News and other Apple apps.