Skip to main content
Documentation/Elements & Controls Reference/Elements/Blocks/Table Of Contents

Table Of Contents

Table Of Contents builds a list of links to headings in the page. Use it on a long article whose heading structure gives readers useful navigation.

Add and configure Table Of Contents

  1. Click Add, choose Table Of Contents, and place it in the container.
  2. Choose Content > Table > Included Headings.
  3. Set Title and Title Tag, then review Advanced targeting options.
  4. Configure Design > Container, Header, List, and Spacing.
  5. Save your changes.
Table Of Contents controls in the Breakdance editor
Table Of Contents controls in the Breakdance editor

This element has no children; use its own controls.

Controls

Responsive varies by breakpoint; Hover has a hover value; Shared applies across both. Linked controls have their own reference. In conditions, = means “is” and ≠ means “is not.”

Content > Table

Setting Purpose and options Behavior
Included Headings > H1 On/off. Shared
Included Headings > H2 On/off. Shared
Included Headings > H3 On/off. Shared
Included Headings > H4 On/off. Shared
Included Headings > H5 On/off. Shared
Included Headings > H6 On/off. Shared
Title Item title. Shared
Title Tag div, h1, h2, h3, h4, h5, h6. When: Disable Post Title is unset. Shared
Advanced > Ignore Selectors Enter the ignore selectors. Shared
Advanced > Container Selector Enter the container selector. Shared

Design > Container

Setting Purpose and options Behavior
Width Width. Responsive
Content Alignment Label, Riht. Shared
Background Color or supported fill. Shared
Padding spacing controls. See linked controls
Borders borders controls. See linked controls

Design > Header

Setting Purpose and options Behavior
Disable On/off. Shared
Background Color or supported fill. Shared
Typography typography controls. See linked controls
Padding spacing controls. See linked controls
Accordion On/off. Shared

Shown when Accordion is set.

Setting Purpose and options Behavior
Icon > Icon Icon. Shared
Icon > Active Icon Icon. Shared
Icon > Size Size and unit. Shared
Icon > Color Color or supported fill. Shared

Design > List

Setting Purpose and options Behavior
Scroll Offset Scroll offset and unit. Shared
Heading Offset Heading offset and unit. Shared
Collapse On/off. Shared
Style None, Bullets, Numbers. Shared
Bar > Background Color or supported fill. Shared
Bar > Active Color or supported fill. Shared
Bar > Width Width. Responsive
Indent Indent and unit. Responsive
Between Items Set between items. Range: 1–4. Responsive
Typography typography controls. See linked controls
Active Typography > Color Color or supported fill. Shared
Active Typography > Weight 100, 200, 300, 400, 500, 600, 700, 800, 900. Shared
Active Typography > Size Size and unit. Responsive

Design > Spacing

Setting Purpose and options Behavior
Below Header Below header and unit. Shared
Wrapper spacing controls. When: Position is unset. See linked controls

Troubleshooting

A heading is missing

Check Included Headings and any Advanced scope or exclusion settings.

Narrow the target area using the available Advanced controls and verify the saved heading links.