Module:UtilsLayout/Table/Documentation

This is the documentation page for Module:UtilsLayout/Table

This module exports the following functions.

table

table(data)

Parameters

data
A Lua table representing the desired wikitable.
[sortable]
boolean{ number }

If true, renders a table that can be sorted by any of its columns.

An array of column indices to be made sortable.
[hideEmptyColumns]
If true, columns that are completely empty (except for header and footer rows) are omitted.
[hideEmptyRows]
If true, rows that are completely empty (except for header cells) are omitted.
[class=wikitable]
Sets the table's class HTML attribute. Note that overrides the sortable option.
[styles]
Key-value pairs of CSS properties to apply to the <table> element. Consider instead using the class property and CSS stylesheets (e.g. MediaWiki:Templates.css).
[caption]
Wikitext for a table caption.
[headers]
An array of strings to serve as a header row.
rows
[header]
If true renders all cells in row as <th> elements.
[footer]
If true renders all cells in row as <th> elements.
[id]
Sets the id attribute on the row element which makes the row clickable if MediaWiki:Gadget-Tables is enabled.
[styles]
Key-value pairs of CSS properties to apply to each cell in the row.
[cells]
[header]
If true, renders the cell as a <th> element.
[colspan]
[rowspan]
[sortValue]
Sort value for the cell.
[class]
Sets the cell's class HTML attribute.
[styles]
Key-value pairs of CSS properties to apply to the cell. Overrides any conflicting row styles. Consider instead using the class property and CSS stylesheets (e.g. MediaWiki:Templates.css).
content
stringrows

Wikitext content for the cell.

Subvidisions for the cell. Think of it as a table within a table.
[header]
If true renders all cells in row as <th> elements.
[footer]
If true renders all cells in row as <th> elements.
[id]
Sets the id attribute on the row element which makes the row clickable if MediaWiki:Gadget-Tables is enabled.
[styles]
Key-value pairs of CSS properties to apply to each cell in the row.
[cells]

Returns

Wikitext for the table using XHTML syntax.

Examples

# Input Result

A table with header row, footer row, and caption

1

table({
  caption = "A table",
  rows = {
    {
      header = true,
      cells = {"column1", "column2", "column3"},
    },
    {
      id = "row-1",
      cells = {"cell1", "cell2", "cell3"},
    },
    {
      id = "row-2",
      cells = {"cell4", "cell5", "cell6"},
    },
    {
      footer = true,
      cells = {"foot1", "foot2", "foot2"},
    },
  },
})

A table
column1	column2	column3
cell1	cell2	cell3
cell4	cell5	cell6
foot1	foot2	foot2

Shorthand syntax

2

table({
  headers = {"column1", "column2", "column3"},
  rows = {
    {"cell1", "cell2", "cell3"},
    {"cell4", "cell5", "cell6"},
  },
})

column1	column2	column3
cell1	cell2	cell3
cell4	cell5	cell6

Works with pipe characters

3

table({
  rows = {
    {"cell | 1", "cell |} 2", "cell {| 3"},
  },
})

