@ckeditor/ckeditor5-list 35.3.2 → 35.4.0

package/src/documentlist/documentlistediting.js

@@ -16,6 +16,7 @@ import DocumentListIndentCommand from './documentlistindentcommand';
 import DocumentListCommand from './documentlistcommand';
 import DocumentListMergeCommand from './documentlistmergecommand';
 import DocumentListSplitCommand from './documentlistsplitcommand';
+import DocumentListUtils from '../documentlist/documentlistutils';
 import {
 	bogusParagraphCreator,
 	listItemDowncastConverter,
@@ -41,11 +42,11 @@ import {
 	getViewElementIdForListType,
 	getViewElementNameForListType
 } from './utils/view';
+
 import ListWalker, {
 	iterateSiblingListBlocks,
 	ListBlocksIterable
 } from './utils/listwalker';
-
 import '../../theme/documentlist.css';
 
 /**
@@ -72,7 +73,7 @@ export default class DocumentListEditing extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ Enter, Delete ];
+		return [ Enter, Delete, DocumentListUtils ];
 	}
 
 	/**

package/src/documentlist/documentlistutils.js

@@ -0,0 +1,55 @@
+/**
+ * @license Copyright (c) 2003-2022, 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 { Plugin } from 'ckeditor5/src/core';
+import { expandListBlocksToCompleteList, isFirstBlockOfListItem, isListItemBlock } from './utils/model';
+
+/**
+ * A set of helpers related to document lists.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+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 {module:engine/model/element~Element|Array.<module:engine/model/element~Element>} blocks The list of selected blocks.
+	 * @returns {Array.<module:engine/model/element~Element>}
+	 */
+	expandListBlocksToCompleteList( blocks ) {
+		return expandListBlocksToCompleteList( blocks );
+	}
+
+	/**
+	 * Check if the given block is the first in the list item.
+	 *
+	 * @param {module:engine/model/element~Element} listBlock The list block element.
+	 * @returns {Boolean}
+	 */
+	isFirstBlockOfListItem( listBlock ) {
+		return isFirstBlockOfListItem( listBlock );
+	}
+
+	/**
+	 * Returns true if the given model node is a list item block.
+	 *
+	 * @param {module:engine/model/node~Node} node A model node.
+	 * @returns {Boolean}
+	 */
+	isListItemBlock( node ) {
+		return isListItemBlock( node );
+	}
+}

package/src/documentlist/utils/postfixers.js

