@ckeditor/ckeditor5-document-outline 48.2.0 → 48.3.0-alpha.0

package/dist/augmentation.d.ts

@@ -1,33 +1,33 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { DocumentOutline, DocumentOutlineUtils, DocumentOutlineConfig, DocumentOutlineUI, TableOfContents, DocumentOutlineTableOfContentsConfig, 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;
-        /**
-         * The configuration of the {@link module:document-outline/tableofcontents~TableOfContents} feature.
-         *
-         * Read more in {@link module:document-outline/tableofcontents~DocumentOutlineTableOfContentsConfig}.
-         */
-        tableOfContents?: DocumentOutlineTableOfContentsConfig;
-    }
-    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;
-    }
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import type { DocumentOutline, DocumentOutlineUtils, DocumentOutlineConfig, DocumentOutlineUI, TableOfContents, DocumentOutlineTableOfContentsConfig, 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;
+		/**
+		* The configuration of the {@link module:document-outline/tableofcontents~TableOfContents} feature.
+		*
+		* Read more in {@link module:document-outline/tableofcontents~DocumentOutlineTableOfContentsConfig}.
+		*/
+		tableOfContents?: DocumentOutlineTableOfContentsConfig;
+	}
+	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/documentoutline/documentoutlineui.d.ts

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

package/dist/documentoutline/documentoutlineutils.d.ts

@@ -1,74 +1,72 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module document-outline/documentoutline/documentoutlineutils
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { type ModelElement } from '@ckeditor/ckeditor5-engine';
-import { diffToChanges } from '@ckeditor/ckeditor5-utils';
+* @module document-outline/documentoutline/documentoutlineutils
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
+import { type ModelElement } from "@ckeditor/ckeditor5-engine";
+import { diffToChanges } from "@ckeditor/ckeditor5-utils";
 /**
- * Document outline utilities.
- */
+* Document outline utilities.
+*/
 export declare class DocumentOutlineUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "DocumentOutlineUtils";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * 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;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "DocumentOutlineUtils";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* 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.
- */
+* The definition of the item in the document outline.
+*/
 export type OutlineItemDefinition = {
-    level: number;
-    text: string;
-    modelElement: ModelElement;
+	level: number;
+	text: string;
+	modelElement: ModelElement;
 };
 /**
- * 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.
- */
+* 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;
-        }
-    ];
+	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.
- */
+* 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;
-    }];
+	name: "activeItemIndex";
+	args: [{
+		index: number;
+	}];
 };

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

@@ -1,51 +1,51 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module document-outline/documentoutline/ui/documentoutlineitemview
- */
-import { View } from '@ckeditor/ckeditor5-ui';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
+* @module document-outline/documentoutline/ui/documentoutlineitemview
+*/
+import { View } from "@ckeditor/ckeditor5-ui";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
 /**
- * An item of the document outline.
- */
+* An item of the document outline.
+*/
 export declare 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);
+	/**
+	* 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
- */
+* Fired whenever an item in the document outline is clicked.
+*
+* @eventName ~DocumentOutlineItemView#click
+*/
 export type DocumentOutlineItemViewClickEvent = {
-    name: 'click';
-    args: [];
+	name: "click";
+	args: [];
 };

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

@@ -1,57 +1,57 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module document-outline/documentoutline/ui/documentoutlineview
- */
-import { View, type ViewCollection } from '@ckeditor/ckeditor5-ui';
-import { type Locale, type diffToChanges } from '@ckeditor/ckeditor5-utils';
-import type { OutlineItemDefinition } from '../documentoutlineutils.js';
-import { DocumentOutlineItemView } from './documentoutlineitemview.js';
+* @module document-outline/documentoutline/ui/documentoutlineview
+*/
+import { View, type ViewCollection } from "@ckeditor/ckeditor5-ui";
+import { type Locale, type diffToChanges } from "@ckeditor/ckeditor5-utils";
+import type { OutlineItemDefinition } from "../documentoutlineutils.js";
+import { DocumentOutlineItemView } from "./documentoutlineitemview.js";
 /**
- * The document outline panel.
- */
+* The document outline panel.
+*/
 export declare 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;
-    /**
-     * The element that contains the document outline.
-     *
-     */
-    documentOutlineContainer?: HTMLElement;
-    /**
-     * 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;
+	/**
+	* A collection of document outline items.
+	*/
+	readonly items: ViewCollection<DocumentOutlineItemView>;
+	/**
+	* Indicates which item is active at the moment.
+	*
+	* @observable
+	*/
+	activeItemIndex: number;
+	/**
+	* The element that contains the document outline.
+	*
+	*/
+	documentOutlineContainer?: HTMLElement;
+	/**
+	* 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
+	*/
+	override destroy(): void;
 }
 /**
- * Fired whenever an item in the document outline is clicked.
- *
- * @eventName ~DocumentOutlineView#itemSelected
- * @param itemIndex Index of selected item.
- */
+* 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];
+	name: "itemSelected";
+	args: [itemIndex: number];
 };

package/dist/documentoutline/utils.d.ts

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