Constructor
The widget to search in
Markdown parser
Optional configuration: TableOfContents.IConfigDefault model configuration
Protected parserReadonly stateA signal emitted when any model state changes.
Protected widgetCurrent active entry.
table of contents active entry
Signal emitted when the active heading changes.
Signal emitted when a table of content section collapse state changes.
Model configuration
Type of document supported by the model.
A data-document-type attribute with this value will be set
on the tree view .jp-TableOfContents-content[data-document-type="..."]
List of headings.
table of contents list of headings
Signal emitted when the headings changes.
Whether the model is active or not.
An active model means it is displayed in the table of contents. This can be used by subclass to limit updating the headings.
Whether the model needs to be kept up to date or not.
This is set to true if the ToC panel is visible and
to false if it is hidden. But some models may require
to be always active; e.g. to add numbering in the document.
Protected isWhether the model gets updated even if the table of contents panel is hidden or not.
Test whether the model is disposed.
List of configuration options supported by the model.
Document title
Document title
Protected getProduce the headings for a document.
The list of new headings or null if nothing needs to be updated.
Set a new active heading.
The new active heading
Optional emitSignal: booleanWhether to emit the activeHeadingChanged signal or not.
Model configuration setter.
New configuration
Callback on heading collapse.
Optional collapsed?: booleanThe new collapsed status (toggle existing status if not provided)
Optional heading?: IMarkdownViewerHeadingThe heading to change state (all headings if not provided)
Generated using TypeDoc
Table of content model for Markdown viewer files.