file links.html.twig

Theme override 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:
    • title: The link text.
    • href: The link URL. If omitted, the 'title' is shown as a plain text item in the links list. If 'href' is supplied, the entire link is passed to l() as its $options parameter.
    • attributes: (optional) HTML attributes for the anchor, or for the tag if no 'href' is supplied.
    • link_key: The link CSS class.
  • 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()
Source
  1. {#
  2. /**
  3. * @file
  4. * Theme override 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. * - title: The link text.
  11. * - href: The link URL. If omitted, the 'title' is shown as a plain text
  12. * item in the links list. If 'href' is supplied, the entire link is passed
  13. * to l() as its $options parameter.
  14. * - attributes: (optional) HTML attributes for the anchor, or for the <span>
  15. * tag if no 'href' is supplied.
  16. * - link_key: The link CSS class.
  17. * - heading: (optional) A heading to precede the links.
  18. * - text: The heading text.
  19. * - level: The heading level (e.g. 'h2', 'h3').
  20. * - attributes: (optional) A keyed list of attributes for the heading.
  21. * If the heading is a string, it will be used as the text of the heading and
  22. * the level will default to 'h2'.
  23. *
  24. * Headings should be used on navigation menus and any list of links that
  25. * consistently appears on multiple pages. To make the heading invisible use
  26. * the 'visually-hidden' CSS class. Do not use 'display:none', which
  27. * removes it from screen readers and assistive technology. Headings allow
  28. * screen reader and keyboard only users to navigate to or skip the links.
  29. * See http://juicystudio.com/article/screen-readers-display-none.php and
  30. * http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
  31. *
  32. * @ingroup templates
  33. *
  34. * @see template_preprocess_links()
  35. */
  36. #}
  37. {% if links -%}
  38. {%- if heading -%}
  39. {%- if heading.level -%}
  40. <{{ heading.level }}{{ heading.attributes }}>{{ heading.text }}</{{ heading.level }}>
  41. {%- else -%}
  42. <h2{{ heading.attributes }}>{{ heading.text }}</h2>
  43. {%- endif -%}
  44. {%- endif -%}
  45. {%- if attributes.hasClass('inline') -%}
  46. <ul{{ attributes.addClass('list-inline') }}>
  47. {%- else -%}
  48. <ul{{ attributes }}>
  49. {%- endif -%}
  50. {%- for key, item in links -%}
  51. <li{{ item.attributes.addClass(key|clean_class) }}>
  52. {%- if item.link -%}
  53. {{ item.link }}
  54. {%- elseif item.text_attributes -%}
  55. <span{{ item.text_attributes }}>{{ item.text }}</span>
  56. {%- else -%}
  57. {{ item.text }}
  58. {%- endif -%}
  59. </li>
  60. {%- endfor -%}
  61. </ul>
  62. {%- endif %}

Related topics