@jupyterlab/toc 5.4.1 → 6.0.0-alpha.10

package/lib/factory.d.ts

@@ -0,0 +1,42 @@
+import { IWidgetTracker } from '@jupyterlab/apputils';
+import { IDocumentWidget } from '@jupyterlab/docregistry';
+import { Widget } from '@lumino/widgets';
+import { TableOfContentsModel } from './model';
+import { TableOfContents } from './tokens';
+/**
+ * Abstract table of contents model factory for IDocumentWidget.
+ */
+export declare abstract class TableOfContentsFactory<W extends IDocumentWidget> implements TableOfContents.IFactory<W> {
+    protected tracker: IWidgetTracker<W>;
+    /**
+     * Constructor
+     *
+     * @param tracker Widget tracker
+     */
+    constructor(tracker: IWidgetTracker<W>);
+    /**
+     * Whether the factory can handle the widget or not.
+     *
+     * @param widget - widget
+     * @returns boolean indicating a ToC can be generated
+     */
+    isApplicable(widget: Widget): 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): TableOfContentsModel<TableOfContents.IHeading, W>;
+    /**
+     * Abstract table of contents model instantiation to allow
+     * override by real implementation to customize it. The public
+     * `createNew` contains the signal connections standards for IDocumentWidget
+     * when the model has been instantiated.
+     *
+     * @param widget
+     * @param configuration
+     */
+    protected abstract _createNew(widget: W, configuration?: TableOfContents.IConfig): TableOfContentsModel<TableOfContents.IHeading, W>;
+}

package/lib/factory.js

@@ -0,0 +1,73 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { ActivityMonitor, PathExt } from '@jupyterlab/coreutils';
+/**
+ * Timeout for throttling ToC rendering following model changes.
+ *
+ * @private
+ */
+const RENDER_TIMEOUT = 1000;
+/**
+ * Abstract table of contents model factory for IDocumentWidget.
+ */
+export class TableOfContentsFactory {
+    /**
+     * Constructor
+     *
+     * @param tracker Widget tracker
+     */
+    constructor(tracker) {
+        this.tracker = tracker;
+    }
+    /**
+     * Whether the factory can handle the widget or not.
+     *
+     * @param widget - widget
+     * @returns boolean indicating a ToC can be generated
+     */
+    isApplicable(widget) {
+        if (!this.tracker.has(widget)) {
+            return false;
+        }
+        return true;
+    }
+    /**
+     * 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, configuration) {
+        const model = this._createNew(widget, configuration);
+        const context = widget.context;
+        const updateHeadings = () => {
+            model.refresh().catch(reason => {
+                console.error('Failed to update the table of contents.', reason);
+            });
+        };
+        const monitor = new ActivityMonitor({
+            signal: context.model.contentChanged,
+            timeout: RENDER_TIMEOUT
+        });
+        monitor.activityStopped.connect(updateHeadings);
+        const updateTitle = () => {
+            model.title = PathExt.basename(context.localPath);
+        };
+        context.pathChanged.connect(updateTitle);
+        context.ready
+            .then(() => {
+            updateTitle();
+            updateHeadings();
+        })
+            .catch(reason => {
+            console.error(`Failed to initiate headings for ${context.localPath}.`);
+        });
+        widget.disposed.connect(() => {
+            monitor.activityStopped.disconnect(updateHeadings);
+            context.pathChanged.disconnect(updateTitle);
+        });
+        return model;
+    }
+}
+//# sourceMappingURL=factory.js.map

package/lib/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAG3D,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAMjE;;;;GAIG;AACH,MAAM,cAAc,GAAG,IAAI,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAgB,sBAAsB;IAG1C;;;;OAIG;IACH,YAAsB,OAA0B;QAA1B,YAAO,GAAP,OAAO,CAAmB;IAAG,CAAC;IAEpD;;;;;OAKG;IACH,YAAY,CAAC,MAAc;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC7B,OAAO,KAAK,CAAC;SACd;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CACP,MAAS,EACT,aAAuC;QAEvC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAE/B,MAAM,cAAc,GAAG,GAAG,EAAE;YAC1B,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;gBAC7B,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC;YAClC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,cAAc;YACpC,OAAO,EAAE,cAAc;SACxB,CAAC,CAAC;QACH,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEhD,MAAM,WAAW,GAAG,GAAG,EAAE;YACvB,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC,CAAC;QACF,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEzC,OAAO,CAAC,KAAK;aACV,IAAI,CAAC,GAAG,EAAE;YACT,WAAW,EAAE,CAAC;YACd,cAAc,EAAE,CAAC;QACnB,CAAC,CAAC;aACD,KAAK,CAAC,MAAM,CAAC,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,mCAAmC,OAAO,CAAC,SAAS,GAAG,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEL,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE;YAC3B,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YACnD,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC;CAeF"}

package/lib/index.d.ts

@@ -2,8 +2,13 @@
  * @packageDocumentation
  * @module toc
  */
-export * from './generators';
+export * from './factory';
+export * from './model';
+export * from './panel';
 export * from './registry';
-export * from './toc';
-export * from './toc_item';
-export * from './utils/headings';
+export * from './treeview';
+export * from './tocitem';
+export * from './toctree';
+export * from './tokens';
+export * from './tracker';
+export * as TableOfContentsUtils from './utils';

package/lib/index.js

@@ -4,10 +4,15 @@
  * @packageDocumentation
  * @module toc
  */
-// Note: keep in alphabetical order...
-export * from './generators';
+export * from './factory';
+export * from './model';
+export * from './panel';
 export * from './registry';
-export * from './toc';
-export * from './toc_item';
-export * from './utils/headings';
+export * from './treeview';
+export * from './tocitem';
+export * from './toctree';
+export * from './tokens';
+export * from './tracker';
+// Namespace the utils
+export * as TableOfContentsUtils from './utils';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,sCAAsC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,sBAAsB;AACtB,OAAO,KAAK,oBAAoB,MAAM,SAAS,CAAC"}

package/lib/model.d.ts

@@ -0,0 +1,117 @@
+import { VDomModel } from '@jupyterlab/ui-components';
+import { ISignal } from '@lumino/signaling';
+import { Widget } from '@lumino/widgets';
+import { TableOfContents } from './tokens';
+/**
+ * Abstract table of contents model.
+ */
+export declare abstract class TableOfContentsModel<H extends TableOfContents.IHeading, T extends Widget = Widget> extends VDomModel implements TableOfContents.IModel<H> {
+    protected widget: T;
+    /**
+     * Constructor
+     *
+     * @param widget The widget to search in
+     * @param configuration Default model configuration
+     */
+    constructor(widget: T, configuration?: TableOfContents.IConfig);
+    /**
+     * Current active entry.
+     *
+     * @returns table of contents active entry
+     */
+    get activeHeading(): H | null;
+    set activeHeading(heading: H | null);
+    /**
+     * Signal emitted when the active heading changes.
+     */
+    get activeHeadingChanged(): ISignal<TableOfContents.IModel<H>, H | null>;
+    /**
+     * Signal emitted when a table of content section collapse state changes.
+     */
+    get collapseChanged(): ISignal<TableOfContents.IModel<H>, H | null>;
+    /**
+     * Model configuration
+     */
+    get configuration(): TableOfContents.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="..."]`
+     */
+    abstract readonly documentType: string;
+    /**
+     * List of headings.
+     *
+     * @returns table of contents list of headings
+     */
+    get headings(): H[];
+    /**
+     * Signal emitted when the headings changes.
+     */
+    get headingsChanged(): ISignal<TableOfContents.IModel<H>, void>;
+    /**
+     * Whether the model is active or not.
+     *
+     * #### Notes
+     * An active model means it is displayed in the table of contents.
+     * This can be used by subclass to limit updating the headings.
+     */
+    get isActive(): boolean;
+    set isActive(v: boolean);
+    /**
+     * Whether the model gets updated even if the table of contents panel
+     * is hidden or not.
+     *
+     * #### Notes
+     * For example, ToC models use to add title numbering will
+     * set this to true.
+     */
+    protected get isAlwaysActive(): boolean;
+    /**
+     * Model configuration setter.
+     *
+     * @param c New configuration
+     */
+    setConfiguration(c: Partial<TableOfContents.IConfig>): void;
+    /**
+     * List of configuration options supported by the model.
+     */
+    get supportedOptions(): (keyof TableOfContents.IConfig)[];
+    /**
+     * Document title
+     */
+    get title(): string | undefined;
+    set title(v: string | undefined);
+    /**
+     * Abstract function that will produce the headings for a document.
+     *
+     * @returns The list of new headings or `null` if nothing needs to be updated.
+     */
+    protected abstract getHeadings(): Promise<H[] | null>;
+    /**
+     * Refresh the headings list.
+     */
+    refresh(): Promise<void>;
+    /**
+     * 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;
+    private _activeHeading;
+    private _activeHeadingChanged;
+    private _collapseChanged;
+    private _configuration;
+    private _headings;
+    private _headingsChanged;
+    private _isActive;
+    private _isRefreshing;
+    private _needsRefreshing;
+    private _title?;
+}

package/lib/model.js

@@ -0,0 +1,218 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { VDomModel } from '@jupyterlab/ui-components';
+import { JSONExt } from '@lumino/coreutils';
+import { Signal } from '@lumino/signaling';
+import { TableOfContents } from './tokens';
+/**
+ * Abstract table of contents model.
+ */
+export class TableOfContentsModel extends VDomModel {
+    /**
+     * Constructor
+     *
+     * @param widget The widget to search in
+     * @param configuration Default model configuration
+     */
+    constructor(widget, configuration) {
+        super();
+        this.widget = widget;
+        this._activeHeading = null;
+        this._activeHeadingChanged = new Signal(this);
+        this._collapseChanged = new Signal(this);
+        this._configuration = configuration !== null && configuration !== void 0 ? configuration : Object.assign({}, TableOfContents.defaultConfig);
+        this._headings = new Array();
+        this._headingsChanged = new Signal(this);
+        this._isActive = false;
+        this._isRefreshing = false;
+        this._needsRefreshing = false;
+    }
+    /**
+     * Current active entry.
+     *
+     * @returns table of contents active entry
+     */
+    get activeHeading() {
+        return this._activeHeading;
+    }
+    set activeHeading(heading) {
+        if (this._activeHeading !== heading) {
+            this._activeHeading = heading;
+            this.stateChanged.emit();
+            this._activeHeadingChanged.emit(heading);
+        }
+    }
+    /**
+     * Signal emitted when the active heading changes.
+     */
+    get activeHeadingChanged() {
+        return this._activeHeadingChanged;
+    }
+    /**
+     * Signal emitted when a table of content section collapse state changes.
+     */
+    get collapseChanged() {
+        return this._collapseChanged;
+    }
+    /**
+     * Model configuration
+     */
+    get configuration() {
+        return this._configuration;
+    }
+    /**
+     * List of headings.
+     *
+     * @returns table of contents list of headings
+     */
+    get headings() {
+        return this._headings;
+    }
+    /**
+     * Signal emitted when the headings changes.
+     */
+    get headingsChanged() {
+        return this._headingsChanged;
+    }
+    /**
+     * Whether the model is active or not.
+     *
+     * #### Notes
+     * An active model means it is displayed in the table of contents.
+     * This can be used by subclass to limit updating the headings.
+     */
+    get isActive() {
+        return this._isActive;
+    }
+    set isActive(v) {
+        this._isActive = v;
+        // Refresh on activation expect if it is always active
+        //  => a ToC model is always active e.g. when displaying numbering in the document
+        if (this._isActive && !this.isAlwaysActive) {
+            this.refresh().catch(reason => {
+                console.error('Failed to refresh ToC model.', reason);
+            });
+        }
+    }
+    /**
+     * Whether the model gets updated even if the table of contents panel
+     * is hidden or not.
+     *
+     * #### Notes
+     * For example, ToC models use to add title numbering will
+     * set this to true.
+     */
+    get isAlwaysActive() {
+        return false;
+    }
+    /**
+     * Model configuration setter.
+     *
+     * @param c New configuration
+     */
+    setConfiguration(c) {
+        const newConfiguration = Object.assign(Object.assign({}, this._configuration), c);
+        if (!JSONExt.deepEqual(this._configuration, newConfiguration)) {
+            this._configuration = newConfiguration;
+            this.refresh().catch(reason => {
+                console.error('Failed to update the table of contents.', reason);
+            });
+        }
+    }
+    /**
+     * List of configuration options supported by the model.
+     */
+    get supportedOptions() {
+        return ['maximalDepth'];
+    }
+    /**
+     * Document title
+     */
+    get title() {
+        return this._title;
+    }
+    set title(v) {
+        if (v !== this._title) {
+            this._title = v;
+            this.stateChanged.emit();
+        }
+    }
+    /**
+     * Refresh the headings list.
+     */
+    async refresh() {
+        if (this._isRefreshing) {
+            // Schedule a refresh if one is in progress
+            this._needsRefreshing = true;
+            return Promise.resolve();
+        }
+        this._isRefreshing = true;
+        try {
+            const newHeadings = await this.getHeadings();
+            if (this._needsRefreshing) {
+                this._needsRefreshing = false;
+                this._isRefreshing = false;
+                return this.refresh();
+            }
+            if (newHeadings &&
+                !Private.areHeadingsEqual(newHeadings, this._headings)) {
+                this._headings = newHeadings;
+                this.stateChanged.emit();
+                this._headingsChanged.emit();
+            }
+        }
+        finally {
+            this._isRefreshing = false;
+        }
+    }
+    /**
+     * 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) {
+        var _a, _b;
+        if (options.heading) {
+            options.heading.collapsed =
+                (_a = options.collapsed) !== null && _a !== void 0 ? _a : !options.heading.collapsed;
+            this.stateChanged.emit();
+            this._collapseChanged.emit(options.heading);
+        }
+        else {
+            // Use the provided state or collapsed all except if all are collapsed
+            const newState = (_b = options.collapsed) !== null && _b !== void 0 ? _b : !this.headings.some(h => { var _a; return !((_a = h.collapsed) !== null && _a !== void 0 ? _a : false); });
+            this.headings.forEach(h => (h.collapsed = newState));
+            this.stateChanged.emit();
+            this._collapseChanged.emit(null);
+        }
+    }
+}
+/**
+ * Private functions namespace
+ */
+var Private;
+(function (Private) {
+    /**
+     * Test if two list of headings are equal or not.
+     *
+     * @param headings1 First list of headings
+     * @param headings2 Second list of headings
+     * @returns Whether the array are identical or not.
+     */
+    function areHeadingsEqual(headings1, headings2) {
+        if (headings1.length === headings2.length) {
+            for (let i = 0; i < headings1.length; i++) {
+                if (headings1[i].level !== headings2[i].level ||
+                    headings1[i].text !== headings2[i].text ||
+                    headings1[i].prefix !== headings2[i].prefix) {
+                    return false;
+                }
+            }
+            return true;
+        }
+        return false;
+    }
+    Private.areHeadingsEqual = areHeadingsEqual;
+})(Private || (Private = {}));
+//# sourceMappingURL=model.js.map

package/lib/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAW,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAgB,oBAIpB,SAAQ,SAAS;IAGjB;;;;;OAKG;IACH,YAAsB,MAAS,EAAE,aAAuC;QACtE,KAAK,EAAE,CAAC;QADY,WAAM,GAAN,MAAM,CAAG;QAE7B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,qBAAqB,GAAG,IAAI,MAAM,CAGrC,IAAI,CAAC,CAAC;QACR,IAAI,CAAC,gBAAgB,GAAG,IAAI,MAAM,CAAgC,IAAI,CAAC,CAAC;QACxE,IAAI,CAAC,cAAc,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,qBAAS,eAAe,CAAC,aAAa,CAAE,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,EAAK,CAAC;QAChC,IAAI,CAAC,gBAAgB,GAAG,IAAI,MAAM,CAAmC,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IACD,IAAI,aAAa,CAAC,OAAiB;QACjC,IAAI,IAAI,CAAC,cAAc,KAAK,OAAO,EAAE;YACnC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;YAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC1C;IACH,CAAC;IAED;;OAEG;IACH,IAAI,oBAAoB;QACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAWD;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IACD,IAAI,QAAQ,CAAC,CAAU;QACrB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,sDAAsD;QACtD,kFAAkF;QAClF,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YAC1C,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;gBAC5B,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;;;;OAOG;IACH,IAAc,cAAc;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,CAAmC;QAClD,MAAM,gBAAgB,mCAAQ,IAAI,CAAC,cAAc,GAAK,CAAC,CAAE,CAAC;QAC1D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,gBAAgB,CAAC,EAAE;YAC7D,IAAI,CAAC,cAAc,GAAG,gBAA2C,CAAC;YAClE,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;gBAC5B,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;OAEG;IACH,IAAI,gBAAgB;QAClB,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAI,KAAK,CAAC,CAAqB;QAC7B,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE;YACrB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YAChB,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;SAC1B;IACH,CAAC;IASD;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,2CAA2C;YAC3C,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAC7B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI;YACF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAE7C,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACzB,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;gBAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;gBAC3B,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;aACvB;YAED,IACE,WAAW;gBACX,CAAC,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,EACtD;gBACA,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC;gBAC7B,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;gBACzB,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;aAC9B;SACF;gBAAS;YACR,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;SAC5B;IACH,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,OAA6C;;QAC1D,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO,CAAC,OAAO,CAAC,SAAS;gBACvB,MAAA,OAAO,CAAC,SAAS,mCAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC;YAClD,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAC7C;aAAM;YACL,sEAAsE;YACtE,MAAM,QAAQ,GACZ,MAAA,OAAO,CAAC,SAAS,mCAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAC,OAAA,CAAC,CAAC,MAAA,CAAC,CAAC,SAAS,mCAAI,KAAK,CAAC,CAAA,EAAA,CAAC,CAAC;YACzE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC;YACrD,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAClC;IACH,CAAC;CAYF;AAED;;GAEG;AACH,IAAU,OAAO,CA2BhB;AA3BD,WAAU,OAAO;IACf;;;;;;OAMG;IACH,SAAgB,gBAAgB,CAC9B,SAAqC,EACrC,SAAqC;QAErC,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,EAAE;YACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACzC,IACE,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK;oBACzC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;oBACvC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,EAC3C;oBACA,OAAO,KAAK,CAAC;iBACd;aACF;YACD,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAlBe,wBAAgB,mBAkB/B,CAAA;AACH,CAAC,EA3BS,OAAO,KAAP,OAAO,QA2BhB"}

package/lib/panel.d.ts

@@ -0,0 +1,26 @@
+import { ITranslator } from '@jupyterlab/translation';
+import { SidePanel } from '@jupyterlab/ui-components';
+import { TableOfContents } from './tokens';
+import { Message } from '@lumino/messaging';
+/**
+ * Table of contents sidebar panel.
+ */
+export declare class TableOfContentsPanel extends SidePanel {
+    /**
+     * Constructor
+     *
+     * @param translator - Translator tool
+     */
+    constructor(translator?: ITranslator);
+    /**
+     * Get the current model.
+     */
+    get model(): TableOfContents.Model | null;
+    set model(newValue: TableOfContents.Model | null);
+    protected onAfterHide(msg: Message): void;
+    protected onBeforeShow(msg: Message): void;
+    private _onTitleChanged;
+    private _model;
+    private _title;
+    private _treeview;
+}

package/lib/panel.js

@@ -0,0 +1,89 @@
+import { SidePanel } from '@jupyterlab/ui-components';
+import { Panel, Widget } from '@lumino/widgets';
+import { TableOfContentsWidget } from './treeview';
+/**
+ * Table of contents sidebar panel.
+ */
+export class TableOfContentsPanel extends SidePanel {
+    /**
+     * Constructor
+     *
+     * @param translator - Translator tool
+     */
+    constructor(translator) {
+        super({ content: new Panel(), translator });
+        this._model = null;
+        this.addClass('jp-TableOfContents');
+        this._title = new Private.Header(this._trans.__('Table of Contents'));
+        this.header.addWidget(this._title);
+        this._treeview = new TableOfContentsWidget();
+        this._treeview.addClass('jp-TableOfContents-tree');
+        this.content.addWidget(this._treeview);
+    }
+    /**
+     * Get the current model.
+     */
+    get model() {
+        return this._model;
+    }
+    set model(newValue) {
+        var _a, _b;
+        if (this._model !== newValue) {
+            (_a = this._model) === null || _a === void 0 ? void 0 : _a.stateChanged.disconnect(this._onTitleChanged, this);
+            this._model = newValue;
+            if (this._model) {
+                this._model.isActive = this.isVisible;
+            }
+            (_b = this._model) === null || _b === void 0 ? void 0 : _b.stateChanged.connect(this._onTitleChanged, this);
+            this._onTitleChanged();
+            this._treeview.model = this._model;
+        }
+    }
+    onAfterHide(msg) {
+        super.onAfterHide(msg);
+        if (this._model) {
+            this._model.isActive = false;
+        }
+    }
+    onBeforeShow(msg) {
+        super.onBeforeShow(msg);
+        if (this._model) {
+            this._model.isActive = true;
+        }
+    }
+    _onTitleChanged() {
+        var _a, _b;
+        this._title.setTitle((_b = (_a = this._model) === null || _a === void 0 ? void 0 : _a.title) !== null && _b !== void 0 ? _b : this._trans.__('Table of Contents'));
+    }
+}
+/**
+ * Private helpers namespace
+ */
+var Private;
+(function (Private) {
+    /**
+     * Panel header
+     */
+    class Header extends Widget {
+        /**
+         * Constructor
+         *
+         * @param title - Title text
+         */
+        constructor(title) {
+            const node = document.createElement('h2');
+            node.textContent = title;
+            node.classList.add('jp-text-truncated');
+            super({ node });
+            this._title = node;
+        }
+        /**
+         * Set the header title.
+         */
+        setTitle(title) {
+            this._title.textContent = title;
+        }
+    }
+    Private.Header = Header;
+})(Private || (Private = {}));
+//# sourceMappingURL=panel.js.map

package/lib/panel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"panel.js","sourceRoot":"","sources":["../src/panel.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAInD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,SAAS;IACjD;;;;OAIG;IACH,YAAY,UAAwB;QAClC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,KAAK,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAEnB,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;QAEpC,IAAI,CAAC,MAAM,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAC7C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,IAAI,KAAK,CAAC,QAAsC;;QAC9C,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;YAC5B,MAAA,IAAI,CAAC,MAAM,0CAAE,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAEjE,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;YACvB,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;aACvC;YAED,MAAA,IAAI,CAAC,MAAM,0CAAE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAC9D,IAAI,CAAC,eAAe,EAAE,CAAC;YAEvB,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;SACpC;IACH,CAAC;IAES,WAAW,CAAC,GAAY;QAChC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;SAC9B;IACH,CAAC;IAES,YAAY,CAAC,GAAY;QACjC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;SAC7B;IACH,CAAC;IAEO,eAAe;;QACrB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAClB,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,mCAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAC1D,CAAC;IACJ,CAAC;CAKF;AAED;;GAEG;AACH,IAAU,OAAO,CA2BhB;AA3BD,WAAU,OAAO;IACf;;OAEG;IACH,MAAa,MAAO,SAAQ,MAAM;QAChC;;;;WAIG;QACH,YAAY,KAAa;YACvB,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACxC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YAChB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QAED;;WAEG;QACH,QAAQ,CAAC,KAAa;YACpB,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;QAClC,CAAC;KAGF;IAtBY,cAAM,SAsBlB,CAAA;AACH,CAAC,EA3BS,OAAO,KAAP,OAAO,QA2BhB"}