@ckeditor/ckeditor5-list 39.0.2 → 40.0.0

package/src/documentlist/documentlistutils.d.ts

@@ -1,46 +1,46 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlist/documentlistutils
- */
-import type { Element, Node } from 'ckeditor5/src/engine';
-import type { ArrayOrItem } from 'ckeditor5/src/utils';
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * A set of helpers related to document lists.
- */
-export default class DocumentListUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "DocumentListUtils";
-    /**
-     * Expands the given list of selected blocks to include all the items of the lists they're in.
-     *
-     * @param blocks The list of selected blocks.
-     */
-    expandListBlocksToCompleteList(blocks: ArrayOrItem<Element>): Array<Element>;
-    /**
-     * Check if the given block is the first in the list item.
-     *
-     * @param listBlock The list block element.
-     */
-    isFirstBlockOfListItem(listBlock: Element): boolean;
-    /**
-     * Returns true if the given model node is a list item block.
-     *
-     * @param node A model node.
-     */
-    isListItemBlock(node: Node): boolean;
-    /**
-     * Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.
-     *
-     * @param blocks The list of selected blocks.
-     * @param options.withNested Whether should include nested list items.
-     */
-    expandListBlocksToCompleteItems(blocks: ArrayOrItem<Element>, options?: {
-        withNested?: boolean;
-    }): Array<Element>;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/documentlist/documentlistutils
+ */
+import type { Element, Node } from 'ckeditor5/src/engine';
+import type { ArrayOrItem } from 'ckeditor5/src/utils';
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * A set of helpers related to document lists.
+ */
+export default class DocumentListUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "DocumentListUtils";
+    /**
+     * Expands the given list of selected blocks to include all the items of the lists they're in.
+     *
+     * @param blocks The list of selected blocks.
+     */
+    expandListBlocksToCompleteList(blocks: ArrayOrItem<Element>): Array<Element>;
+    /**
+     * Check if the given block is the first in the list item.
+     *
+     * @param listBlock The list block element.
+     */
+    isFirstBlockOfListItem(listBlock: Element): boolean;
+    /**
+     * Returns true if the given model node is a list item block.
+     *
+     * @param node A model node.
+     */
+    isListItemBlock(node: Node): boolean;
+    /**
+     * Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.
+     *
+     * @param blocks The list of selected blocks.
+     * @param options.withNested Whether should include nested list items.
+     */
+    expandListBlocksToCompleteItems(blocks: ArrayOrItem<Element>, options?: {
+        withNested?: boolean;
+    }): Array<Element>;
+}

package/src/documentlist/documentlistutils.js

@@ -1,50 +1,50 @@
-/**
- * @license Copyright (c) 2003-2023, 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';
-import { expandListBlocksToCompleteItems, expandListBlocksToCompleteList, isFirstBlockOfListItem, isListItemBlock } from './utils/model';
-/**
- * A set of helpers related to document lists.
- */
-export default class DocumentListUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DocumentListUtils';
-    }
-    /**
-     * Expands the given list of selected blocks to include all the items of the lists they're in.
-     *
-     * @param blocks The list of selected blocks.
-     */
-    expandListBlocksToCompleteList(blocks) {
-        return expandListBlocksToCompleteList(blocks);
-    }
-    /**
-     * Check if the given block is the first in the list item.
-     *
-     * @param listBlock The list block element.
-     */
-    isFirstBlockOfListItem(listBlock) {
-        return isFirstBlockOfListItem(listBlock);
-    }
-    /**
-     * Returns true if the given model node is a list item block.
-     *
-     * @param node A model node.
-     */
-    isListItemBlock(node) {
-        return isListItemBlock(node);
-    }
-    /**
-     * Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.
-     *
-     * @param blocks The list of selected blocks.
-     * @param options.withNested Whether should include nested list items.
-     */
-    expandListBlocksToCompleteItems(blocks, options = {}) {
-        return expandListBlocksToCompleteItems(blocks, options);
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, 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';
+import { expandListBlocksToCompleteItems, expandListBlocksToCompleteList, isFirstBlockOfListItem, isListItemBlock } from './utils/model';
+/**
+ * A set of helpers related to document lists.
+ */
+export default class DocumentListUtils extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'DocumentListUtils';
+    }
+    /**
+     * Expands the given list of selected blocks to include all the items of the lists they're in.
+     *
+     * @param blocks The list of selected blocks.
+     */
+    expandListBlocksToCompleteList(blocks) {
+        return expandListBlocksToCompleteList(blocks);
+    }
+    /**
+     * Check if the given block is the first in the list item.
+     *
+     * @param listBlock The list block element.
+     */
+    isFirstBlockOfListItem(listBlock) {
+        return isFirstBlockOfListItem(listBlock);
+    }
+    /**
+     * Returns true if the given model node is a list item block.
+     *
+     * @param node A model node.
+     */
+    isListItemBlock(node) {
+        return isListItemBlock(node);
+    }
+    /**
+     * Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.
+     *
+     * @param blocks The list of selected blocks.
+     * @param options.withNested Whether should include nested list items.
+     */
+    expandListBlocksToCompleteItems(blocks, options = {}) {
+        return expandListBlocksToCompleteItems(blocks, options);
+    }
+}

