Node - table

Purpose

The table node provides a container for the nodes that define a table.

Note: only supported on web and desktop. Mobile rendering support for tables is not available.

Type

table is a top-level block node.

Example

1
2
{
  "type": "table",
  "attrs": {
    "isNumberColumnEnabled": false,
    "layout": "default",
    "width": 900 
  },
  "content": [
    {
      "type": "tableRow",
      "content": [
        {
          "type": "tableCell",
          "attrs": {},
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": " Row one, cell one"
                }
              ]
            }
          ]
        },
        {
          "type": "tableCell",
          "attrs": {},
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Row one, cell two"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Fields

NameRequiredTypeValue
typestring"table"
contentarrayArray of one or more nodes
attrsobject
attrs.isNumberColumnEnabledboolean'true','false'
attrs.widthnumberA positive integer
attrs.layoutstring'default', 'full-width', 'wide'

Content

content takes an array of one or more tableRow nodes.

Attributes

When isNumberColumnEnabled is set to 'true' the first table column provides numbering for the table rows.

width sets the length (in pixels) of the table on the page. This value is independent of the table's column width, this allows control of the table's overflow. It supersedes the existing layout attribute and will be used instead of it at runtime. If width is not provided the editor will convert layout to pixels (default=760, wide=960 and full-width=1800). Although no minimum and maximum width is enforced it is recommended to follow these guidelines:

Minimum width

  • 1 column table = 48px
  • 2 column table = 96px
  • 3 column table = 144px
  • > 3 column table = 144px

Maximum width

  • 1800

layout determines the layout of the table as follows:

  • 'default' displays the table within the text container margins.
  • 'full-width' stretches the table to the full width of the page.
  • 'wide' allows the table to bleed into the text container margins.

These settings do not apply in Jira where tables are automatically displayed across the full width of the text container.

Rate this page: