node--teaser.html.twig

Same filename in other branches
  1. 9 core/themes/olivero/templates/content/node--teaser.html.twig
  2. 10 core/themes/olivero/templates/content/node--teaser.html.twig

Olivero's theme implementation to display a node teaser.

Available variables:

  • node: The node entity with limited access to object properties and methods. Only method names starting with "get", "has", or "is" and a few common methods such as "id", "label", and "bundle" are available. For example:

    • node.getCreatedTime() will return the node creation timestamp.
    • node.hasField('field_example') returns TRUE if the node bundle includes field_example. (This does not indicate the presence of a value in this field.)
    • node.isPublished() will return whether the node is published or not.

    Calling other methods, such as node.delete(), will result in an exception. See \Drupal\node\Entity\Node for a full list of public properties and methods for the node object.

  • label: (optional) The title of the node.
  • content: All node items. Use {{ content }} to print them all, or print a subset such as {{ content.field_example }}. Use {{ content|without('field_example') }} to temporarily suppress the printing of a given child element.
  • author_picture: The node author user entity, rendered using the "compact" view mode.
  • date: (optional) Themed creation date field.
  • author_name: (optional) Themed author name field.
  • url: Direct URL of the current node.
  • display_submitted: Whether submission information should be displayed.
  • attributes: HTML attributes for the containing element. The attributes.class element may contain one or more of the following classes:

    • node: The current template type (also known as a "theming hook").
    • node--type-[type]: The current node type. For example, if the node is an "Article" it would result in "node--type-article". Note that the machine name will often be in a short form of the human readable label.
    • node--view-mode-[view_mode]: The View Mode of the node; for example, a teaser would result in: "node--view-mode-teaser", and full: "node--view-mode-full".

    The following are controlled through the node publishing options.

    • node--promoted: Appears on nodes promoted to the front page.
    • node--sticky: Appears on nodes ordered above other non-sticky nodes in teaser listings.
    • node--unpublished: Appears on unpublished nodes visible only to site admins.
  • title_attributes: Same as attributes, except applied to the main title tag that appears in the template.
  • content_attributes: Same as attributes, except applied to the main content tag that appears in the template.
  • author_attributes: Same as attributes, except applied to the author of the node tag that appears in the template.
  • title_prefix: Additional output populated by modules, intended to be displayed in front of the main title tag that appears in the template.
  • title_suffix: Additional output populated by modules, intended to be displayed after the main title tag that appears in the template.
  • view_mode: View mode; for example, "teaser" or "full".
  • teaser: Flag for the teaser state. Will be true if view_mode is 'teaser'.
  • page: Flag for the full page state. Will be true if view_mode is 'full'.

See also

template_preprocess_node()

File

core/themes/olivero/templates/content/node--teaser.html.twig

View source
  1. {#
  2. /**
  3. * @file
  4. * Olivero's theme implementation to display a node teaser.
  5. *
  6. * Available variables:
  7. * - node: The node entity with limited access to object properties and methods.
  8. * Only method names starting with "get", "has", or "is" and a few common
  9. * methods such as "id", "label", and "bundle" are available. For example:
  10. * - node.getCreatedTime() will return the node creation timestamp.
  11. * - node.hasField('field_example') returns TRUE if the node bundle includes
  12. * field_example. (This does not indicate the presence of a value in this
  13. * field.)
  14. * - node.isPublished() will return whether the node is published or not.
  15. * Calling other methods, such as node.delete(), will result in an exception.
  16. * See \Drupal\node\Entity\Node for a full list of public properties and
  17. * methods for the node object.
  18. * - label: (optional) The title of the node.
  19. * - content: All node items. Use {{ content }} to print them all,
  20. * or print a subset such as {{ content.field_example }}. Use
  21. * {{ content|without('field_example') }} to temporarily suppress the printing
  22. * of a given child element.
  23. * - author_picture: The node author user entity, rendered using the "compact"
  24. * view mode.
  25. * - date: (optional) Themed creation date field.
  26. * - author_name: (optional) Themed author name field.
  27. * - url: Direct URL of the current node.
  28. * - display_submitted: Whether submission information should be displayed.
  29. * - attributes: HTML attributes for the containing element.
  30. * The attributes.class element may contain one or more of the following
  31. * classes:
  32. * - node: The current template type (also known as a "theming hook").
  33. * - node--type-[type]: The current node type. For example, if the node is an
  34. * "Article" it would result in "node--type-article". Note that the machine
  35. * name will often be in a short form of the human readable label.
  36. * - node--view-mode-[view_mode]: The View Mode of the node; for example, a
  37. * teaser would result in: "node--view-mode-teaser", and
  38. * full: "node--view-mode-full".
  39. * The following are controlled through the node publishing options.
  40. * - node--promoted: Appears on nodes promoted to the front page.
  41. * - node--sticky: Appears on nodes ordered above other non-sticky nodes in
  42. * teaser listings.
  43. * - node--unpublished: Appears on unpublished nodes visible only to site
  44. * admins.
  45. * - title_attributes: Same as attributes, except applied to the main title
  46. * tag that appears in the template.
  47. * - content_attributes: Same as attributes, except applied to the main
  48. * content tag that appears in the template.
  49. * - author_attributes: Same as attributes, except applied to the author of
  50. * the node tag that appears in the template.
  51. * - title_prefix: Additional output populated by modules, intended to be
  52. * displayed in front of the main title tag that appears in the template.
  53. * - title_suffix: Additional output populated by modules, intended to be
  54. * displayed after the main title tag that appears in the template.
  55. * - view_mode: View mode; for example, "teaser" or "full".
  56. * - teaser: Flag for the teaser state. Will be true if view_mode is 'teaser'.
  57. * - page: Flag for the full page state. Will be true if view_mode is 'full'.
  58. *
  59. * @see template_preprocess_node()
  60. */
  61. #}
  62. {%
  63. set classes = [
  64. 'node',
  65. 'node--type-' ~ node.bundle|clean_class,
  66. node.isPromoted() ? 'node--promoted',
  67. node.isSticky() ? 'node--sticky',
  68. not node.isPublished() ? 'node--unpublished',
  69. view_mode ? 'node--view-mode-' ~ view_mode|clean_class,
  70. ]
  71. %}
  72. {% embed "olivero:teaser" with {
  73. attributes: attributes.addClass(classes),
  74. author_attributes,
  75. author_name,
  76. content,
  77. date,
  78. display_submitted,
  79. label,
  80. metadata,
  81. title_attributes,
  82. title_prefix,
  83. title_suffix,
  84. read_more,
  85. url,
  86. } only %}
  87. {% block prefix %}
  88. {{ title_prefix }}
  89. {{ title_suffix }}
  90. {% endblock %}
  91. {% block meta %}
  92. {% if display_submitted %}
  93. <div class="node__meta">
  94. <span{{ author_attributes }}>
  95. {{ 'By'|t }} {% apply spaceless %}<span class="node__author">{{ author_name }}</span>{% endapply %}, {{ date }}
  96. </span>
  97. {{ metadata }}
  98. </div>
  99. {% endif %}
  100. {% endblock %}
  101. {% block image %}{{~ content.field_image ~}}{% endblock %}
  102. {% block title %}
  103. {% if label and not page %}
  104. <h2{{ title_attributes.addClass('node__title', 'teaser__title') }}>
  105. <a href="{{ url }}" rel="bookmark">{{ label }}</a>
  106. </h2>
  107. {% endif %}
  108. {% endblock %}
  109. {% block content %}
  110. {{ content|without('field_image', 'links') }}
  111. {% endblock %}
  112. {% endembed %}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.