Guides and Sample Code

Developer

Apple News Format: Design Tutorial

On This Page

Components

In Apple News Format, a component is an object that’s located inside an array named components. Components typically hold your article’s content, like body text, headings, or photo URLs; they also have some other uses, which we’ll address in Apple News Format: Advanced Design Tutorial.

With some exceptions that are covered in Apple News Format: Advanced Design Tutorial, such as anchors, the order of components in a components array determines the order of the content in the article.

You’ll place some components in the top-level components array of the article.

Component Roles

Every component has a property named role that conveys the component’s semantic value and function in the article. For example, a role of body tells News that this component is a body component—and therefore that it determines the body text of the article. A body component can have article body text and text styles as its properties. Similarly, a role of photo tells News that this is a photo component—and therefore that it determines one of the images in the article. A photo component can have an image URL as one of its properties.

If you ever need a list of valid values for the role property, you can refer to Component Role Summary in the Apple News Format Reference.

JSON Example: Components

In this example, you add fifteen components to the top-level components array.

In the example code below, HTML is used to format text inside body components. If an HTML body component contains only one paragraph, the <p> tags may be omitted.

Example Code

  1. {
  2. "title": "Article Title",
  3. "metadata": {
  4. "thumbnailURL": "bundle://header.jpg",
  5. "excerpt": "Quia consequuntur magni accusantium doloremque eos qui ratione voluptatem sequi nesciunt?"
  6. },
  7. "version": "1.5",
  8. "identifier": "testArticle",
  9. "language": "en",
  10. "layout": {
  11. "columns": 10,
  12. "width": 1024,
  13. "margin": 85,
  14. "gutter": 20
  15. },
  16. "documentStyle": {
  17. "backgroundColor": "#F5F9FB"
  18. },
  19. "components": [
  20. {
  21. "role": "heading1",
  22. "text": "HEADING"
  23. },
  24. {
  25. "role": "title",
  26. "text": "ARTICLE TITLE"
  27. },
  28. {
  29. "role": "intro",
  30. "text": "Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque ipsum?"
  31. },
  32. {
  33. "role": "byline",
  34. "text": "By Urna Semper"
  35. },
  36. {
  37. "role": "body",
  38. "format": "html",
  39. "text": "<p>Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, dolor repellendus. <a href='http://www.apple.com'>Link text</a> quibusdam et aut.</p><p>Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, adipisci velit.</p>"
  40. },
  41. {
  42. "role": "heading2",
  43. "text": "HEADING"
  44. },
  45. {
  46. "role": "body",
  47. "format": "html",
  48. "text": "<p>Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio ducimus qui blanditiis.</p><p>Cras ultricies mi eu turpis hendrerit fringilla. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; In ac dui quis mi consectetuer.</p><p>Temporibus autem et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque rerum hic tenetur.</p><p>Inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo esciunt enim ipsam voluptatem quia.</p><p>Ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis <a href='http://www.apple.com'>link text</a> repellat. Sed ut perspiciatis unde omnis iste natus sit voluptatem accusantium doloremque, totam rem aperiam, eaque ipsa quae ab illo inventore.</p><p>Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni.</p>"
  49. },
  50. {
  51. "role": "heading2",
  52. "text": "HEADING"
  53. },
  54. {
  55. "role": "body",
  56. "format": "html",
  57. "text": "Sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas."
  58. },
  59. {
  60. "role": "heading2",
  61. "text": "HEADING"
  62. },
  63. {
  64. "role": "body",
  65. "format": "html",
  66. "text": "Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas est, omnis dolor repellendus."
  67. },
  68. {
  69. "role": "heading2",
  70. "text": "HEADING"
  71. },
  72. {
  73. "role": "body",
  74. "format": "html",
  75. "text": "<p>Consequatur aut doloribus asperiores repellat. Sed ut perspiciatis unde omnis iste natus error sit volup tatem accusantium doloremque laudantium, totam rem, eaque ipsa quae ab illo inventore veritatis et quasi archit ecto beatae vitae.</p><p>Nemo enim ipsam volup tatem quia voluptas sit aspernatur aut odit aut fugit, sed quia conse quuntur magni. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam.</p><p>Consequatur aut perferendis doloribus asperiores repellat. Sed ut perspiciatis unde omnis iste natus error sit volup tatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi archit ecto beatae vitae dicta. Nemo enim ipsam volup tatem quia voluptas sit <a href='http://www.apple.com'>link text</a> aut odit aut fugit, sed quia conse quuntur perspiciatis doloribus magni dolores.</p><p>Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam suscipit laboriosam.</p>"
  76. },
  77. {
  78. "role": "heading2",
  79. "text": "HEADING"
  80. },
  81. {
  82. "role": "body",
  83. "format": "html",
  84. "text": "Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio. Dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati."
  85. }
  86. ],
  87. "textStyles": {},
  88. "componentLayouts": {},
  89. "componentStyles": {},
  90. "componentTextStyles": {}
  91. }