You are here

datatable.html.twig in DataTables 8

Same filename and directory in other branches
  1. 2.x templates/datatable.html.twig
  2. 1.x templates/datatable.html.twig

Theme override to display a DataTable 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.

File

templates/datatable.html.twig
View source
  1. {#
  2. /**
  3. * @file
  4. * Theme override to display a DataTable 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_datatable()
  40. */
  41. #}
  42. {% include 'table.html.twig' %}