package/src/documentlist/utils/listwalker.d.ts

@@ -1,141 +1,145 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module list/documentlist/utils/listwalker
- */
-import { type ArrayOrItem } from 'ckeditor5/src/utils';
-import { type ListElement } from './model';
-import type { Element, Node } from 'ckeditor5/src/engine';
-/**
- * Document list blocks iterator.
- */
-export default class ListWalker {
-    /**
-     * The start list item block element.
-     */
-    private _startElement;
-    /**
-     * The reference indent. Initialized by the indent of the start block.
-     */
-    private _referenceIndent;
-    /**
-     * The iterating direction.
-     */
-    private _isForward;
-    /**
-     * Whether start block should be included in the result (if it's matching other criteria).
-     */
-    private _includeSelf;
-    /**
-     * Additional attributes that must be the same for each block.
-     */
-    private _sameAttributes;
-    /**
-     * Whether blocks with the same indent level as the start block should be included in the result.
-     */
-    private _sameIndent;
-    /**
-     * Whether blocks with a lower indent level than the start block should be included in the result.
-     */
-    private _lowerIndent;
-    /**
-     * Whether blocks with a higher indent level than the start block should be included in the result.
-     */
-    private _higherIndent;
-    /**
-     * Creates a document list iterator.
-     *
-     * @param startElement The start list item block element.
-     * @param options.direction The iterating direction.
-     * @param options.includeSelf Whether start block should be included in the result (if it's matching other criteria).
-     * @param options.sameAttributes Additional attributes that must be the same for each block.
-     * @param options.sameIndent Whether blocks with the same indent level as the start block should be included
-     * in the result.
-     * @param options.lowerIndent Whether blocks with a lower indent level than the start block should be included
-     * in the result.
-     * @param options.higherIndent Whether blocks with a higher indent level than the start block should be included
-     * in the result.
-     */
-    constructor(startElement: Node, options: {
-        direction?: 'forward' | 'backward';
-        includeSelf?: boolean;
-        sameAttributes?: ArrayOrItem<string>;
-        sameIndent?: boolean;
-        lowerIndent?: boolean;
-        higherIndent?: boolean;
-    });
-    /**
-     * Performs only first step of iteration and returns the result.
-     *
-     * @param startElement The start list item block element.
-     * @param options.direction The iterating direction.
-     * @param options.includeSelf Whether start block should be included in the result (if it's matching other criteria).
-     * @param options.sameAttributes Additional attributes that must be the same for each block.
-     * @param options.sameIndent Whether blocks with the same indent level as the start block should be included
-     * in the result.
-     * @param options.lowerIndent Whether blocks with a lower indent level than the start block should be included
-     * in the result.
-     * @param options.higherIndent Whether blocks with a higher indent level than the start block should be included
-     * in the result.
-     */
-    static first(startElement: Node, options: {
-        direction?: 'forward' | 'backward';
-        includeSelf?: boolean;
-        sameAttributes?: ArrayOrItem<string>;
-        sameIndent?: boolean;
-        lowerIndent?: boolean;
-        higherIndent?: boolean;
-    }): ListElement | null;
-    /**
-     * Iterable interface.
-     */
-    [Symbol.iterator](): Iterator<ListElement>;
-    /**
-     * Returns the model element to start iterating.
-     */
-    private _getStartNode;
-}
-/**
- * Iterates sibling list blocks starting from the given node.
- *
- * @internal
- * @param node The model node.
- * @param direction Iteration direction.
- * @returns The object with `node` and `previous` {@link module:engine/model/element~Element blocks}.
- */
-export declare function iterateSiblingListBlocks(node: Node | null, direction?: 'forward' | 'backward'): IterableIterator<ListIteratorValue>;
-/**
- * The iterable protocol over the list elements.
- *
- * @internal
- */
-export declare class ListBlocksIterable {
-    private _listHead;
-    /**
-     * @param listHead The head element of a list.
-     */
-    constructor(listHead: Element);
-    /**
-     * List blocks iterator.
-     *
-     * Iterates over all blocks of a list.
-     */
-    [Symbol.iterator](): Iterator<ListIteratorValue>;
-}
-/**
- * Object returned by `iterateSiblingListBlocks()` when traversing a list.
- *
- * @internal
- */
-export interface ListIteratorValue {
-    /**
-     * The current list node.
-     */
-    node: ListElement;
-    /**
-     * The previous list node.
-     */
-    previous: ListElement | null;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/documentlist/utils/listwalker
+ */
+import { type ArrayOrItem } from 'ckeditor5/src/utils';
+import { type ListElement } from './model';
+import type { Element, Node } from 'ckeditor5/src/engine';
+/**
+ * Document list blocks iterator.
+ */
+export default class ListWalker {
+    /**
+     * The start list item block element.
+     */
+    private _startElement;
+    /**
+     * The reference indent. Initialized by the indent of the start block.
+     */
+    private _referenceIndent;
+    /**
+     * The iterating direction.
+     */
+    private _isForward;
+    /**
+     * Whether start block should be included in the result (if it's matching other criteria).
+     */
+    private _includeSelf;
+    /**
+     * Additional attributes that must be the same for each block.
+     */
+    private _sameAttributes;
+    /**
+     * Whether blocks with the same indent level as the start block should be included in the result.
+     */
+    private _sameIndent;
+    /**
+     * Whether blocks with a lower indent level than the start block should be included in the result.
+     */
+    private _lowerIndent;
+    /**
+     * Whether blocks with a higher indent level than the start block should be included in the result.
+     */
+    private _higherIndent;
+    /**
+     * Creates a document list iterator.
+     *
+     * @param startElement The start list item block element.
+     * @param options.direction The iterating direction.
+     * @param options.includeSelf Whether start block should be included in the result (if it's matching other criteria).
+     * @param options.sameAttributes Additional attributes that must be the same for each block.
+     * @param options.sameIndent Whether blocks with the same indent level as the start block should be included
+     * in the result.
+     * @param options.lowerIndent Whether blocks with a lower indent level than the start block should be included
+     * in the result.
+     * @param options.higherIndent Whether blocks with a higher indent level than the start block should be included
+     * in the result.
+     */
+    constructor(startElement: Node, options: {
+        direction?: 'forward' | 'backward';
+        includeSelf?: boolean;
+        sameAttributes?: ArrayOrItem<string>;
+        sameIndent?: boolean;
+        lowerIndent?: boolean;
+        higherIndent?: boolean;
+    });
+    /**
+     * Performs only first step of iteration and returns the result.
+     *
+     * @param startElement The start list item block element.
+     * @param options.direction The iterating direction.
+     * @param options.includeSelf Whether start block should be included in the result (if it's matching other criteria).
+     * @param options.sameAttributes Additional attributes that must be the same for each block.
+     * @param options.sameIndent Whether blocks with the same indent level as the start block should be included
+     * in the result.
+     * @param options.lowerIndent Whether blocks with a lower indent level than the start block should be included
+     * in the result.
+     * @param options.higherIndent Whether blocks with a higher indent level than the start block should be included
+     * in the result.
+     */
+    static first(startElement: Node, options: {
+        direction?: 'forward' | 'backward';
+        includeSelf?: boolean;
+        sameAttributes?: ArrayOrItem<string>;
+        sameIndent?: boolean;
+        lowerIndent?: boolean;
+        higherIndent?: boolean;
+    }): ListElement | null;
+    /**
+     * Iterable interface.
+     */
+    [Symbol.iterator](): Iterator<ListElement>;
+    /**
+     * Returns the model element to start iterating.
+     */
+    private _getStartNode;
+}
+/**
+ * Iterates sibling list blocks starting from the given node.
+ *
+ * @internal
+ * @param node The model node.
+ * @param direction Iteration direction.
+ * @returns The object with `node` and `previous` {@link module:engine/model/element~Element blocks}.
+ */
+export declare function iterateSiblingListBlocks(node: Node | null, direction?: 'forward' | 'backward'): IterableIterator<ListIteratorValue>;
+/**
+ * The iterable protocol over the list elements.
+ *
+ * @internal
+ */
+export declare class ListBlocksIterable {
+    private _listHead;
+    /**
+     * @param listHead The head element of a list.
+     */
+    constructor(listHead: Element);
+    /**
+     * List blocks iterator.
+     *
+     * Iterates over all blocks of a list.
+     */
+    [Symbol.iterator](): Iterator<ListIteratorValue>;
+}
+/**
+ * Object returned by `iterateSiblingListBlocks()` when traversing a list.
+ *
+ * @internal
+ */
+export interface ListIteratorValue {
+    /**
+     * The current list node.
+     */
+    node: ListElement;
+    /**
+     * The previous list node.
+     */
+    previous: ListElement | null;
+    /**
+     * The previous list node at the same indent as current node.
+     */
+    previousNodeInList: ListElement | null;
+}