@ckeditor/ckeditor5-document-outline 44.1.0 → 44.2.0-alpha.0

package/theme/documentoutline.css

@@ -3,7 +3,7 @@
  * CKEditor 5 Collaboration is licensed under a commercial license and protected by copyright law. Where not otherwise indicated,
  * all CKEditor 5 Collaboration content is authored by CKSource engineers and consists of CKSource-owned intellectual property.
  *
- * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 

package/theme/tableofcontents.css

@@ -3,7 +3,7 @@
  * CKEditor 5 Collaboration is licensed under a commercial license and protected by copyright law. Where not otherwise indicated,
  * all CKEditor 5 Collaboration content is authored by CKSource engineers and consists of CKSource-owned intellectual property.
  *
- * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 

package/dist/augmentation.d.ts

@@ -1,31 +0,0 @@
-/**
- * @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-licensing-options
- */
-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/documentoutline/documentoutlineui.d.ts

@@ -1,52 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}

package/dist/documentoutline/documentoutlineutils.d.ts

@@ -1,78 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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";
-    /**
-     * @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;
-}
-/**
- * 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/documentoutline/ui/documentoutlineitemview.d.ts

@@ -1,55 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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/documentoutline/ui/documentoutlineview.d.ts

@@ -1,56 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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/documentoutline/utils.d.ts

@@ -1,21 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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/documentoutline.d.ts

@@ -1,103 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module document-outline/documentoutline
- * @publicApi
- */
-import { Plugin } 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 {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof DocumentOutlineUtils, typeof DocumentOutlineUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "DocumentOutline";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    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/index.d.ts

@@ -1,20 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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/legacyerrors.d.ts

@@ -1,9 +0,0 @@
-/**
- * @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-licensing-options
- */
-export {};

package/dist/tableofcontents/headingid.d.ts

@@ -1,30 +0,0 @@
-/**
- * @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-licensing-options
- */
-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
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

package/dist/tableofcontents/tableofcontentscommand.d.ts

@@ -1,25 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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/tableofcontents/tableofcontentsediting.d.ts

@@ -1,49 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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 isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Widget, typeof DocumentOutlineUtils, typeof HeadingId];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

package/dist/tableofcontents/tableofcontentsui.d.ts

@@ -1,31 +0,0 @@
-/**
- * @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-licensing-options
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The UI plugin of the table of contents feature.
- */
-export default class TableOfContentsUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableOfContentsUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}

package/dist/tableofcontents.d.ts

@@ -1,38 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-}

package/dist/utils/common-translations.d.ts

@@ -1,13 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module document-outline/utils/common-translations
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string): string;