links.html.twig

Same filename in this branch
  1. 8.9.x core/themes/stable/templates/navigation/links.html.twig
  2. 8.9.x core/themes/classy/templates/navigation/links.html.twig
Same filename in other branches
  1. 9 core/themes/olivero/templates/navigation/links.html.twig
  2. 9 core/themes/stable9/templates/navigation/links.html.twig
  3. 9 core/themes/stable/templates/navigation/links.html.twig
  4. 9 core/themes/starterkit_theme/templates/navigation/links.html.twig
  5. 9 core/themes/classy/templates/navigation/links.html.twig
  6. 9 core/modules/system/templates/links.html.twig
  7. 10 core/themes/olivero/templates/navigation/links.html.twig
  8. 10 core/themes/stable9/templates/navigation/links.html.twig
  9. 10 core/themes/starterkit_theme/templates/navigation/links.html.twig
  10. 10 core/modules/system/templates/links.html.twig
  11. 11.x core/themes/olivero/templates/navigation/links.html.twig
  12. 11.x core/themes/stable9/templates/navigation/links.html.twig
  13. 11.x core/themes/starterkit_theme/templates/navigation/links.html.twig
  14. 11.x core/modules/system/templates/links.html.twig

Default theme implementation for a set of links.

Available variables:

  • attributes: Attributes for the UL containing the list of links.
  • links: Links to be output. Each link will have the following elements:

    • link: (optional) A render array that returns a link. See template_preprocess_links() for details how it is generated.
    • text: The link text.
    • attributes: HTML attributes for the list item element.
    • text_attributes: (optional) HTML attributes for the span element if no 'url' was supplied.
  • heading: (optional) A heading to precede the links.
    • text: The heading text.
    • level: The heading level (e.g. 'h2', 'h3').
    • attributes: (optional) A keyed list of attributes for the heading.

    If the heading is a string, it will be used as the text of the heading and the level will default to 'h2'.

Headings should be used on navigation menus and any list of links that consistently appears on multiple pages. To make the heading invisible use the 'visually-hidden' CSS class. Do not use 'display:none', which removes it from screen readers and assistive technology. Headings allow screen reader and keyboard only users to navigate to or skip the links. See http://juicystudio.com/article/screen-readers-display-none.php and http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.

See also

template_preprocess_links()

32 theme calls to links.html.twig
AjaxTestController::dialog in core/modules/system/tests/modules/ajax_test/src/Controller/AjaxTestController.php
Returns a render array of form elements and links for dialog.
AjaxTestController::insertLinksBlockWrapper in core/modules/system/tests/modules/ajax_test/src/Controller/AjaxTestController.php
Returns a render array of links that directly Drupal.ajax().
AjaxTestController::insertLinksInlineWrapper in core/modules/system/tests/modules/ajax_test/src/Controller/AjaxTestController.php
Returns a render array of links that directly Drupal.ajax().
book_node_links_alter in core/modules/book/book.module
Implements hook_node_links_alter().
ChooseBlockController::getBlockLinks in core/modules/layout_builder/src/Controller/ChooseBlockController.php
Gets a render array of block links.

... See full list

File

core/modules/system/templates/links.html.twig

View source
  1. {#
  2. /**
  3. * @file
  4. * Default theme implementation for a set of links.
  5. *
  6. * Available variables:
  7. * - attributes: Attributes for the UL containing the list of links.
  8. * - links: Links to be output.
  9. * Each link will have the following elements:
  10. * - link: (optional) A render array that returns a link. See
  11. * template_preprocess_links() for details how it is generated.
  12. * - text: The link text.
  13. * - attributes: HTML attributes for the list item element.
  14. * - text_attributes: (optional) HTML attributes for the span element if no
  15. * 'url' was supplied.
  16. * - heading: (optional) A heading to precede the links.
  17. * - text: The heading text.
  18. * - level: The heading level (e.g. 'h2', 'h3').
  19. * - attributes: (optional) A keyed list of attributes for the heading.
  20. * If the heading is a string, it will be used as the text of the heading and
  21. * the level will default to 'h2'.
  22. *
  23. * Headings should be used on navigation menus and any list of links that
  24. * consistently appears on multiple pages. To make the heading invisible use
  25. * the 'visually-hidden' CSS class. Do not use 'display:none', which
  26. * removes it from screen readers and assistive technology. Headings allow
  27. * screen reader and keyboard only users to navigate to or skip the links.
  28. * See http://juicystudio.com/article/screen-readers-display-none.php and
  29. * http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
  30. *
  31. * @see template_preprocess_links()
  32. *
  33. * @ingroup themeable
  34. */
  35. #}
  36. {% if links -%}
  37. {%- if heading -%}
  38. {%- if heading.level -%}
  39. <{{ heading.level }}{{ heading.attributes }}>{{ heading.text }}</{{ heading.level }}>
  40. {%- else -%}
  41. <h2{{ heading.attributes }}>{{ heading.text }}</h2>
  42. {%- endif -%}
  43. {%- endif -%}
  44. <ul{{ attributes }}>
  45. {%- for item in links -%}
  46. <li{{ item.attributes }}>
  47. {%- if item.link -%}
  48. {{ item.link }}
  49. {%- elseif item.text_attributes -%}
  50. <span{{ item.text_attributes }}>{{ item.text }}</span>
  51. {%- else -%}
  52. {{ item.text }}
  53. {%- endif -%}
  54. </li>
  55. {%- endfor -%}
  56. </ul>
  57. {%- endif %}

Related topics


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