The component for displaying an article title in the ArticleLink component.
Technology
- Apple News Format 1.9+
Properties
role
string
Always article
for this object.
additions
[Addition]
Ignored for all children of ArticleLink.
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
*
conditional
*
An instance or array of text properties that can be applied conditionally, and the conditions that cause them to be applied.
format
string
The formatting or markup method applied to the text.
Valid values:
html
. See Using HTML with Apple News Format.markdown
. See Using Markdown with Apple News Format.none
(default). Styles (inline
andText Styles) additions
need to be defined to create links or change text styling for ranges of text.
Inline styling and additions with ranges (using inline
and additions
properties) are only supported when forma
t is none
.
hidden
boolean
A Boolean value that determines whether the component is hidden.
identifier
string
A unique identifier for this component. If used, the identifier must be unique across the entire document. An identifier is required if you want to anchor other components to this component. See Anchor.
inline Text Styles
*
An array of Inline
objects you can use to apply different text styles to ranges of text. For each Inline
object, supply range
and range
values, and either a TextStyle object or the identifier of a text style that is defined at the top level of the document.
Inline text styles are ignored when the format
is set to markdown
or html
.
The none
value is used for conditional design elements. Adding it here has no effect.
layout
*
Either an inline Component
object that contains layout information, or a string reference to a Component
object that is defined at the top level of the document.
If layou
t 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 Component
object that defines the appearance of this component, or a string reference to a Component
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.
text
string
The text, styled according to the text
definition. You can also use a subset of HTML syntax by setting format
to html
. See Using HTML with Apple News Format.
text Style
*
An inline Component
object that contains styling information, or a string reference to a Component
object that is defined at the top level of the document.
Discussion
Use the Article
object to display the title of the linked article. Article
is used in combination with the ArticleLink component and is used by VoiceOver for iOS and VoiceOver for macOS to make content more accessible.
Example
{
"components": [
{
"role": "article_link",
"articleIdentifier": "https://apple.news/AT6kNQslCQy6EE4bF8hpOoQ",
"components": [
{
"role": "article_thumbnail",
"aspectRatio": 1,
"fillMode": "cover",
"verticalAlignment": "top"
},
{
"role": "article_title"
}
]
}
]
}