@ckeditor/ckeditor5-list 35.4.0 → 36.0.1

package/src/listproperties.js

@@ -1,135 +1,30 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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/listproperties
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import ListPropertiesEditing from './listproperties/listpropertiesediting';
 import ListPropertiesUI from './listproperties/listpropertiesui';
-
 /**
  * The list properties feature.
  *
  * This is a "glue" plugin that loads the {@link module:list/listproperties/listpropertiesediting~ListPropertiesEditing list properties
  * editing feature} and the {@link module:list/listproperties/listpropertiesui~ListPropertiesUI list properties UI feature}.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class ListProperties extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ ListPropertiesEditing, ListPropertiesUI ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'ListProperties';
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ListPropertiesEditing, ListPropertiesUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ListProperties';
+    }
 }
-
-/**
- * The configuration of the {@link module:list/listproperties~ListProperties list properties} feature and the
- * {@link module:list/documentlistproperties~DocumentListProperties document list properties} feature.
- *
- * This configuration controls the individual list properties. For instance, it enables or disables specific editor commands
- * operating on lists ({@link module:list/listproperties/liststylecommand~ListStyleCommand `'listStyle'`},
- * {@link module:list/listproperties/liststartcommand~ListStartCommand `'listStart'`},
- * {@link module:list/listproperties/listreversedcommand~ListReversedCommand `'listReversed'`}, or on the document lists
- * {@link module:list/documentlistproperties/documentliststylecommand~DocumentListStyleCommand `'listStyle'`},
- * {@link module:list/documentlistproperties/documentliststartcommand~DocumentListStartCommand `'listStart'`},
- * {@link module:list/documentlistproperties/documentlistreversedcommand~DocumentListReversedCommand `'listReversed'`}), the look of the UI
- * (`'numberedList'` and `'bulletedList'` dropdowns), and the editor data pipeline (allowed HTML attributes).
- *
- *		ClassicEditor
- *			.create( editorElement, {
- *				list: {
- *					properties: {
- *						styles: true,
- *						startIndex: true,
- *						reversed: true
- *					}
- *				}
- *			} )
- *			.then( ... )
- *			.catch( ... );
- *
- * @interface ListPropertiesConfig
- */
-
-/**
- * When set, the list style feature will be enabled. It allows changing the `list-style-type` style or the `type` HTML attribute of a list.
- *
- * **Note**: Styling using the `type` HTML attribute is only available in
- * {@link module:list/documentlistproperties~DocumentListProperties document list properties}
- * ({@link module:list/listproperties~ListPropertiesStyleConfig learn more}).
- *
- * @default true
- * @member {Boolean|module:list/listproperties~ListPropertiesStyleConfig} module:list/listproperties~ListPropertiesConfig#styles
- */
-
-/**
- * When set, the list start index feature will be enabled. It allows changing the `start` HTML attribute of the numbered lists. As a
- * result, it will be possible to specify the start value of the first item in an ordered list.
- *
- * **Note**: This configuration does not affect bulleted and to-do lists.
- *
- * @default false
- * @member {Boolean} module:list/listproperties~ListPropertiesConfig#startIndex
- */
-
-/**
- * When set, the reversed list feature will be enabled. It allows changing the `reversed` HTML attribute of the numbered lists. As a
- * result, it will be possible to make the list order descending instead of ascending.
- *
- * **Note**: This configuration does not affect bulleted and to-do lists.
- *
- * @default false
- * @member {Boolean} module:list/listproperties~ListPropertiesConfig#reversed
- */
-
-/**
- * The configuration of the {@link module:list/listproperties~ListProperties} feature and the
- * {@link module:list/documentlistproperties~DocumentListProperties document list properties} feature.
- *
- * Read more in {@link module:list/listproperties~ListPropertiesConfig}.
- *
- * @member {module:list/listproperties~ListPropertiesConfig} module:list/list~ListConfig#properties
- */
-
-/**
- * @interface ListPropertiesStyleConfig
- */
-
-/**
- * When set `true`, the list style feature will use the `type` attribute of `<ul>` and `<ol>` elements instead of the `list-style-type`
- * style.
- *
- *		{
- *			list: {
- *				properties: {
- *					styles: {
- *						useAttribute: true
- *					},
- *
- *					// ...
- *				}
- *			},
- *
- *			// ...
- *		}
- *
- * **Note**: Due to limitations of HTML, the "Decimal with leading zero" style is impossible to set using the `type` attribute.
- *
- * **Note**: This configuration works only with {@link module:list/documentlistproperties~DocumentListProperties document list properties}.
- *
- * @default false
- * @member {Boolean} module:list/listproperties~ListPropertiesStyleConfig#useAttribute
- */

package/src/liststyle.js

@@ -1,42 +1,36 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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/liststyle
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import ListProperties from './listproperties';
 import { logWarning } from 'ckeditor5/src/utils';
-
 /**
  * The list style feature.
  *
  * This is an obsolete plugin that exists for backward compatibility only.
  * Use the {@link module:list/listproperties~ListProperties list properties plugin} instead.
  *
- * @extends module:core/plugin~Plugin
+ * @deprecated
  */
 export default class ListStyle extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ ListProperties ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'ListStyle';
