Skip to main content
cngx-src documentation

CngxTocItem

Interface

projects/ui/toc/toc.types.ts

Referenced by#

Import#

import { CngxTocItem } from '@cngx/ui/toc'

Description#

One entry in a table-of-contents outline. Tree-shaped: an item may nest children, rendered as a nested <ul> under its link. id targets the section element the link scrolls to (matched via getElementById), label is the visible link text. Explicit data input - the organism never scans the document for headings in this release (see the deferred auto-discovery phase).

Index#

Instance Properties#

children#unknown
ReadonlyOptional

Nested sub-sections, rendered as an indented child list.

Readonly

Section element id this entry links to and scrolls into view.

label#string
Readonly

Visible link text.