Toc

Toc

Documentation

A page-aware table of contents generated automatically from eligible sections in the current page. Toc is a specialized composition rather than a standalone rendering primitive. It derives its navigation from the page and uses shared QP primitives to present that navigation consistently. By default, Toc renders as a position-aware StickyTray. It can also render an in-flow Card presentation. When placed inside a compatible container, the renderer may reuse the container supplied by its parent rather than emitting a redundant wrapper.

Kind

Built Content

Required fields

type

Style Guide

Used by

Properties

card

boolean

Renders an in-flow Card presentation of the table of contents. Defaults to false.

class

string

Optional styling hook.

sticky

boolean

Renders the table of contents using the StickyTray presentation. Defaults to true.

*

type

string

Identifies the Element type represented by this object.

"toc"

Example

Required

{ "type": "toc" }

Full

{ "card": true, "class": "example", "sticky": false, "type": "toc" }

examples are generated from the schema.