cell \| 1	cell \|} 2	cell {\| 3

Sortable table - note how Bosses sorts alphabetically but Temples sorts by in-game order due to sortValue.

4

table({
  rows = {
    {
      {
        content = "Forest Temple",
        sortValue = "1",
      },
      { content = "Gohma" },
    },
    {
      {
        content = "Fire Temple",
        sortValue = "2",
      },
      { content = "Volvagia" },
    },
    {
      {
        content = "Water Temple",
        sortValue = "3",
      },
      { content = "Morpha" },
    },
    {
      {
        content = "Shadow Temple",
        sortValue = "4",
      },
      { content = "Bongo Bongo" },
    },
  },
  headers = {"Temples", "Bosses", "Unsortable"},
  sortable = {1, 2},
})

Temples	Bosses	Unsortable
Forest Temple	Gohma
Fire Temple	Volvagia
Water Temple	Morpha
Shadow Temple	Bongo Bongo

Cell spanning multiple columns

5

table({
  headers = {"col1", "col2", "col3", "col4", "col5"},
  rows = {
    {
      {
        colspan = 2,
        content = "spans 2 columns",
      },
      {
        colspan = 3,
        content = "spans 3 columns",
      },
    },
    {
      {
        colspan = -1,
        content = "spans all columns",
      },
    },
  },
})

col1	col2	col3	col4	col5
spans 2 columns		spans 3 columns
spans all columns

Option to hide columns when they're completely empty except for headers/footers

6

table({
  hideEmptyRows = true,
  hideEmptyColumns = true,
  rows = {
    {"row1", "", "row1"},
    {"row2", "", "row2"},
  },
  headers = {"not empty", "empty", "not empty"},
})

not empty	not empty
row1	row1
row2	row2

Option to hide rows when they're completely empty except for headers

7

table({
  hideEmptyRows = true,
  rows = {
    {
      {
        header = true,
        content = "Header1",
      },
      "not empty",
    },
    {
      {
        header = true,
        content = "Header2",
      },
      "",
    },
    {},
  },
})

Header1	not empty

Table styles are applied at the table level. Cell styles can be specified individually, or once for the entire row. The table class and cell class can be overridden.

8

table({
  class = "wikitable custom-element",
  rows = {
    {"centered", "centered"},
    {
      cells = {
        { content = "left-aligned" },
        {
          class = "custom-cell",
          content = "right-aligned",
          styles = { ["text-align"] = "right" },
        },
      },
      styles = { ["text-align"] = "left" },
    },
  },
  styles = {
    ["text-align"] = "center",
    width = "20em",
  },
})

centered	centered
left-aligned	right-aligned

Individual cells subdivided into multiple columns and rows

9

table({
  rows = {
    {
      header = true,
      cells = {"Column1", "Column2", "Column3"},
    },
    {
      "A",
      {
        {"B1"},
        {"B2"},
      },
      "C",
    },
    {
      {
        {"D1", "D2"},
      },
      {
        {"E1"},
        {
          {
            content = "E2",
            header = true,
          },
          "E3",
        },
      },
      {
        {"F1"},
        {"F2"},
        {"F3"},
      },
    },
    {
      {
        {"G1", "G2", "G3"},
      },
      "H",
      {
        {},
      },
    },
  },
  styles = { ["text-align"] = "center" },
})

Column1			Column2		Column3
A			B1		C
A			B2		C
D1	D2		E1		F1
			E2	E3	F2
			E2	E3	F3
G1	G2	G3	H

tabbedTable

tabbedTable(data)

Parameters

data
[headerRows]
Header rows common to every tab.
[headerRows]
Footer rows common to every tab.
tabs
label
Tab label
rows
Table rows for the tab. See table for format.

Returns

A series of wikitables displayed using tabs. Useful for representing data with three dimensions, or data with too many columns.

Examples

#

Input

Result

Tabbed table with shared headers and footers

10

tabbedTable({
  headerRows = {
    {"col1", "col2", "col3"},
  },
  tabs = {
    {
      label = "tab1",
      rows = {
        {"cell1", "cell2", "cell3"},
        {"cell4", "cell5", "cell6"},
      },
    },
    {
      label = "tab2",
      rows = {
        {"cell7", "cell8", "cell9"},
        {"cell10", "cell11", "cell12"},
      },
    },
  },
  footerRows = {
    {"foo12", "foot2", "foot3"},
  },
})

col1	col2	col3
cell1	cell2	cell3
cell4	cell5	cell6
foo12	foot2	foot3

col1	col2	col3
cell7	cell8	cell9
cell10	cell11	cell12
foo12	foot2	foot3

Module:UtilsLayout/Table/Documentation

Contents

table

tabbedTable

Navigation menu

Module:UtilsLayout/Table/Documentation

table

tabbedTable

Navigation menu

Search