@ckeditor/ckeditor5-document-outline 41.3.1 → 41.4.0-alpha.0

package/dist/translations/vi.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'vi':{'dictionary':{'Empty\x20heading':'Tiêu\x20đề\x20trống','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'Tiêu\x20đề\x20chỉnh\x20sửa\x20sẽ\x20hiện\x20ra\x20ở\x20đây\x20khi\x20bạn\x20nhập.','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'Không\x20tìm\x20thấy\x20tiêu\x20đề\x20nào\x20trong\x20văn\x20bản.','Table\x20of\x20contents':'Mục\x20lục'},'getPluralForm':_0x15b8fa=>0x0}};

package/dist/translations/zh-cn.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type { Translations } from 'ckeditor5';
+declare const translations: Translations;
+export default translations;

package/dist/translations/zh-cn.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'zh-cn':{'dictionary':{'Empty\x20heading':'空标题','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'当你输入时，编辑的标题会出现在这里。','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'文件中未发现标题。','Table\x20of\x20contents':'目录'},'getPluralForm':_0x3c5061=>0x0}};

package/dist/translations/zh.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type { Translations } from 'ckeditor5';
+declare const translations: Translations;
+export default translations;

package/dist/translations/zh.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'zh':{'dictionary':{'Empty\x20heading':'空白標題','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'編輯器標題將在您輸入時出現在此處。','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'無法在此文件中找到標題。','Table\x20of\x20contents':'內容目錄'},'getPluralForm':_0x5e1577=>0x0}};

package/dist/types/augmentation.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { DocumentOutline, DocumentOutlineUtils, DocumentOutlineConfig, DocumentOutlineUI, TableOfContents, TableOfContentsCommand, TableOfContentsEditing, TableOfContentsUI, HeadingId } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:document-outline/documentoutline~DocumentOutline} feature.
+         *
+         * Read more in {@link module:document-outline/documentoutline~DocumentOutlineConfig}.
+         */
+        documentOutline?: DocumentOutlineConfig;
+    }
+    interface PluginsMap {
+        [DocumentOutline.pluginName]: DocumentOutline;
+        [DocumentOutlineUI.pluginName]: DocumentOutlineUI;
+        [DocumentOutlineUtils.pluginName]: DocumentOutlineUtils;
+        [TableOfContents.pluginName]: TableOfContents;
+        [TableOfContentsEditing.pluginName]: TableOfContentsEditing;
+        [TableOfContentsUI.pluginName]: TableOfContentsUI;
+        [HeadingId.pluginName]: HeadingId;
+    }
+    interface CommandsMap {
+        insertTableOfContents: TableOfContentsCommand;
+    }
+}

package/dist/types/documentoutline/documentoutlineui.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/documentoutline/documentoutlineui
+ * @publicApi
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import DocumentOutlineView from './ui/documentoutlineview.js';
+import '../../theme/documentoutline.css';
+/**
+ * Provides the UI for the document outline feature.
+ */
+export default class DocumentOutlineUI extends Plugin {
+    /**
+     * The representation of the document outline view.
+     */
+    view: DocumentOutlineView;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "DocumentOutlineUI";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}

package/dist/types/documentoutline/documentoutlineutils.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/documentoutline/documentoutlineutils
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { type Element } from 'ckeditor5/src/engine.js';
+import { diffToChanges } from 'ckeditor5/src/utils.js';
+/**
+ * Document outline utilities.
+ */
+export default class DocumentOutlineUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "DocumentOutlineUtils";
+    /**
+     * Starts listening for editor events and handles them on the model document `change` event. This means both
+     * changes to the structure of the document and changes to the selection are reflected in the outline.
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}
+/**
+ * The definition of the item in the document outline.
+ */
+export type OutlineItemDefinition = {
+    level: number;
+    text: string;
+    modelElement: Element;
+};
+/**
+ * Fired whenever the headings structure in the document changes.
+ *
+ * @eventName ~DocumentOutlineUtils#change
+ * @param outlineDefinitions The list of current outline definitions.
+ * @param outlineChanges Describes what changes were applied in the headings structure.
+ * @param activeItemIndex The index of the active document outline item.
+ */
+export type OutlineChangeEvent = {
+    name: 'change';
+    args: [
+        {
+            outlineDefinitions: Array<OutlineItemDefinition>;
+            outlineChanges: ReturnType<typeof diffToChanges<OutlineItemDefinition>>;
+            activeItemIndex: number;
+        }
+    ];
+};
+/**
+ * Fired whenever the active document outline item is changed.
+ *
+ * @eventName ~DocumentOutlineUtils#activeItemIndex
+ * @param activeItemIndex The index of the active document outline item.
+ */
+export type ActiveOutlineItemChangeEvent = {
+    name: 'activeItemIndex';
+    args: [{
+        index: number;
+    }];
+};

package/dist/types/documentoutline/ui/documentoutlineitemview.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/documentoutline/ui/documentoutlineitemview
+ */
+import { View } from 'ckeditor5/src/ui.js';
+import { type Locale } from 'ckeditor5/src/utils.js';
+/**
+ * An item of the document outline.
+ */
+export default class DocumentOutlineItemView extends View {
+    /**
+     * The textual content of the item.
+     *
+     * @observable
+     */
+    text: string;
+    /**
+     * The level of heading nesting in the document.
+     *
+     * @observable
+     */
+    level: number;
+    /**
+     * Indicates whether the given item is currently active.
+     *
+     * @observable
+     */
+    isActive: boolean;
+    /**
+     * Indicates whether the heading doesn't have any text.
+     *
+     * @observable
+     */
+    isEmpty: boolean;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale: Locale, showEmptyHeadingText?: boolean);
+}
+/**
+ * Fired whenever an item in the document outline is clicked.
+ *
+ * @eventName ~DocumentOutlineItemView#click
+ */
+export type DocumentOutlineItemViewClickEvent = {
+    name: 'click';
+    args: [];
+};

package/dist/types/documentoutline/ui/documentoutlineview.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/documentoutline/ui/documentoutlineview
+ */
+import { View, type ViewCollection } from 'ckeditor5/src/ui.js';
+import { type Locale, type diffToChanges } from 'ckeditor5/src/utils.js';
+import type { OutlineItemDefinition } from '../documentoutlineutils.js';
+import DocumentOutlineItemView from './documentoutlineitemview.js';
+/**
+ * The document outline panel.
+ */
+export default class DocumentOutlineView extends View {
+    /**
+     * A collection of document outline items.
+     */
+    readonly items: ViewCollection<DocumentOutlineItemView>;
+    /**
+     * Indicates which item is active at the moment.
+     *
+     * @observable
+     */
+    activeItemIndex: number;
+    /**
+     * Creates an instance of the {@link module:documentoutline/ui/documentoutlineview~DocumentOutlineView} class.
+     *
+     * @param locale The localization services instance.
+     * @param showEmptyHeadingText Indicates whether the display of a placeholder for empty heading is enabled in the editor.
+     * @param containerElement The element that contains the document outline.
+     */
+    constructor(locale: Locale, showEmptyHeadingText?: boolean, containerElement?: HTMLElement);
+    /**
+     * If a heading was added or deleted in the editor, insert or delete it in the document outline.
+     */
+    sync(changesInItems: ReturnType<typeof diffToChanges<OutlineItemDefinition>>): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}
+/**
+ * Fired whenever an item in the document outline is clicked.
+ *
+ * @eventName ~DocumentOutlineView#itemSelected
+ * @param itemIndex Index of selected item.
+ */
+export type DocumentOutlineViewItemSelectedEvent = {
+    name: 'itemSelected';
+    args: [itemIndex: number];
+};

package/dist/types/documentoutline/utils.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/documentoutline/utils
+ */
+import { type Element } from 'ckeditor5/src/engine.js';
+import { type Editor } from 'ckeditor5/src/core.js';
+/**
+ * Returns all text contents that are inside the given element and all its children.
+ */
+export declare function getElementText(element: Element): string;
+/**
+ * Returns a list of standard headings or GHS headings configured in the editor.
+ */
+export declare function getDefaultFeatureHeadingNames(editor: Editor): Array<string>;

package/dist/types/documentoutline.d.ts

@@ -0,0 +1,103 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/documentoutline
+ * @publicApi
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import DocumentOutlineUtils from './documentoutline/documentoutlineutils.js';
+import DocumentOutlineUI from './documentoutline/documentoutlineui.js';
+/**
+ * The document outline feature.
+ * It allows for an easy access to a predefined list of headings in the document.
+ */
+export default class DocumentOutline extends Plugin {
+    licenseKey: string;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof DocumentOutlineUtils, typeof DocumentOutlineUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "DocumentOutline";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}
+/**
+ * The configuration of the {@link module:document-outline/documentoutline~DocumentOutline document outline feature}.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		documentOutline:  ... // Document outline feature configuration.
+ * 	} )
+ * 	.then( /* ... *\/ )
+ * 	.catch( /* ... *\/ );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface DocumentOutlineConfig {
+    /**
+     * The container element for the document outline to render. This should be a reference to an existing
+     * container element in the DOM.
+     */
+    container?: HTMLElement;
+    /**
+     * An array of {@glink framework/architecture/editing-engine#model model} element names considered
+     * as headings in the document outline.
+     *
+     * The index of the heading in the array reflects the heading nesting level. It can be used e.g. for reducing
+     * the number of visible headings.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( editorElement, {
+     * 		plugins: [ DocumentOutline, /* ... *\/ ],
+     * 		documentOutline: {
+     * 			headings: [ 'heading1', 'heading2', /* ... *\/ ],
+     * 			// ...
+     * 		}
+     * 	} )
+     * 	.then( /* ... *\/ )
+     * 	.catch( /* ... *\/ );
+     * ```
+     *
+     * If this configuration is not defined, the feature will use the following defaults instead:
+     *
+     * 1. If the {@glink features/headings Headings feature} is loaded, it equals
+     * * {@link module:heading/headingconfig~HeadingConfig#options `config.heading.options`}.
+     * * `[ 'heading1', 'heading2', 'heading3' ]` if `config.heading.options` is not defined.
+     * 2. If the {@glink features/html/general-html-support General HTML Support} feature is loaded, it equals
+     * `[ 'htmlH1', 'htmlH2', 'htmlH3', 'htmlH4', 'htmlH5', 'htmlH6' ]`.
+     *
+     * **Note**: The Headings feature takes precedence over the General HTML Support feature when
+     * both are loaded.
+     */
+    headings?: Array<string>;
+    /**
+     * Allows you to display a placeholder text: [Empty heading] for empty headings.
+     *
+     * By default, the display of a placeholder is disabled. To enable it, set this parameter to true.
+     *
+     * **Note**: This setting also affects Table of contents feature.
+     */
+    showEmptyHeadings?: boolean;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline
+ */
+export { default as DocumentOutline, type DocumentOutlineConfig } from './documentoutline.js';
+export { default as DocumentOutlineUI } from './documentoutline/documentoutlineui.js';
+export { default as DocumentOutlineUtils } from './documentoutline/documentoutlineutils.js';
+export { default as TableOfContents } from './tableofcontents.js';
+export { default as TableOfContentsCommand } from './tableofcontents/tableofcontentscommand.js';
+export { default as TableOfContentsEditing } from './tableofcontents/tableofcontentsediting.js';
+export { default as TableOfContentsUI } from './tableofcontents/tableofcontentsui.js';
+export { default as HeadingId } from './tableofcontents/headingid.js';
+import './augmentation.js';

package/dist/types/tableofcontents/headingid.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The heading ID plugin. It adds support for the ID attribute on the heading[1-6] (model) and h[1-6] (data/view) elements.
+ */
+export default class HeadingId extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "HeadingId";
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/tableofcontents/tableofcontentscommand.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/tableofcontents/tableofcontentscommand
+ * @publicApi
+ */
+import { Command } from 'ckeditor5/src/core.js';
+export default class TableOfContentsCommand extends Command {
+    /**
+     * Executes the command. Inserts the table of content into the model.
+     *
+     * @fires execute
+     */
+    execute(): void;
+    /**
+     * If the selection is wrong, the command is not enabled.
+     */
+    refresh(): void;
+}

package/dist/types/tableofcontents/tableofcontentsediting.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/tableofcontents/tableofcontentsediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { Widget } from 'ckeditor5/src/widget.js';
+import '../../theme/tableofcontents.css';
+import DocumentOutlineUtils from '../documentoutline/documentoutlineutils.js';
+import HeadingId from './headingid.js';
+/**
+ * The table of contents editing plugin.
+ */
+export default class TableOfContentsEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TableOfContentsEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Widget, typeof DocumentOutlineUtils, typeof HeadingId];
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}

package/dist/types/tableofcontents/tableofcontentsui.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The UI plugin of the table of contents feature.
+ */
+export default class TableOfContentsUI extends Plugin {
+    licenseKey: string;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TableOfContentsUI";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}

package/dist/types/tableofcontents.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module document-outline/tableofcontents
+ * @publicApi
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import TableOfContentsEditing from './tableofcontents/tableofcontentsediting.js';
+import TableOfContentsUI from './tableofcontents/tableofcontentsui.js';
+/**
+ * The table of contents feature.
+ *
+ * For a detailed overview, check the {@glink features/table-of-contents Table of contents} feature documentation.
+ */
+export default class TableOfContents extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TableOfContentsEditing, typeof TableOfContentsUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TableOfContents";
+}