Modules
Table of contents (Omni Pro)
This module ships in Omni Pro.
Jump links to the sections of a long page. Use it at the top of a blog post, in a column beside a pillar page, or as a grid of cards that opens a topic cluster.
On this page
Where the entries come from
The headings on this page (default): when the page loads, the theme reads the area you point at and lists every heading in it. Headings without an id get one, so the links work without touching the content.
| Setting | What it does |
|---|---|
| Area to read | A CSS selector. main is the page content in every Omni template. |
| Heading levels | H2 only, H2 and H3, or H2, H3 and H4. Lower levels are indented. |
| Skip headings inside | Selectors whose headings are left out, for example the footer and accordions. |
Entries I write below: a fixed list. Each entry has a label and the Anchor ID of the section it jumps to (set that ID in the section itself, under Content → Anchor ID), or a link to another page for a topic cluster. Written entries are in the page source, so search engines read them; automatic entries are built in the browser.
Choose the layout
| Layout | Use it for |
|---|---|
| Box in the page | At the top of an article, or in a narrow column beside it with Keep the box in view while scrolling on |
| Floating panel | A panel fixed to the left or right edge that appears once the reader has scrolled past a point and folds to its title bar |
| Cards | A pillar page: every entry becomes a linked card with an icon and a description |
Behaviour
- Mark the section you are reading highlights the entry for the section on screen.
- Reading progress bar shows how far into the content the visitor has read.
- Number the entries, Can be folded away and a Back to top link.
- Scrolling lands under the site header, and follows the visitor's motion setting.
Good to know
- One module per page. A second table of contents would list the first one's own entries.
- The cards layout ignores the folding and progress settings.
- On phones the floating panel sits along the bottom edge instead of the side.
More in this category
Keep reading
Support
Did this answer your question?
If not, write to us and say which page you were on.