table.html.twig

Same filename in this branch
  1. 8.9.x core/profiles/demo_umami/themes/umami/templates/classy/dataset/table.html.twig
  2. 8.9.x core/themes/seven/templates/classy/dataset/table.html.twig
  3. 8.9.x core/themes/claro/templates/classy/dataset/table.html.twig
  4. 8.9.x core/themes/bartik/templates/classy/dataset/table.html.twig
  5. 8.9.x core/themes/stable/templates/dataset/table.html.twig
  6. 8.9.x core/modules/system/templates/table.html.twig
Same filename and directory in other branches
  1. 9 core/profiles/demo_umami/themes/umami/templates/classy/dataset/table.html.twig
  2. 9 core/themes/stable9/templates/dataset/table.html.twig
  3. 9 core/themes/seven/templates/classy/dataset/table.html.twig
  4. 9 core/themes/claro/templates/classy/dataset/table.html.twig
  5. 9 core/themes/bartik/templates/classy/dataset/table.html.twig
  6. 9 core/themes/stable/templates/dataset/table.html.twig
  7. 9 core/themes/starterkit_theme/templates/dataset/table.html.twig
  8. 9 core/themes/classy/templates/dataset/table.html.twig
  9. 9 core/modules/system/templates/table.html.twig
  10. 10 core/profiles/demo_umami/themes/umami/templates/classy/dataset/table.html.twig
  11. 10 core/themes/stable9/templates/dataset/table.html.twig
  12. 10 core/themes/claro/templates/classy/dataset/table.html.twig
  13. 10 core/themes/starterkit_theme/templates/dataset/table.html.twig
  14. 10 core/modules/system/templates/table.html.twig
  15. 11.x core/profiles/demo_umami/themes/umami/templates/classy/dataset/table.html.twig
  16. 11.x core/themes/stable9/templates/dataset/table.html.twig
  17. 11.x core/themes/claro/templates/classy/dataset/table.html.twig
  18. 11.x core/themes/starterkit_theme/templates/dataset/table.html.twig
  19. 11.x core/modules/system/templates/table.html.twig

Theme override to display a table.

Available variables:

  • attributes: HTML attributes to apply to the <table> tag.
  • caption: A localized string for the <caption> tag.
  • colgroups: Column groups. Each group contains the following properties:
  • header: Table header cells. Each cell contains the following properties:
    • tag: The HTML tag name to use; either 'th' or 'td'.
    • attributes: HTML attributes to apply to the tag.
    • content: A localized string for the title of the column.
    • field: Field name (required for column sorting).
    • sort: Default sort order for this column ("asc" or "desc").
  • sticky: A flag indicating whether to use a "sticky" table header.
  • rows: Table rows. Each row contains the following properties:
    • attributes: HTML attributes to apply to the <tr> tag.
    • data: Table cells.
    • no_striping: A flag indicating that the row should receive no 'even / odd' styling. Defaults to FALSE.
    • cells: Table cells of the row. Each cell contains the following keys:
      • tag: The HTML tag name to use; either 'th' or 'td'.
      • attributes: Any HTML attributes, such as "colspan", to apply to the table cell.
      • content: The string to display in the table cell.
      • active_table_sort: A boolean indicating whether the cell is the active table sort.
  • footer: Table footer rows, in the same format as the rows variable.
  • empty: The message to display in an extra row if table does not have any rows.
  • no_striping: A boolean indicating that the row should receive no striping.
  • header_columns: The number of columns in the header.

See also

template_preprocess_table()

9 theme calls to table.html.twig
ContentTranslationController::overview in core/modules/content_translation/src/Controller/ContentTranslationController.php
Builds the translations overview page.
MenuForm::buildOverviewForm in core/modules/menu_ui/src/MenuForm.php
Form constructor to edit an entire menu tree at once.
NodeController::revisionOverview in core/modules/node/src/Controller/NodeController.php
Generates an overview table of older revisions of a node.
PagerTestController::buildTestTable in core/modules/system/tests/modules/pager_test/src/Controller/PagerTestController.php
Builds a render array for a pageable test table.
Table::getInfo in core/lib/Drupal/Core/Render/Element/Table.php
Returns the element properties for this element.

... See full list

File

core/themes/classy/templates/dataset/table.html.twig

