Interface ITableOfContentsRegistry

Interface describing the table of contents registry.

interface ITableOfContentsRegistry {
add(factory): IDisposable;
getModel(widget, configuration?): undefined | TableOfContents.Model;
}

Implemented by

TableOfContentsRegistry

Index

Methods

Methods

add

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

getModel

getModel(widget, configuration?): 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
- Optional configuration: TableOfContents.IConfig
  Table of contents configuration
Returns undefined | TableOfContents.Model
Table of contents model or undefined if not found
- Defined in packages/toc/src/tokens.ts:28