You are here

pager.html.twig in Open Social 8.3

Default theme implementation to display a pager.

Available variables:

  • items: List of pager items. The list is keyed by the following elements:

    • first: Item for the first page; not present on the first page of results.
    • previous: Item for the previous page; not present on the first page of results.
    • next: Item for the next page; not present on the last page of results.
    • last: Item for the last page; not present on the last page of results.
    • pages: List of pages, keyed by page number.

    Sub-sub elements: items.first, items.previous, items.next, items.last, and each item inside items.pages contain the following elements:

    • href: URL with appropriate query parameters for the item.
    • attributes: A keyed list of HTML attributes for the item.
    • text: The visible text used for the item link, such as "‹ previous" or "next ›".
  • current: The page number of the current page.
  • ellipses: If there are more pages than the quantity allows, then an ellipsis before or after the listed pages may be present.

    • previous: Present if the currently visible list of pages does not start at the first page.
    • next: Present if the visible list of pages ends before the last page.

File

themes/socialbase/templates/system/pager.html.twig
View source
  1. {#
  2. /**
  3. * @file
  4. * Default theme implementation to display a pager.
  5. *
  6. * Available variables:
  7. * - items: List of pager items.
  8. * The list is keyed by the following elements:
  9. * - first: Item for the first page; not present on the first page of results.
  10. * - previous: Item for the previous page; not present on the first page
  11. * of results.
  12. * - next: Item for the next page; not present on the last page of results.
  13. * - last: Item for the last page; not present on the last page of results.
  14. * - pages: List of pages, keyed by page number.
  15. * Sub-sub elements:
  16. * items.first, items.previous, items.next, items.last, and each item inside
  17. * items.pages contain the following elements:
  18. * - href: URL with appropriate query parameters for the item.
  19. * - attributes: A keyed list of HTML attributes for the item.
  20. * - text: The visible text used for the item link, such as "‹ previous"
  21. * or "next ›".
  22. * - current: The page number of the current page.
  23. * - ellipses: If there are more pages than the quantity allows, then an
  24. * ellipsis before or after the listed pages may be present.
  25. * - previous: Present if the currently visible list of pages does not start
  26. * at the first page.
  27. * - next: Present if the visible list of pages ends before the last page.
  28. *
  29. * @ingroup templates
  30. *
  31. * @see template_preprocess_pager()
  32. */
  33. #}
  34. {{ attach_library('socialbase/pagination') }}
  35. {% if items %}
  36. <nav class="pager-nav text-center" role="navigation" aria-labelledby="pagination-heading">
  37. <h4 id="pagination-heading" class="visually-hidden">{{ 'Pagination'|t }}</h4>
  38. <ul class="pagination js-pager__items">
  39. {# Print first item if we are not on the first page. #}
  40. {% if items.first %}
  41. <li class="pager__item pager__item--first">
  42. <a href="{{ items.first.href }}" title="{{ 'Go to first page'|t }}" rel="prev"{{ items.first.attributes }}>
  43. <span class="visually-hidden">{{ 'First page'|t }}</span>
  44. <span aria-hidden="true">{{ items.first.text|default('first'|t) }}</span>
  45. </a>
  46. </li>
  47. {% endif %}
  48. {# Print previous item if we are not on the first page. #}
  49. {% if items.previous %}
  50. <li class="pager__item pager__item--previous">
  51. <a href="{{ items.previous.href }}" title="{{ 'Go to previous page'|t }}" rel="prev"{{ items.previous.attributes }}>
  52. <span class="visually-hidden">{{ 'Previous page'|t }}</span>
  53. <span aria-hidden="true">{{ items.previous.text|default('previous'|t) }}</span>
  54. </a>
  55. </li>
  56. {% endif %}
  57. {# Now generate the actual pager piece. #}
  58. {% for key, item in items.pages %}
  59. <li class="pager__item{{ current == key ? ' is-active active' : '' }}">
  60. {% if current == key %}
  61. {% set title = 'Current page'|t %}
  62. {% else %}
  63. {% set title = 'Go to page @key'|t({'@key': key}) %}
  64. {% endif %}
  65. <a href="{{ item.href }}" title="{{ title }}"{{ item.attributes }}>
  66. <span class="visually-hidden">
  67. {{ current == key ? 'Current page'|t : 'Page'|t }}
  68. </span>
  69. {{- key -}}
  70. </a>
  71. </li>
  72. {% endfor %}
  73. {# Print next item if we are not on the last page. #}
  74. {% if items.next %}
  75. <li class="pager__item pager__item--next">
  76. <a href="{{ items.next.href }}" title="{{ 'Go to next page'|t }}" rel="next"{{ items.next.attributes }}>
  77. <span class="visually-hidden">{{ 'Next page'|t }}</span>
  78. <span aria-hidden="true">{{ items.next.text|default('next'|t) }}</span>
  79. </a>
  80. </li>
  81. {% endif %}
  82. {# Print last item if we are not on the last page. #}
  83. {% if items.last %}
  84. <li class="pager__item pager__item--last">
  85. <a href="{{ items.last.href }}" title="{{ 'Go to last page'|t }}" rel="last"{{ items.last.attributes }}>
  86. <span class="visually-hidden">{{ 'Last page'|t }}</span>
  87. <span aria-hidden="true">{{ items.last.text|default('last'|t) }}</span>
  88. </a>
  89. </li>
  90. {% endif %}
  91. </ul>
  92. </nav>
  93. {% endif %}