Object

Quote

The component for including a quote.

Properties

role
string
(Required)

Always quote for this component.

text
string
(Required)

The text to display in the article, including any formatting tags depending on the format property.

You can also use a subset of HTML tags or Markdown syntax by setting format to html or markdown, respectively. See Using HTML with Apple News Format. Alternatively, you can style ranges of text individually using the InlineTextStyle object.

additions

An array of all the additions that should be applied to ranges of the component's text.

Additions are ignored when format is set to html or markdown.

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.

conditional
*

An instance or array of text components 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.

If format is set to html or markdown, neither Additions nor InlineTextStyles are supported.

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.

inlineTextStyles
*

An array of InlineTextStyle objects that you can use to apply different text styles to ranges of text. For each InlineTextStyle, you should supply a rangeStart, rangeLength, and either a TextStyle object or the identifier of a TextStyle that is defined at the top level of the document.

Inline text styles are ignored when format is set to markdown or html.

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

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.

textStyle
*

An inline ComponentTextStyle object that contains styling information, or a string reference to a ComponentTextStyle object that is defined at the top level of the document.

Discussion

Use the Quote component to indicate the text of a quotation. A quote is a unique portion of text, while a pull quote duplicates a selection of text.

Example

{ "components": [ { "role": "chapter", "components": [ { "role": "quote", "text": "Failure is not an option." } ] } ]}

Relationships

Inherits From

See Also

Text

Using HTML with Apple News Format

Use HTML formatting for text components.

Using Markdown with Apple News Format

Use Markdown formatting for text components.

object Body

The component for adding body text.

object Title

The component for adding an article title.

object Heading

The text component for adding a heading.

object Intro

The component for adding introductory text.

object Caption

The component for adding caption text.

object Author

The component for adding the name of the author.

object Byline

The component for adding contributor credits, especially for articles with multiple contributors.

object Illustrator

The component for adding illustrator credit.

object Photographer

The component for adding a photographer credit.

object PullQuote

The component for including a pull quote.

object Text

Properties shared by all text component types.