You are here

book-tree.html.twig in Drupal 10

Theme override to display a book tree.

Returns HTML for a wrapper for a book sub-tree.

Available variables:

  • items: A nested list of book items. Each book item contains:

    • attributes: HTML attributes for the book item.
    • below: The book item child items.
    • title: The book link title.
    • url: The book link URL, instance of \Drupal\Core\Url.
    • is_expanded: TRUE if the link has visible children within the current book tree.
    • is_collapsed: TRUE if the link has children within the current book tree that are not currently visible.
    • in_active_trail: TRUE if the link is in the active trail.

File

core/themes/stable/templates/navigation/book-tree.html.twig
View source
  1. {#
  2. /**
  3. * @file
  4. * Theme override to display a book tree.
  5. *
  6. * Returns HTML for a wrapper for a book sub-tree.
  7. *
  8. * Available variables:
  9. * - items: A nested list of book items. Each book item contains:
  10. * - attributes: HTML attributes for the book item.
  11. * - below: The book item child items.
  12. * - title: The book link title.
  13. * - url: The book link URL, instance of \Drupal\Core\Url.
  14. * - is_expanded: TRUE if the link has visible children within the current
  15. * book tree.
  16. * - is_collapsed: TRUE if the link has children within the current book tree
  17. * that are not currently visible.
  18. * - in_active_trail: TRUE if the link is in the active trail.
  19. */
  20. #}
  21. {% import _self as book_tree %}
  22. {#
  23. We call a macro which calls itself to render the full tree.
  24. @see https://twig.symfony.com/doc/3.x/tags/macro.html
  25. #}
  26. {{ book_tree.book_links(items, attributes, 0) }}
  27. {% macro book_links(items, attributes, menu_level) %}
  28. {% import _self as book_tree %}
  29. {% if items %}
  30. {% if menu_level == 0 %}
  31. <ul{{ attributes }}>
  32. {% else %}
  33. <ul>
  34. {% endif %}
  35. {% for item in items %}
  36. <li{{ item.attributes }}>
  37. {{ link(item.title, item.url) }}
  38. {% if item.below %}
  39. {{ book_tree.book_links(item.below, attributes, menu_level + 1) }}
  40. {% endif %}
  41. </li>
  42. {% endfor %}
  43. </ul>
  44. {% endif %}
  45. {% endmacro %}