Interface IFactory<W, H>

Table of content model factory interface

interface IFactory<
    W extends Widget = Widget,
    H extends TableOfContents.IHeading = TableOfContents.IHeading,
> {
    createNew: (
        widget: W,
        configuration?: TableOfContents.IConfig,
    ) => TableOfContents.IModel<H>;
    getToolbarItems?: (widget: W) => ToolbarRegistry.IToolbarItem[];
    isApplicable: (widget: W) => boolean;
}

Type Parameters

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

Implemented by

TableOfContentsFactory

Index

Properties

createNew getToolbarItems? isApplicable

Properties

createNew

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

Create a new table of contents model for the widget

Type declaration

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

`Optional`getToolbarItems

getToolbarItems?: (widget: W) => ToolbarRegistry.IToolbarItem[]

Get additional toolbar items for the widget

Type declaration

- (widget: W): ToolbarRegistry.IToolbarItem[]
- Parameters
  - widget: W
    widget
  Returns ToolbarRegistry.IToolbarItem[]
  List of toolbar items

isApplicable

isApplicable: (widget: W) => boolean

Whether the factory can handle the widget or not.

Type declaration

- (widget: W): boolean
- Parameters
  - widget: W
    widget
  Returns boolean
  boolean indicating a ToC can be generated