View source
  1. {#
  2. /**
  3. * @file
  4. * Theme override to display a table.
  5. *
  6. * Available variables:
  7. * - attributes: HTML attributes to apply to the <table> tag.
  8. * - caption: A localized string for the <caption> tag.
  9. * - colgroups: Column groups. Each group contains the following properties:
  10. * - attributes: HTML attributes to apply to the <col> tag.
  11. * Note: Drupal currently supports only one table header row, see
  12. * https://www.drupal.org/node/893530 and
  13. * http://api.drupal.org/api/drupal/includes!theme.inc/function/theme_table/7#comment-5109.
  14. * - header: Table header cells. Each cell contains the following properties:
  15. * - tag: The HTML tag name to use; either 'th' or 'td'.
  16. * - attributes: HTML attributes to apply to the tag.
  17. * - content: A localized string for the title of the column.
  18. * - field: Field name (required for column sorting).
  19. * - sort: Default sort order for this column ("asc" or "desc").
  20. * - sticky: A flag indicating whether to use a "sticky" table header.
  21. * - rows: Table rows. Each row contains the following properties:
  22. * - attributes: HTML attributes to apply to the <tr> tag.
  23. * - data: Table cells.
  24. * - no_striping: A flag indicating that the row should receive no
  25. * 'even / odd' styling. Defaults to FALSE.
  26. * - cells: Table cells of the row. Each cell contains the following keys:
  27. * - tag: The HTML tag name to use; either 'th' or 'td'.
  28. * - attributes: Any HTML attributes, such as "colspan", to apply to the
  29. * table cell.
  30. * - content: The string to display in the table cell.
  31. * - active_table_sort: A boolean indicating whether the cell is the active
  32. table sort.
  33. * - footer: Table footer rows, in the same format as the rows variable.
  34. * - empty: The message to display in an extra row if table does not have
  35. * any rows.
  36. * - no_striping: A boolean indicating that the row should receive no striping.
  37. * - header_columns: The number of columns in the header.
  38. *
  39. * @see template_preprocess_table()
  40. */
  41. #}
  42. <table{{ attributes }}>
  43. {% if caption %}
  44. <caption>{{ caption }}</caption>
  45. {% endif %}
  46. {% for colgroup in colgroups %}
  47. {% if colgroup.cols %}
  48. <colgroup{{ colgroup.attributes }}>
  49. {% for col in colgroup.cols %}
  50. <col{{ col.attributes }} />
  51. {% endfor %}
  52. </colgroup>
  53. {% else %}
  54. <colgroup{{ colgroup.attributes }} />
  55. {% endif %}
  56. {% endfor %}
  57. {% if header %}
  58. <thead>
  59. <tr>
  60. {% for cell in header %}
  61. {%
  62. set cell_classes = [
  63. cell.active_table_sort ? 'is-active',
  64. ]
  65. %}
  66. <{{ cell.tag }}{{ cell.attributes.addClass(cell_classes) }}>
  67. {{- cell.content -}}
  68. </{{ cell.tag }}>
  69. {% endfor %}
  70. </tr>
  71. </thead>
  72. {% endif %}
  73. {% if rows %}
  74. <tbody>
  75. {% for row in rows %}
  76. {%
  77. set row_classes = [
  78. not no_striping ? cycle(['odd', 'even'], loop.index0),
  79. ]
  80. %}
  81. <tr{{ row.attributes.addClass(row_classes) }}>
  82. {% for cell in row.cells %}
  83. <{{ cell.tag }}{{ cell.attributes }}>
  84. {{- cell.content -}}
  85. </{{ cell.tag }}>
  86. {% endfor %}
  87. </tr>
  88. {% endfor %}
  89. </tbody>
  90. {% elseif empty %}
  91. <tbody>
  92. <tr class="odd">
  93. <td colspan="{{ header_columns }}" class="empty message">{{ empty }}</td>
  94. </tr>
  95. </tbody>
  96. {% endif %}
  97. {% if footer %}
  98. <tfoot>
  99. {% for row in footer %}
  100. <tr{{ row.attributes }}>
  101. {% for cell in row.cells %}
  102. <{{ cell.tag }}{{ cell.attributes }}>
  103. {{- cell.content -}}
  104. </{{ cell.tag }}>
  105. {% endfor %}
  106. </tr>
  107. {% endfor %}
  108. </tfoot>
  109. {% endif %}
  110. </table>

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