-	}
-
-	constructor( editor ) {
-		super( editor );
-
-		logWarning( 'The `ListStyle` plugin is obsolete. Use `ListProperties` instead.' );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ListProperties];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ListStyle';
+    }
+    constructor(editor) {
+        super(editor);
+        logWarning('The `ListStyle` plugin is obsolete. Use `ListProperties` instead.');
+    }
 }

package/src/todolist/checktodolistcommand.js

@@ -1,118 +1,76 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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/todolist/checktodolistcommand
  */
-
 import { Command } from 'ckeditor5/src/core';
-
 const attributeKey = 'todoListChecked';
-
 /**
  * The check to-do command.
  *
  * The command is registered by the {@link module:list/todolist/todolistediting~TodoListEditing} as
  * the `checkTodoList` editor command and it is also available via aliased `todoListCheck` name.
- *
- * @extends module:core/command~Command
  */
 export default class CheckTodoListCommand extends Command {
-	/**
-	 * @inheritDoc
-	 */
-	constructor( editor ) {
-		super( editor );
-
-		/**
-		 * A flag indicating whether the command is active. The command is active when at least one of
-		 * {@link module:engine/model/selection~Selection selected} elements is a to-do list item.
-		 *
-		 * @observable
-		 * @readonly
-		 * @member {Boolean} #isEnabled
-		 */
-
-		/**
-		 * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
-		 *
-		 * @observable
-		 * @readonly
-		 * @member {Array.<module:engine/model/element~Element>} #value
-		 */
-
-		/**
-		 * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
-		 *
-		 * @protected
-		 * @type {Array.<module:engine/model/element~Element>}
-		 */
-		this._selectedElements = [];
-
-		// Refresh command before executing to be sure all values are up to date.
-		// It is needed when selection has changed before command execution, in the same change block.
-		this.on( 'execute', () => {
-			this.refresh();
-		}, { priority: 'highest' } );
-	}
-
-	/**
-	 * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
-	 */
-	refresh() {
-		this._selectedElements = this._getSelectedItems();
-		this.value = this._selectedElements.every( element => !!element.getAttribute( 'todoListChecked' ) );
-		this.isEnabled = !!this._selectedElements.length;
-	}
-
-	/**
-	 * Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
-	 *
-	 * @private
-	 * @returns {Array.<module:engine/model/element~Element>}
-	 */
-	_getSelectedItems() {
-		const model = this.editor.model;
-		const schema = model.schema;
-
-		const selectionRange = model.document.selection.getFirstRange();
-		const startElement = selectionRange.start.parent;
-		const elements = [];
-
-		if ( schema.checkAttribute( startElement, attributeKey ) ) {
-			elements.push( startElement );
-		}
-
-		for ( const item of selectionRange.getItems() ) {
-			if ( schema.checkAttribute( item, attributeKey ) && !elements.includes( item ) ) {
-				elements.push( item );
-			}
-		}
-
-		return elements;
-	}
-
-	/**
-	 * Executes the command.
-	 *
-	 * @param {Object} [options]
-	 * @param {Boolean} [options.forceValue] If set, it will force the command behavior. If `true`, the command will apply
-	 * the attribute. Otherwise, the command will remove the attribute. If not set, the command will look for its current
-	 * value to decide what it should do.
-	 */
-	execute( options = {} ) {
-		this.editor.model.change( writer => {
-			for ( const element of this._selectedElements ) {
-				const value = ( options.forceValue === undefined ) ? !this.value : options.forceValue;
-
-				if ( value ) {
-					writer.setAttribute( attributeKey, true, element );
-				} else {
-					writer.removeAttribute( attributeKey, element );
-				}
-			}
-		} );
-	}
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        this._selectedElements = [];
+        // Refresh command before executing to be sure all values are up to date.
+        // It is needed when selection has changed before command execution, in the same change block.
+        this.on('execute', () => {
+            this.refresh();
+        }, { priority: 'highest' });
+    }
+    /**
+     * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
+     */
+    refresh() {
+        this._selectedElements = this._getSelectedItems();
+        this.value = this._selectedElements.every(element => !!element.getAttribute(attributeKey));
+        this.isEnabled = !!this._selectedElements.length;
+    }
+    /**
+     * Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
+     */
+    _getSelectedItems() {
+        const model = this.editor.model;
+        const schema = model.schema;
+        const selectionRange = model.document.selection.getFirstRange();
+        const startElement = selectionRange.start.parent;
+        const elements = [];
+        if (schema.checkAttribute(startElement, attributeKey)) {
+            elements.push(startElement);
+        }
+        for (const item of selectionRange.getItems()) {
+            if (schema.checkAttribute(item, attributeKey) && !elements.includes(item)) {
+                elements.push(item);
+            }
+        }
+        return elements;
+    }
+    /**
+     * Executes the command.
+     *
+     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply
+     * the attribute. Otherwise, the command will remove the attribute. If not set, the command will look for its current
+     * value to decide what it should do.
+     */
+    execute(options = {}) {
+        this.editor.model.change(writer => {
+            for (const element of this._selectedElements) {
+                const value = (options.forceValue === undefined) ? !this.value : options.forceValue;
+                if (value) {
+                    writer.setAttribute(attributeKey, true, element);
+                }
+                else {
+                    writer.removeAttribute(attributeKey, element);
+                }
+            }
+        });
+    }
 }