ComponentLink
The component addition object for making a component interactive and opening a link to another location in News.
Declaration
object ComponentLinkProperties
| Name | Type | Description |
|---|---|---|
URL Required | SupportedInternalURLs | The URL to open when someone interacts with the component. |
type Required | string | The type of addition. Use |
Discussion
Use the ComponentLink object to define a link for a component by specifying the URL. Apple News ignores links that it can’t resolve to a valid entity.
You can use this object 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"
}
]
}
]
}