@ckeditor/ckeditor5-document-outline 41.2.0 → 41.3.0-alpha.2

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";
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-document-outline",
-  "version": "41.2.0",
+  "version": "41.3.0-alpha.2",
   "description": "Document outline feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,9 +13,9 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "41.2.0",
-    "ckeditor5-collaboration": "41.2.0",
-    "@ckeditor/ckeditor5-ui": "41.2.0",
+    "ckeditor5": "41.3.0-alpha.2",
+    "ckeditor5-collaboration": "41.3.0-alpha.2",
+    "@ckeditor/ckeditor5-ui": "41.3.0-alpha.2",
     "lodash-es": "4.17.21"
   },
   "license": "SEE LICENSE IN LICENSE.md",
@@ -23,6 +23,7 @@
   "homepage": "https://ckeditor.com/ckeditor-5",
   "bugs": "https://support.ckeditor.com/hc/en-us/requests/new",
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",