Interface IFactory<W, H>

Table of content model factory interface

interface IFactory<W, H> {
createNew: ((widget, configuration?) => TableOfContents.IModel<H>);
isApplicable: ((widget) => boolean);
}

Type Parameters

W extends Widget = Widget
H extends TableOfContents.IHeading = TableOfContents.IHeading

Implemented by

TableOfContentsFactory

Index

Properties

createNew isApplicable

Properties

createNew

createNew: ((widget, configuration?) => TableOfContents.IModel<H>)

Create a new table of contents model for the widget

Type declaration

- (widget, configuration?): TableOfContents.IModel<H>
- Parameters
  - widget: W
    widget
  - Optional configuration: TableOfContents.IConfig
    Table of contents configuration
  Returns TableOfContents.IModel<H>

Returns

The table of contents model

isApplicable

isApplicable: ((widget) => boolean)

Whether the factory can handle the widget or not.

Type declaration

- (widget): boolean
- Parameters
  - widget: W
    widget
  Returns boolean

Returns

boolean indicating a ToC can be generated