Class TableOfContentsRegistry

Class for registering widgets for which we can generate a table of contents.

Hierarchy

TableOfContentsRegistry
- ITableOfContentsRegistry

Index

Constructors

constructor

Properties

Accessors

collapseChanged

Methods

add
find

Constructors

constructor

new TableOfContentsRegistry(): TableOfContentsRegistry

Returns TableOfContentsRegistry

Properties

Private _collapseChanged

_collapseChanged: any

Private _generators

_generators: any

Accessors

collapseChanged

get collapseChanged(): ISignal<this, ICollapseChangedArgs>

- Defined in packages/toc/lib/registry.d.ts:39
Returns ISignal<this, ICollapseChangedArgs>

Methods

add

add(generator: IGenerator<Widget>): void

- Defined in packages/toc/lib/registry.d.ts:38
Adds a table of contents generator to the registry.

Parameters
- generator: IGenerator<Widget>
  
  table of contents generator
Returns void

find

find(widget: Widget): IGenerator<Widget>

- Defined in packages/toc/lib/registry.d.ts:32
Finds a table of contents generator for a widget.

Notes
- If unable to find a table of contents generator, the method return undefined.
Parameters
- widget: Widget
  
  widget
Returns IGenerator<Widget>

table of contents generator

Generated using TypeDoc