Skip to content

Heading

A titled section at one of six levels — optionally numbered, and listed in the table of contents.

Text components · element type heading · binds through text templates

Related: Text · Table of Contents · Paragraph

Examples

// A plain section title
Summary of Findings

// A title from your data
Statement for {$data.customer.name}

// Custom numbering, set as Number Template
Section {$heading.number} —

With Auto Number on, the level decides the depth: an H1 gives 1, an H2 below it gives 1.1.

Options

Option Values Default Description
Level H1 – H6 H3 H1 for major sections, H6 for the smallest subsections
Title Any text or template Heading The heading text
Include in table of contents On · Off On Whether the heading appears in the Table of Contents
Text Align Left · Center · Right From theme Horizontal alignment
Vertical Align Top · Middle · Bottom Not set Vertical alignment within the slot
Whitespace Trim · Preserve Trim Preserve keeps line breaks and indentation exactly as entered

Numbering

Option Values Default Description
Auto Number On · Off Off Numbers headings sequentially according to their level
Number Template Template Empty Overrides the numbering format, e.g. {$heading.number}
Style CSS Empty Custom CSS for the number alone, separate from the heading text

Styling

Every value below falls back to the theme until you set it on the component.

Option Values Default Description
Font Family Theme fonts From theme Typeface
Font Size Any CSS unit From theme e.g. 18pt, 1.4em
Text Color Palette or custom From theme
Font Weight Normal · Bold · numeric From theme
Line Height Number or CSS unit From theme Spacing between wrapped lines
Text Transform None · Uppercase · Lowercase · Capitalize From theme
Margin Top / Margin Bottom Any CSS unit From theme Vertical spacing around the heading
Style CSS Empty Custom CSS, through the style editor

Notes

  • Use Heading for anything that structures the document. Text that merely needs to look large is a Text component with a bigger font — only real headings should reach the table of contents
  • Keep levels consistent: skipping from H1 to H4 produces a table of contents with gaps in it
  • Turn off Include in table of contents for a heading that is decorative or repeated on every page