Interface ITableOfContentsRegistry

Interface describing the table of contents registry.

Hierarchy

TableOfContentsRegistry
- ITableOfContentsRegistry

Index

Accessors

collapseChanged

Methods

add
find

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

Inherited from TableOfContentsRegistry.add
- 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>

Inherited from TableOfContentsRegistry.find
- 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