Class MarkdownTableOfContentsFactory

Table of content model factory for Markdown files.

Hierarchy (View Summary)

EditorTableOfContentsFactory
- MarkdownTableOfContentsFactory

Index

Constructors

Properties

Methods

_createNew createNew isApplicable

Constructors

constructor

new MarkdownTableOfContentsFactory(
    tracker: WidgetTracker<
        IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
    >,
    parser?: null | IMarkdownParser,
): MarkdownTableOfContentsFactory
Parameters
- tracker: WidgetTracker<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>
- parser: null | IMarkdownParser = null
Returns MarkdownTableOfContentsFactory
Overrides EditorTableOfContentsFactory.constructor
- Defined in packages/fileeditor/src/toc/markdown.ts:70

Properties

`Protected`parser

parser: null | IMarkdownParser = null

`Protected`tracker

tracker: IWidgetTracker<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>

Widget tracker

Methods

`Protected`_createNew

_createNew(
widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
configuration?: TableOfContents.IConfig,
): MarkdownTableOfContentsModel
Create a new table of contents model for the widget
Parameters
- widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>
  widget
- Optionalconfiguration: TableOfContents.IConfig
  Table of contents configuration
Returns MarkdownTableOfContentsModel
The table of contents model
Overrides EditorTableOfContentsFactory._createNew
- Defined in packages/fileeditor/src/toc/markdown.ts:100

createNew

createNew(
    widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
    configuration?: TableOfContents.IConfig,
): TableOfContentsModel<
    IEditorHeading,
    IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
>
Create a new table of contents model for the widget
Parameters
- widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>
  widget
- Optionalconfiguration: TableOfContents.IConfig
  Table of contents configuration
Returns TableOfContentsModel<
IEditorHeading,
IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
>
The table of contents model
Inherited from EditorTableOfContentsFactory.createNew
- Defined in packages/fileeditor/src/toc/factory.ts:36

isApplicable

isApplicable(widget: Widget): boolean
Whether the factory can handle the widget or not.
Parameters
- widget: Widget
  widget
Returns boolean
boolean indicating a ToC can be generated
Overrides EditorTableOfContentsFactory.isApplicable
- Defined in packages/fileeditor/src/toc/markdown.ts:83