Component

The role of a component (for example, title, body, or pullquote) conveys the semantic value of the content or its function within the article.

The value of the role property is simply the role name; it doesn’t include the actual content that the role describes. For example, a role with the value pullquote describes a text component whose value is the actual pull quote text.

A role can have design significance: Apple News Format derives styling and layout from it. VoiceOver also uses the role to make Apple News content more accessible.

For a list of valid component types, see Components.

An object that defines vertical alignment with another component.

An object that defines an animation the component applies.

Use the none value for conditional design elements. Adding it here has no effect.

An object that defines behavior for a component, like Parallax or Springy.

Use the none value for conditional design elements. Adding it here has no effect.

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

A Boolean value that determines whether the component is hidden.

A unique identifier for this component. If you use identifier, it must be unique across the entire document. Apple News Format requires an identifier if you want to anchor other components to this component.

An inline ComponentLayout object that contains layout information, or a string reference to a ComponentLayout you define at the top level of the document.

If you don’t define layout, Apple News Format bases the size and position on various factors, such as the device type, the length of the content, and the role of this component.

An inline ComponentStyle object that defines the appearance of this component, or a string reference to a ComponentStyle that you define at the top level of the document.

Use the none value for conditional design elements. Adding it here has no effect.