@@ -30,7 +30,15 @@ export function findAndAddListHeadToMap( position, itemToListHead ) {
 	} else {
 		let listHead = previousNode;
 
-		for ( { node: listHead } of iterateSiblingListBlocks( listHead, 'backward' ) ) {
+		// Previously, the loop below was defined like this:
+		//
+		// 		for ( { node: listHead } of iterateSiblingListBlocks( listHead, 'backward' ) )
+		//
+		// Unfortunately, such a destructuring is incorrectly transpiled by Babel and the loop never ends.
+		// See: https://github.com/ckeditor/ckeditor5-react/issues/345.
+		for ( const { node } of iterateSiblingListBlocks( listHead, 'backward' ) ) {
+			listHead = node;
+
 			if ( itemToListHead.has( listHead ) ) {
 				return;
 			}

package/src/documentlistproperties/documentlistpropertiesediting.js

@@ -20,6 +20,7 @@ import {
 	getListStyleTypeFromTypeAttribute,
 	getTypeAttributeFromListStyleType
 } from './utils/style';
+import DocumentListPropertiesUtils from './documentlistpropertiesutils';
 
 const DEFAULT_LIST_TYPE = 'default';
 
@@ -36,7 +37,7 @@ export default class DocumentListPropertiesEditing extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ DocumentListEditing ];
+		return [ DocumentListEditing, DocumentListPropertiesUtils ];
 	}
 
 	/**
@@ -360,7 +361,7 @@ function createAttributeStrategies( enabledProperties ) {
 			},
 
 			setAttributeOnDowncast( writer, listStart, element ) {
-				if ( listStart && listStart > 1 ) {
+				if ( listStart == 0 || listStart > 1 ) {
 					writer.setAttribute( 'start', listStart, element );
 				} else {
 					writer.removeAttribute( 'start', element );
@@ -368,7 +369,9 @@ function createAttributeStrategies( enabledProperties ) {
 			},
 
 			getAttributeOnUpcast( listParent ) {
-				return listParent.getAttribute( 'start' ) || 1;
+				const startAttributeValue = listParent.getAttribute( 'start' );
+
+				return startAttributeValue >= 0 ? startAttributeValue : 1;
 			}
 		} );
 	}

package/src/documentlistproperties/documentlistpropertiesutils.js

@@ -0,0 +1,69 @@
+/**
+ * @license Copyright (c) 2003-2022, 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/documentlistpropertiesutils
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+import {
+	getAllSupportedStyleTypes,
+	getListStyleTypeFromTypeAttribute,
+	getListTypeFromListStyleType,
+	getTypeAttributeFromListStyleType
+} from './utils/style';
+
+/**
+ * A set of helpers related to document lists.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class DocumentListPropertiesUtils extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'DocumentListPropertiesUtils';
+	}
+
+	/**
+	 * Gets all the style types supported by given list type.
+	 *
+	 * @returns {Array.<String>}
+	 */
+	getAllSupportedStyleTypes() {
+		return getAllSupportedStyleTypes();
+	}
+
+	/**
+	 * Checks whether the given list-style-type is supported by numbered or bulleted list.
+	 *
+	 * @param {String} listStyleType
+	 * @returns {'bulleted'|'numbered'|null}
+	 */
+	getListTypeFromListStyleType( listStyleType ) {
+		return getListTypeFromListStyleType( listStyleType );
+	}
+
+	/**
+	 * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
+	 *
+	 * @param {String} value
+	 * @returns {String|null}
+	 */
+	getListStyleTypeFromTypeAttribute( value ) {
+		return getListStyleTypeFromTypeAttribute( value );
+	}
+
+	/**
+	 * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
+	 *
+	 * @param {String} value
+	 * @returns {String|null}
+	 */
+	getTypeAttributeFromListStyleType( value ) {
+		return getTypeAttributeFromListStyleType( value );
+	}
+}

package/src/documentlistproperties/documentliststartcommand.js

@@ -50,7 +50,7 @@ export default class DocumentListStartCommand extends Command {
 
 		model.change( writer => {
 			for ( const block of blocks ) {
-				writer.setAttribute( 'listStart', options.startIndex || 1, block );
+				writer.setAttribute( 'listStart', options.startIndex >= 0 ? options.startIndex : 1, block );
 			}
 		} );
 	}

package/src/index.js

@@ -11,10 +11,13 @@ export { default as DocumentList } from './documentlist';
 export { default as DocumentListEditing } from './documentlist/documentlistediting';
 export { default as DocumentListProperties } from './documentlistproperties';
 export { default as DocumentListPropertiesEditing } from './documentlistproperties/documentlistpropertiesediting';
+export { default as DocumentListUtils } from './documentlist/documentlistutils';
+export { default as DocumentListPropertiesUtils } from './documentlistproperties/documentlistpropertiesutils';
 export { default as List } from './list';
 export { default as ListEditing } from './list/listediting';
 export { default as ListUI } from './list/listui';
 export { default as ListProperties } from './listproperties';
+export { default as ListUtils } from './list/listutils';
 export { default as ListPropertiesEditing } from './listproperties/listpropertiesediting';
 export { default as ListPropertiesUI } from './listproperties/listpropertiesui';
 export { default as TodoList } from './todolist';

package/src/list/listediting.js

@@ -9,6 +9,7 @@
 
 import ListCommand from './listcommand';
 import IndentCommand from './indentcommand';
+import ListUtils from './listutils';
 
 import { Plugin } from 'ckeditor5/src/core';
 import { Enter } from 'ckeditor5/src/enter';
