You are here

Home » API reference » Zircon Profile 8

table.html.twig in Zircon Profile 8

Same filename in this branch
  1. 8 core/modules/system/templates/table.html.twig
  2. 8 core/themes/classy/templates/dataset/table.html.twig
  3. 8 core/themes/stable/templates/dataset/table.html.twig
Same filename and directory in other branches
  1. 8.0 core/modules/system/templates/table.html.twig

Default theme implementation 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()

12 theme calls to table.html.twig
ContentTranslationController::overview in core/modules/content_translation/src/Controller/ContentTranslationController.php
Builds the translations overview page.
memcache_admin_shutdown in modules/memcache/memcache_admin/memcache_admin.module
See memcache_admin_init() which registers this function as a shutdown function. Displays memcache stats in the footer.
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::queryParameters in core/modules/system/tests/modules/pager_test/src/Controller/PagerTestController.php
Returns a pager with 'parameters' variable.

... See full list

File

core/modules/system/templates/table.html.twig
View source 
  1. {#

  2. /**

  3.  * @file

  4.  * Default theme implementation 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.  * @ingroup themeable

  42.  */

  43. #}

  44. <table{{ attributes }}>

  45.   {% if caption %}

  46.     <caption>{{ caption }}</caption>

  47.   {% endif %}

  48. 

  49.   {% for colgroup in colgroups %}

  50.     {% if colgroup.cols %}

  51.       <colgroup{{ colgroup.attributes }}>

  52.         {% for col in colgroup.cols %}

  53.           <col{{ col.attributes }} />

  54.         {% endfor %}

  55.       </colgroup>

  56.     {% else %}

  57.       <colgroup{{ colgroup.attributes }} />

  58.     {% endif %}

  59.   {% endfor %}

  60. 

  61.   {% if header %}

  62.     <thead>

  63.       <tr>

  64.         {% for cell in header %}

  65.           <{{ cell.tag }}{{ cell.attributes }}>

  66.             {{- cell.content -}}

  67.           </{{ cell.tag }}>

  68.         {% endfor %}

  69.       </tr>

  70.     </thead>

  71.   {% endif %}

  72. 

  73.   {% if rows %}

  74.     <tbody>

  75.       {% for row in rows %}

  76.         <tr{{ row.attributes }}>

  77.           {% for cell in row.cells %}

  78.             <{{ cell.tag }}{{ cell.attributes }}>

  79.               {{- cell.content -}}

  80.             </{{ cell.tag }}>

  81.           {% endfor %}

  82.         </tr>

  83.       {% endfor %}

  84.     </tbody>

  85.   {% elseif empty %}

  86.     <tbody>

  87.       <tr>

  88.         <td colspan="{{ header_columns }}">{{ empty }}</td>

  89.       </tr>

  90.     </tbody>

  91.   {% endif %}

  92.   {% if footer %}

  93.     <tfoot>

  94.       {% for row in footer %}

  95.         <tr{{ row.attributes }}>

  96.           {% for cell in row.cells %}

  97.             <{{ cell.tag }}{{ cell.attributes }}>

  98.               {{- cell.content -}}

  99.             </{{ cell.tag }}>

  100.           {% endfor %}

  101.         </tr>

  102.       {% endfor %}

  103.     </tfoot>

  104.   {% endif %}

  105. </table>

Related topics

Theme system overview
Functions and templates for the user interface that themes can override.