Class TableOfContentsRegistry

Class for registering table of contents generators.

Implements

ITableOfContentsRegistry

Index

Constructors

Methods

add getModel getToolbarItems

Constructors

constructor

new TableOfContentsRegistry(): TableOfContentsRegistry
Returns TableOfContentsRegistry

Methods

add

add(
generator: TableOfContents.IFactory<Widget, TableOfContents.IHeading>,
): IDisposable
Adds a table of contents generator to the registry.
Parameters
- generator: TableOfContents.IFactory<Widget, TableOfContents.IHeading>
  table of contents generator
Returns IDisposable
Implementation of ITableOfContentsRegistry.add
- Defined in packages/toc/src/registry.ts:58

getModel

getModel(
widget: Widget,
configuration?: TableOfContents.IConfig,
): undefined | TableOfContents.Model
Finds a table of contents model for a widget.

Notes
- If unable to find a table of contents model, the method return undefined.
Parameters
- widget: Widget
  widget
- Optionalconfiguration: TableOfContents.IConfig
  Default model configuration
Returns undefined | TableOfContents.Model
Table of contents model
Implementation of ITableOfContentsRegistry.getModel
- Defined in packages/toc/src/registry.ts:25

getToolbarItems

getToolbarItems(widget: Widget): undefined | ToolbarRegistry.IToolbarItem[]
Get the toolbar items for a widget.
Parameters
- widget: Widget
  widget
Returns undefined | ToolbarRegistry.IToolbarItem[]
List of toolbar items
Implementation of ITableOfContentsRegistry.getToolbarItems
- Defined in packages/toc/src/registry.ts:42