@jupyterlab/toc 5.4.3 → 6.0.0-alpha.11

package/lib/registry.d.ts

@@ -1,136 +1,28 @@
-/// <reference types="react" />
-import { IWidgetTracker } from '@jupyterlab/apputils';
-import { Token } from '@lumino/coreutils';
-import { ISignal } from '@lumino/signaling';
+import { IDisposable } from '@lumino/disposable';
 import { Widget } from '@lumino/widgets';
-import { IHeading, INotebookHeading } from './utils/headings';
+import { ITableOfContentsRegistry, TableOfContents } from './tokens';
 /**
- * Interface describing the table of contents registry.
- *
- * @private
+ * Class for registering table of contents generators.
  */
-export interface ITableOfContentsRegistry extends TableOfContentsRegistry {
-}
-/**
- * Table of contents registry token.
- */
-export declare const ITableOfContentsRegistry: Token<TableOfContentsRegistry>;
-/**
- * Class for registering widgets for which we can generate a table of contents.
- */
-export declare class TableOfContentsRegistry {
+export declare class TableOfContentsRegistry implements ITableOfContentsRegistry {
     /**
-     * Finds a table of contents generator for a widget.
+     * Finds a table of contents model for a widget.
      *
      * ## Notes
      *
-     * -   If unable to find a table of contents generator, the method return `undefined`.
+     * -   If unable to find a table of contents model, the method return `undefined`.
      *
      * @param widget - widget
-     * @returns table of contents generator
+     * @param configuration - Default model configuration
+     * @returns Table of contents model
      */
-    find(widget: Widget): TableOfContentsRegistry.IGenerator | undefined;
+    getModel(widget: Widget, configuration?: TableOfContents.IConfig): TableOfContents.Model | undefined;
     /**
      * Adds a table of contents generator to the registry.
      *
      * @param generator - table of contents generator
      */
-    add(generator: TableOfContentsRegistry.IGenerator): void;
-    get collapseChanged(): ISignal<this, TableOfContentsRegistry.ICollapseChangedArgs>;
-    private _collapseChanged;
+    add(generator: TableOfContents.IFactory): IDisposable;
     private _generators;
-}
-/**
- * Static registry methods.
- */
-export declare namespace TableOfContentsRegistry {
-    /**
-     * Abstract class for managing options affecting how a table of contents is generated for a particular widget type.
-     */
-    interface IOptionsManager {
-    }
-    /**
-     * Interface for the arguments needed in the collapse signal of a generator
-     */
-    interface ICollapseChangedArgs {
-        /**
-         * Boolean indicating whether the given heading is collapsed in ToC
-         */
-        collapsedState: boolean;
-        /**
-         * Heading that was involved in the collapse event
-         */
-        heading: IHeading;
-        /**
-         * Type of file that the given heading was produced from
-         */
-        tocType: string;
-    }
-    /**
-     * Interface describing a widget table of contents generator.
-     */
-    interface IGenerator<W extends Widget = Widget> {
-        /**
-         * Widget instance tracker.
-         */
-        tracker: IWidgetTracker<W>;
-        /**
-         * Returns a boolean indicating whether we can generate a ToC for a widget.
-         *
-         * ## Notes
-         *
-         * -   By default, we assume ToC generation is enabled if the widget is hosted in `tracker`.
-         * -   However, a user may want to add additional checks (e.g., only generate a ToC for text files only if they have a given MIME type).
-         *
-         * @param widget - widget
-         * @returns boolean indicating whether we can generate a ToC for a widget
-         */
-        isEnabled?: (widget: W) => boolean;
-        /**
-         * Boolean indicating whether a document uses LaTeX typesetting.
-         *
-         * @default false
-         */
-        usesLatex?: boolean;
-        /**
-         * Options manager.
-         *
-         * @default undefined
-         */
-        options?: IOptionsManager;
-        /**
-         * Signal to indicate that a collapse event happened to this heading
-         * within the ToC.
-         */
-        collapseChanged?: ISignal<IOptionsManager, ICollapseChangedArgs>;
-        /**
-         * Returns a JSX element for each heading.
-         *
-         * ## Notes
-         *
-         * -   If not present, a default renderer will be used.
-         *
-         * @param item - heading
-         * @param toc - list of headings
-         * @returns JSX element
-         */
-        itemRenderer?: (item: IHeading, toc: INotebookHeading[]) => JSX.Element | null;
-        /**
-         * Returns a toolbar component.
-         *
-         * ## Notes
-         *
-         * -   If not present, no toolbar is generated.
-         *
-         * @returns toolbar component
-         */
-        toolbarGenerator?: () => any;
-        /**
-         * Returns a list of headings.
-         *
-         * @param widget - widget
-         * @returns list of headings
-         */
-        generate(widget: W, options?: IOptionsManager): IHeading[];
-    }
+    private _idCounter;
 }

package/lib/registry.js

@@ -1,39 +1,29 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { Token } from '@lumino/coreutils';
-import { Signal } from '@lumino/signaling';
-/* tslint:disable */
+import { DisposableDelegate } from '@lumino/disposable';
 /**
- * Table of contents registry token.
- */
-export const ITableOfContentsRegistry = new Token('@jupyterlab/toc:ITableOfContentsRegistry');
-/* tslint:enable */
-/**
- * Class for registering widgets for which we can generate a table of contents.
+ * Class for registering table of contents generators.
  */
 export class TableOfContentsRegistry {
     constructor() {
-        this._collapseChanged = new Signal(this);
-        this._generators = [];
+        this._generators = new Map();
+        this._idCounter = 0;
     }
     /**
-     * Finds a table of contents generator for a widget.
+     * Finds a table of contents model for a widget.
      *
      * ## Notes
      *
-     * -   If unable to find a table of contents generator, the method return `undefined`.
+     * -   If unable to find a table of contents model, the method return `undefined`.
      *
      * @param widget - widget
-     * @returns table of contents generator
+     * @param configuration - Default model configuration
+     * @returns Table of contents model
      */
-    find(widget) {
-        for (let i = 0; i < this._generators.length; i++) {
-            const gen = this._generators[i];
-            if (gen.tracker.has(widget)) {
-                if (gen.isEnabled && !gen.isEnabled(widget)) {
-                    continue;
-                }
-                return gen;
+    getModel(widget, configuration) {
+        for (const generator of this._generators.values()) {
+            if (generator.isApplicable(widget)) {
+                return generator.createNew(widget, configuration);
             }
         }
     }
@@ -43,16 +33,11 @@ export class TableOfContentsRegistry {
      * @param generator - table of contents generator
      */
     add(generator) {
-        if (generator.collapseChanged) {
-            // If there is a collapseChanged for a given generator, propagate the arguments through the registry's signal
-            generator.collapseChanged.connect((sender, args) => {
-                this._collapseChanged.emit(args);
-            });
-        }
-        this._generators.push(generator);
-    }
-    get collapseChanged() {
-        return this._collapseChanged;
+        const id = this._idCounter++;
+        this._generators.set(id, generator);
+        return new DisposableDelegate(() => {
+            this._generators.delete(id);
+        });
     }
 }
 //# sourceMappingURL=registry.js.map

package/lib/registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAG3D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAW,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAWpD,oBAAoB;AACpB;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,KAAK,CAC/C,0CAA0C,CAC3C,CAAC;AACF,mBAAmB;AAEnB;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAApC;QAkDU,qBAAgB,GAGpB,IAAI,MAAM,CAAqD,IAAI,CAAC,CAAC;QACjE,gBAAW,GAAyC,EAAE,CAAC;IACjE,CAAC;IAtDC;;;;;;;;;OASG;IACH,IAAI,CAAC,MAAc;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAChD,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC3B,IAAI,GAAG,CAAC,SAAS,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;oBAC3C,SAAS;iBACV;gBACD,OAAO,GAAG,CAAC;aACZ;SACF;IACH,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,SAA6C;QAC/C,IAAI,SAAS,CAAC,eAAe,EAAE;YAC7B,6GAA6G;YAC7G,SAAS,CAAC,eAAe,CAAC,OAAO,CAC/B,CACE,MAAkD,EAClD,IAAkD,EAClD,EAAE;gBACF,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,CAAC,CACF,CAAC;SACH;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,eAAe;QAIjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;CAOF"}
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAAE,kBAAkB,EAAe,MAAM,oBAAoB,CAAC;AAIrE;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAApC;QAqCU,gBAAW,GAAG,IAAI,GAAG,EAAoC,CAAC;QAC1D,eAAU,GAAG,CAAC,CAAC;IACzB,CAAC;IAtCC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAc,EACd,aAAuC;QAEvC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE;YACjD,IAAI,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;gBAClC,OAAO,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;aACnD;SACF;IACH,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,SAAmC;QACrC,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QAEpC,OAAO,IAAI,kBAAkB,CAAC,GAAG,EAAE;YACjC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;CAIF"}

package/lib/tocitem.d.ts

@@ -0,0 +1,34 @@
+import * as React from 'react';
+import { TableOfContents } from './tokens';
+/**
+ * Interface describing component properties.
+ */
+export interface ITableOfContentsItemsProps {
+    /**
+     * Whether this item is active or not.
+     */
+    isActive: boolean;
+    /**
+     * Heading to render.
+     */
+    heading: TableOfContents.IHeading;
+    /**
+     * On `mouse-down` event callback.
+     */
+    onMouseDown: (heading: TableOfContents.IHeading) => void;
+    /**
+     * Collapse event callback.
+     */
+    onCollapse: (heading: TableOfContents.IHeading) => void;
+}
+/**
+ * React component for a table of contents entry.
+ */
+export declare class TableOfContentsItem extends React.PureComponent<React.PropsWithChildren<ITableOfContentsItemsProps>> {
+    /**
+     * Renders a table of contents entry.
+     *
+     * @returns rendered entry
+     */
+    render(): JSX.Element | null;
+}

package/lib/tocitem.js

@@ -0,0 +1,34 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { caretDownIcon, caretRightIcon } from '@jupyterlab/ui-components';
+import * as React from 'react';
+/**
+ * React component for a table of contents entry.
+ */
+export class TableOfContentsItem extends React.PureComponent {
+    /**
+     * Renders a table of contents entry.
+     *
+     * @returns rendered entry
+     */
+    render() {
+        const { children, isActive, heading, onCollapse, onMouseDown } = this.props;
+        return (React.createElement("li", { className: "jp-tocItem", key: `${heading.level}-${heading.text}` },
+            React.createElement("div", { className: `jp-tocItem-heading ${isActive ? 'jp-tocItem-active' : ''}`, onMouseDown: (event) => {
+                    // React only on deepest item
+                    if (!event.defaultPrevented) {
+                        event.preventDefault();
+                        onMouseDown(heading);
+                    }
+                } },
+                React.createElement("button", { className: "jp-tocItem-collapser", onClick: (event) => {
+                        event.preventDefault();
+                        onCollapse(heading);
+                    }, style: { visibility: children ? 'visible' : 'hidden' } }, heading.collapsed ? (React.createElement(caretRightIcon.react, { tag: "span", width: "20px" })) : (React.createElement(caretDownIcon.react, { tag: "span", width: "20px" }))),
+                React.createElement("span", Object.assign({ className: "jp-tocItem-content", title: heading.text }, heading.dataset),
+                    heading.prefix,
+                    heading.text)),
+            children && !heading.collapsed && React.createElement("ol", null, children)));
+    }
+}
+//# sourceMappingURL=tocitem.js.map

package/lib/tocitem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tocitem.js","sourceRoot":"","sources":["../src/tocitem.tsx"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AA2B/B;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK,CAAC,aAE9C;IACC;;;;OAIG;IACH,MAAM;QACJ,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAE5E,OAAO,CACL,4BAAI,SAAS,EAAC,YAAY,EAAC,GAAG,EAAE,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE;YAChE,6BACE,SAAS,EAAE,sBACT,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EACnC,EAAE,EACF,WAAW,EAAE,CAAC,KAA2C,EAAE,EAAE;oBAC3D,6BAA6B;oBAC7B,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE;wBAC3B,KAAK,CAAC,cAAc,EAAE,CAAC;wBACvB,WAAW,CAAC,OAAO,CAAC,CAAC;qBACtB;gBACH,CAAC;gBAED,gCACE,SAAS,EAAC,sBAAsB,EAChC,OAAO,EAAE,CAAC,KAAuB,EAAE,EAAE;wBACnC,KAAK,CAAC,cAAc,EAAE,CAAC;wBACvB,UAAU,CAAC,OAAO,CAAC,CAAC;oBACtB,CAAC,EACD,KAAK,EAAE,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,IAErD,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CACnB,oBAAC,cAAc,CAAC,KAAK,IAAC,GAAG,EAAC,MAAM,EAAC,KAAK,EAAC,MAAM,GAAG,CACjD,CAAC,CAAC,CAAC,CACF,oBAAC,aAAa,CAAC,KAAK,IAAC,GAAG,EAAC,MAAM,EAAC,KAAK,EAAC,MAAM,GAAG,CAChD,CACM;gBACT,4CACE,SAAS,EAAC,oBAAoB,EAC9B,KAAK,EAAE,OAAO,CAAC,IAAI,IACf,OAAO,CAAC,OAAO;oBAElB,OAAO,CAAC,MAAM;oBACd,OAAO,CAAC,IAAI,CACR,CACH;YACL,QAAQ,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,gCAAK,QAAQ,CAAM,CACnD,CACN,CAAC;IACJ,CAAC;CACF"}

package/lib/toctree.d.ts

@@ -0,0 +1,40 @@
+import * as React from 'react';
+import { TableOfContents } from './tokens';
+/**
+ * Interface describing component properties.
+ */
+export interface ITableOfContentsTreeProps {
+    /**
+     * Currently active heading.
+     */
+    activeHeading: TableOfContents.IHeading | null;
+    /**
+     * Type of document supported by the model.
+     */
+    documentType: string;
+    /**
+     * List of headings to render.
+     */
+    headings: TableOfContents.IHeading[];
+    /**
+     * Set active heading.
+     */
+    setActiveHeading: (heading: TableOfContents.IHeading) => void;
+    /**
+     * Collapse heading callback.
+     */
+    onCollapseChange: (heading: TableOfContents.IHeading) => void;
+}
+/**
+ * React component for a table of contents tree.
+ */
+export declare class TableOfContentsTree extends React.PureComponent<ITableOfContentsTreeProps> {
+    /**
+     * Renders a table of contents tree.
+     */
+    render(): JSX.Element;
+    /**
+     * Convert the flat headings list to a nested tree list
+     */
+    protected buildTree(): JSX.Element[];
+}

package/lib/toctree.js

@@ -0,0 +1,43 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import * as React from 'react';
+import { TableOfContentsItem } from './tocitem';
+/**
+ * React component for a table of contents tree.
+ */
+export class TableOfContentsTree extends React.PureComponent {
+    /**
+     * Renders a table of contents tree.
+     */
+    render() {
+        const { documentType } = this.props;
+        return (React.createElement("ol", Object.assign({ className: "jp-TableOfContents-content" }, { 'data-document-type': documentType }), this.buildTree()));
+    }
+    /**
+     * Convert the flat headings list to a nested tree list
+     */
+    buildTree() {
+        if (this.props.headings.length === 0) {
+            return [];
+        }
+        let globalIndex = 0;
+        const getChildren = (items, level) => {
+            const nested = new Array();
+            while (globalIndex < items.length) {
+                const current = items[globalIndex];
+                if (current.level >= level) {
+                    globalIndex += 1;
+                    const next = items[globalIndex];
+                    nested.push(React.createElement(TableOfContentsItem, { key: `${current.level}-${current.text}`, isActive: !!this.props.activeHeading &&
+                            current === this.props.activeHeading, heading: current, onMouseDown: this.props.setActiveHeading, onCollapse: this.props.onCollapseChange }, next && next.level > level && getChildren(items, level + 1)));
+                }
+                else {
+                    break;
+                }
+            }
+            return nested;
+        };
+        return getChildren(this.props.headings, this.props.headings[0].level);
+    }
+}
+//# sourceMappingURL=toctree.js.map

package/lib/toctree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toctree.js","sourceRoot":"","sources":["../src/toctree.tsx"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AA6BhD;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK,CAAC,aAAwC;IACrF;;OAEG;IACH,MAAM;QACJ,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACpC,OAAO,CACL,0CACE,SAAS,EAAC,4BAA4B,IAClC,EAAE,oBAAoB,EAAE,YAAY,EAAE,GAEzC,IAAI,CAAC,SAAS,EAAE,CACd,CACN,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,SAAS;QACjB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACpC,OAAO,EAAE,CAAC;SACX;QAED,IAAI,WAAW,GAAG,CAAC,CAAC;QAEpB,MAAM,WAAW,GAAG,CAClB,KAAiC,EACjC,KAAa,EACE,EAAE;YACjB,MAAM,MAAM,GAAG,IAAI,KAAK,EAAe,CAAC;YACxC,OAAO,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE;gBACjC,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;gBACnC,IAAI,OAAO,CAAC,KAAK,IAAI,KAAK,EAAE;oBAC1B,WAAW,IAAI,CAAC,CAAC;oBACjB,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;oBAEhC,MAAM,CAAC,IAAI,CACT,oBAAC,mBAAmB,IAClB,GAAG,EAAE,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE,EACvC,QAAQ,EACN,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa;4BAC1B,OAAO,KAAK,IAAI,CAAC,KAAK,CAAC,aAAa,EAEtC,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,EACxC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAEtC,IAAI,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CACxC,CACvB,CAAC;iBACH;qBAAM;oBACL,MAAM;iBACP;aACF;YAED,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxE,CAAC;CACF"}

package/lib/tokens.d.ts

@@ -0,0 +1,235 @@
+import type { ToolbarRegistry } from '@jupyterlab/apputils';
+import type { IObservableList } from '@jupyterlab/observables';
+import type { VDomRenderer } from '@jupyterlab/ui-components';
+import type { JSONObject } from '@lumino/coreutils';
+import { Token } from '@lumino/coreutils';
+import type { IDisposable } from '@lumino/disposable';
+import type { ISignal } from '@lumino/signaling';
+import type { Widget } from '@lumino/widgets';
+/**
+ * Interface describing the table of contents registry.
+ */
+export interface ITableOfContentsRegistry {
+    /**
+     * Finds a table of contents model for a widget.
+     *
+     * ## Notes
+     *
+     * -   If unable to find a table of contents model, the method return `undefined`.
+     *
+     * @param widget - widget
+     * @param configuration - Table of contents configuration
+     * @returns Table of contents model or undefined if not found
+     */
+    getModel(widget: Widget, configuration?: TableOfContents.IConfig): TableOfContents.Model | undefined;
+    /**
+     * Adds a table of contents factory to the registry.
+     *
+     * @param factory - table of contents factory
+     */
+    add(factory: TableOfContents.IFactory): IDisposable;
+}
+/**
+ * Table of contents registry token.
+ */
+export declare const ITableOfContentsRegistry: Token<ITableOfContentsRegistry>;
+/**
+ * Interface for the table of contents tracker
+ */
+export interface ITableOfContentsTracker {
+    /**
+     * Get the model associated with a given widget.
+     *
+     * @param widget Widget
+     */
+    get(widget: Widget): TableOfContents.IModel<TableOfContents.IHeading> | null;
+}
+/**
+ * Table of contents tracker token.
+ */
+export declare const ITableOfContentsTracker: Token<ITableOfContentsTracker>;
+/**
+ * Namespace for table of contents interface
+ */
+export declare namespace TableOfContents {
+    /**
+     * Table of content model factory interface
+     */
+    interface IFactory<W extends Widget = Widget> {
+        /**
+         * Whether the factory can handle the widget or not.
+         *
+         * @param widget - widget
+         * @returns boolean indicating a ToC can be generated
+         */
+        isApplicable: (widget: W) => boolean;
+        /**
+         * Create a new table of contents model for the widget
+         *
+         * @param widget - widget
+         * @param configuration - Table of contents configuration
+         * @returns The table of contents model
+         */
+        createNew: (widget: W, configuration?: TableOfContents.IConfig) => IModel<IHeading>;
+    }
+    /**
+     * Table of Contents configuration
+     *
+     * #### Notes
+     * A document model may ignore some of those options.
+     */
+    interface IConfig extends JSONObject {
+        /**
+         * Base level for the highest headings
+         */
+        baseNumbering: number;
+        /**
+         * Maximal depth of headings to display
+         */
+        maximalDepth: number;
+        /**
+         * Whether to number first-level headings or not.
+         */
+        numberingH1: boolean;
+        /**
+         * Whether to number headings in document or not.
+         */
+        numberHeaders: boolean;
+        /**
+         * Whether to include cell outputs in headings or not.
+         */
+        includeOutput: boolean;
+        /**
+         * Whether to synchronize heading collapse state between the ToC and the document or not.
+         */
+        syncCollapseState: boolean;
+    }
+    /**
+     * Default table of content configuration
+     */
+    const defaultConfig: IConfig;
+    /**
+     * Interface describing a heading.
+     */
+    interface IHeading {
+        /**
+         * Heading text.
+         */
+        text: string;
+        /**
+         * HTML heading level.
+         */
+        level: number;
+        /**
+         * Heading prefix.
+         */
+        prefix?: string | null;
+        /**
+         * Dataset to add to the item node
+         */
+        dataset?: Record<string, string>;
+        /**
+         * Whether the heading is collapsed or not
+         */
+        collapsed?: boolean;
+    }
+    /**
+     * Interface describing a widget table of contents model.
+     */
+    interface IModel<H extends IHeading> extends VDomRenderer.IModel {
+        /**
+         * Active heading
+         */
+        readonly activeHeading: H | null;
+        /**
+         * Signal emitted when the active heading changes.
+         */
+        readonly activeHeadingChanged: ISignal<IModel<H>, H | null>;
+        /**
+         * Signal emitted when a table of content section collapse state changes.
+         *
+         * If all headings state are set at the same time, the argument is null.
+         */
+        readonly collapseChanged: ISignal<IModel<H>, H | null>;
+        /**
+         * Model configuration
+         */
+        readonly configuration: IConfig;
+        /**
+         * Type of document supported by the model.
+         *
+         * #### Notes
+         * A `data-document-type` attribute with this value will be set
+         * on the tree view `.jp-TableOfContents-content[data-document-type="..."]`
+         */
+        readonly documentType: string;
+        /**
+         * Returns the list of headings.
+         *
+         * @returns list of headings
+         */
+        readonly headings: H[];
+        /**
+         * Signal emitted when the headings changes.
+         */
+        readonly headingsChanged: ISignal<IModel<H>, void>;
+        /**
+         * Whether the model needs to be kept up to date or not.
+         *
+         * ### Notes
+         * This is set to `true` if the ToC panel is visible and
+         * to `false` if it is hidden. But some models may require
+         * to be always active; e.g. to add numbering in the document.
+         */
+        isActive: boolean;
+        /**
+         * Set a new active heading.
+         *
+         * @param heading The new active heading
+         * @param emitSignal Whether to emit the activeHeadingChanged signal or not.
+         */
+        setActiveHeading(heading: H | null, emitSignal?: boolean): void;
+        /**
+         * Model configuration setter.
+         *
+         * @param c New configuration
+         */
+        setConfiguration(c: Partial<IConfig>): void;
+        /**
+         * List of configuration options supported by the model.
+         */
+        readonly supportedOptions: (keyof IConfig)[];
+        /**
+         * Document title
+         */
+        title?: string;
+        /**
+         * Callback on heading collapse.
+         *
+         * @param options.heading The heading to change state (all headings if not provided)
+         * @param options.collapsed The new collapsed status (toggle existing status if not provided)
+         */
+        toggleCollapse: (options: {
+            heading?: H;
+            collapsed?: boolean;
+        }) => void;
+    }
+    /**
+     * Generic table of contents type
+     */
+    type Model = IModel<IHeading>;
+    /**
+     * Interface describing table of contents widget options.
+     */
+    interface IOptions {
+        /**
+         * Table of contents model.
+         */
+        model?: IModel<IHeading>;
+    }
+    /**
+     * Interface describing a toolbar item list
+     */
+    interface IToolbarItems extends IObservableList<ToolbarRegistry.IToolbarItem> {
+    }
+}

package/lib/tokens.js

@@ -0,0 +1,29 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { Token } from '@lumino/coreutils';
+/**
+ * Table of contents registry token.
+ */
+export const ITableOfContentsRegistry = new Token('@jupyterlab/toc:ITableOfContentsRegistry');
+/**
+ * Table of contents tracker token.
+ */
+export const ITableOfContentsTracker = new Token('@jupyterlab/toc:ITableOfContentsTracker');
+/**
+ * Namespace for table of contents interface
+ */
+export var TableOfContents;
+(function (TableOfContents) {
+    /**
+     * Default table of content configuration
+     */
+    TableOfContents.defaultConfig = {
+        baseNumbering: 1,
+        maximalDepth: 4,
+        numberingH1: true,
+        numberHeaders: false,
+        includeOutput: true,
+        syncCollapseState: false
+    };
+})(TableOfContents || (TableOfContents = {}));
+//# sourceMappingURL=tokens.js.map

package/lib/tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAM3D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAiC1C;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,KAAK,CAC/C,0CAA0C,CAC3C,CAAC;AAcF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,KAAK,CAC9C,yCAAyC,CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,KAAW,eAAe,CAoN/B;AApND,WAAiB,eAAe;IA2D9B;;OAEG;IACU,6BAAa,GAAY;QACpC,aAAa,EAAE,CAAC;QAChB,YAAY,EAAE,CAAC;QACf,WAAW,EAAE,IAAI;QACjB,aAAa,EAAE,KAAK;QACpB,aAAa,EAAE,IAAI;QACnB,iBAAiB,EAAE,KAAK;KACzB,CAAC;AA+IJ,CAAC,EApNgB,eAAe,KAAf,eAAe,QAoN/B"}