@@ -50,7 +51,7 @@ export default class ListEditing extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ Enter, Delete ];
+		return [ Enter, Delete, ListUtils ];
 	}
 
 	/**

package/src/list/listutils.js

@@ -0,0 +1,68 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module list/list/listutils
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+import {
+	getListTypeFromListStyleType,
+	getSelectedListItems,
+	getSiblingNodes
+} from './utils';
+
+/**
+ * A set of helpers related to document lists.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class ListUtils extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'ListUtils';
+	}
+
+	/**
+	 * Checks whether the given list-style-type is supported by numbered or bulleted list.
+	 *
+	 * @param {String} listStyleType
+	 * @returns {'bulleted'|'numbered'|null}
+	 */
+	getListTypeFromListStyleType( listStyleType ) {
+		return getListTypeFromListStyleType( listStyleType );
+	}
+
+	/**
+	 * Returns an array with all `listItem` elements in the model selection.
+	 *
+	 * It returns all the items even if only a part of the list is selected, including items that belong to nested lists.
+	 * If no list is selected, it returns an empty array.
+	 * The order of the elements is not specified.
+	 *
+	 * @param {module:engine/model/model~Model} model
+	 * @returns {Array.<module:engine/model/element~Element>}
+	 */
+	getSelectedListItems( model ) {
+		return getSelectedListItems( model );
+	}
+
+	/**
+	 * Returns an array with all `listItem` elements that represent the same list.
+	 *
+	 * It means that values of `listIndent`, `listType`, `listStyle`, `listReversed` and `listStart` for all items are equal.
+	 *
+	 * Additionally, if the `position` is inside a list item, that list item will be returned as well.
+	 *
+	 * @param {module:engine/model/position~Position} position Starting position.
+	 * @param {'forward'|'backward'} direction Walking direction.
+	 * @returns {Array.<module:engine/model/element~Element>}
+	 */
+	getSiblingNodes( position, direction ) {
+		return getSiblingNodes( position, direction );
+	}
+}

package/src/listproperties/listpropertiesediting.js

@@ -335,7 +335,7 @@ function createAttributeStrategies( enabledProperties ) {
 			},
 
 			setAttributeOnDowncast( writer, listStart, element ) {
-				if ( listStart != 1 ) {
+				if ( listStart == 0 || listStart > 1 ) {
 					writer.setAttribute( 'start', listStart, element );
 				} else {
 					writer.removeAttribute( 'start', element );
@@ -343,7 +343,9 @@ function createAttributeStrategies( enabledProperties ) {
 			},
 
 			getAttributeOnUpcast( listParent ) {
-				return listParent.getAttribute( 'start' ) || 1;
+				const startAttributeValue = listParent.getAttribute( 'start' );
+
+				return startAttributeValue >= 0 ? startAttributeValue : 1;
 			}
 		} );
 	}

package/src/listproperties/liststartcommand.js

@@ -40,7 +40,7 @@ export default class ListStartCommand extends Command {
 
 		model.change( writer => {
 			for ( const item of listItems ) {
-				writer.setAttribute( 'listStart', options.startIndex || 1, item );
+				writer.setAttribute( 'listStart', options.startIndex >= 0 ? options.startIndex : 1, item );
 			}
 		} );
 	}

package/src/listproperties/ui/listpropertiesview.js

@@ -203,7 +203,8 @@ export default class ListPropertiesView extends View {
 					.getComputedStyle( this.stylesView.element )
 					.getPropertyValue( 'grid-template-columns' )
 					.split( ' ' )
-					.length
+					.length,
+				uiLanguageDirection: this.locale && this.locale.uiLanguageDirection
 			} );
 		}
 
@@ -368,7 +369,7 @@ export default class ListPropertiesView extends View {
 		} );
 
 		startIndexFieldView.fieldView.set( {
-			min: 1,
+			min: 0,
 			step: 1,
 			value: 1,
 			inputMode: 'numeric'