@ckeditor/ckeditor5-list 35.4.0 → 36.0.0

package/src/documentlistproperties/documentlistpropertiesutils.js

@@ -1,69 +1,44 @@
 /**
- * @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/documentlist/documentlistpropertiesutils
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-import {
-	getAllSupportedStyleTypes,
-	getListStyleTypeFromTypeAttribute,
-	getListTypeFromListStyleType,
-	getTypeAttributeFromListStyleType
-} from './utils/style';
-
+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 );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'DocumentListPropertiesUtils';
+    }
+    /**
+     * Gets all the style types supported by given list type.
+     */
+    getAllSupportedStyleTypes() {
+        return getAllSupportedStyleTypes();
+    }
+    /**
+     * Checks whether the given list-style-type is supported by numbered or bulleted list.
+     */
+    getListTypeFromListStyleType(listStyleType) {
+        return getListTypeFromListStyleType(listStyleType);
+    }
+    /**
+     * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
+     */
+    getListStyleTypeFromTypeAttribute(value) {
+        return getListStyleTypeFromTypeAttribute(value);
+    }
+    /**
+     * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
+     */
+    getTypeAttributeFromListStyleType(value) {
+        return getTypeAttributeFromListStyleType(value);
+    }
 }

package/src/documentlistproperties/documentlistreversedcommand.js

@@ -1,76 +1,55 @@
 /**
- * @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/documentlistproperties/documentlistreversedcommand
  */
-
 import { Command } from 'ckeditor5/src/core';
 import { first } from 'ckeditor5/src/utils';
-import {
-	expandListBlocksToCompleteList,
-	isListItemBlock
-} from '../documentlist/utils/model';
-
+import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
 /**
  * The list reversed command. It changes the `listReversed` attribute of the selected list items,
  * letting the user to choose the order of an ordered list.
  * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- *
- * @extends module:core/command~Command
  */
 export default class DocumentListReversedCommand extends Command {
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		const value = this._getValue();
-
-		this.value = value;
-		this.isEnabled = value != null;
-	}
-
-	/**
-	 * Executes the command.
-	 *
-	 * @fires execute
-	 * @param {Object} [options]
-	 * @param {Boolean} [options.reversed=false] Whether the list should be reversed.
-	 */
-	execute( options = {} ) {
-		const model = this.editor.model;
-		const document = model.document;
-
-		let blocks = Array.from( document.selection.getSelectedBlocks() )
-			.filter( block => isListItemBlock( block ) && block.getAttribute( 'listType' ) == 'numbered' );
-
-		blocks = expandListBlocksToCompleteList( blocks );
-
-		model.change( writer => {
-			for ( const block of blocks ) {
-				writer.setAttribute( 'listReversed', !!options.reversed, block );
-			}
-		} );
-	}
-
-	/**
-	 * Checks the command's {@link #value}.
-	 *
-	 * @private
-	 * @returns {Boolean|null} The current value.
-	 */
-	_getValue() {
-		const model = this.editor.model;
-		const document = model.document;
-
-		const block = first( document.selection.getSelectedBlocks() );
-
-		if ( isListItemBlock( block ) && block.getAttribute( 'listType' ) == 'numbered' ) {
-			return block.getAttribute( 'listReversed' );
-		}
-
-		return null;
-	}
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const value = this._getValue();
+        this.value = value;
+        this.isEnabled = value != null;
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options.reversed Whether the list should be reversed.
+     */
+    execute(options = {}) {
+        const model = this.editor.model;
+        const document = model.document;
+        let blocks = Array.from(document.selection.getSelectedBlocks())
+            .filter(block => isListItemBlock(block) && block.getAttribute('listType') == 'numbered');
+        blocks = expandListBlocksToCompleteList(blocks);
+        model.change(writer => {
+            for (const block of blocks) {
+                writer.setAttribute('listReversed', !!options.reversed, block);
+            }
+        });
+    }
+    /**
+     * Checks the command's {@link #value}.
+     */
+    _getValue() {
+        const model = this.editor.model;
+        const document = model.document;
+        const block = first(document.selection.getSelectedBlocks());
+        if (isListItemBlock(block) && block.getAttribute('listType') == 'numbered') {
+            return block.getAttribute('listReversed');
+        }
+        return null;
+    }
 }

package/src/documentlistproperties/documentliststartcommand.js

@@ -1,76 +1,57 @@
 /**
- * @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/documentlistproperties/documentliststartcommand
  */
-
 import { Command } from 'ckeditor5/src/core';
 import { first } from 'ckeditor5/src/utils';
-import {
-	expandListBlocksToCompleteList,
-	isListItemBlock
-} from '../documentlist/utils/model';
-
+import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
 /**
  * The list start index command. It changes the `listStart` attribute of the selected list items,
  * letting the user to choose the starting point of an ordered list.
  * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- *
- * @extends module:core/command~Command
  */
 export default class DocumentListStartCommand extends Command {
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		const value = this._getValue();
-
-		this.value = value;
-		this.isEnabled = value != null;
-	}
-
-	/**
-	 * Executes the command.
-	 *
-	 * @fires execute
-	 * @param {Object} [options]
-	 * @param {Number} [options.startIndex=1] The list start index.
-	 */
-	execute( options = {} ) {
-		const model = this.editor.model;
-		const document = model.document;
-
-		let blocks = Array.from( document.selection.getSelectedBlocks() )
-			.filter( block => isListItemBlock( block ) && block.getAttribute( 'listType' ) == 'numbered' );
-
-		blocks = expandListBlocksToCompleteList( blocks );
-
-		model.change( writer => {
-			for ( const block of blocks ) {
-				writer.setAttribute( 'listStart', options.startIndex >= 0 ? options.startIndex : 1, block );
-			}
-		} );
-	}
-
-	/**
-	 * Checks the command's {@link #value}.
-	 *
-	 * @private
-	 * @returns {Number|null} The current value.
-	 */
-	_getValue() {
-		const model = this.editor.model;
-		const document = model.document;
-
-		const block = first( document.selection.getSelectedBlocks() );
-
-		if ( block && isListItemBlock( block ) && block.getAttribute( 'listType' ) == 'numbered' ) {
-			return block.getAttribute( 'listStart' );
-		}
-
-		return null;
-	}
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const value = this._getValue();
+        this.value = value;
+        this.isEnabled = value != null;
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options.startIndex The list start index.
+     */
+    execute({ startIndex = 1 } = {}) {
+        const model = this.editor.model;
+        const document = model.document;
+        let blocks = Array.from(document.selection.getSelectedBlocks())
+            .filter(block => isListItemBlock(block) && block.getAttribute('listType') == 'numbered');
+        blocks = expandListBlocksToCompleteList(blocks);
+        model.change(writer => {
+            for (const block of blocks) {
+                writer.setAttribute('listStart', startIndex >= 0 ? startIndex : 1, block);
+            }
+        });
+    }
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    _getValue() {
+        const model = this.editor.model;
+        const document = model.document;
+        const block = first(document.selection.getSelectedBlocks());
+        if (block && isListItemBlock(block) && block.getAttribute('listType') == 'numbered') {
+            return block.getAttribute('listStart');
+        }
+        return null;
+    }
 }

package/src/documentlistproperties/documentliststylecommand.js

@@ -1,163 +1,113 @@
 /**
- * @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/documentlistproperties/documentliststylecommand
  */
-
 import { Command } from 'ckeditor5/src/core';
 import { first } from 'ckeditor5/src/utils';
-import {
-	expandListBlocksToCompleteList,
-	isListItemBlock
-} from '../documentlist/utils/model';
+import { expandListBlocksToCompleteList, isListItemBlock } from '../documentlist/utils/model';
 import { getListTypeFromListStyleType } from './utils/style';
-
 /**
  * The list style command. It changes `listStyle` attribute of the selected list items,
  * letting the user choose styles for the list item markers.
  * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
- *
- * @extends module:core/command~Command
  */
 export default class DocumentListStyleCommand extends Command {
-	/**
-	 * Creates an instance of the command.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor The editor instance.
-	 * @param {String} defaultType The list type that will be used by default if the value was not specified during
-	 * the command execution.
-	 * @param {Array.<String>} [supportedTypes] The list of supported style types by this command.
-	 */
-	constructor( editor, defaultType, supportedTypes ) {
-		super( editor );
-
-		/**
-		 * The default type of the list style.
-		 *
-		 * @protected
-		 * @member {String}
-		 */
-		this._defaultType = defaultType;
-
-		/**
-		 * The list of supported style types by this command.
-		 *
-		 * @private
-		 * @member {Array.<String>|undefined}
-		 */
-		this._supportedTypes = supportedTypes;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		this.value = this._getValue();
-		this.isEnabled = this._checkEnabled();
-	}
-
-	/**
-	 * Executes the command.
-	 *
-	 * @fires execute
-	 * @param {Object} options
-	 * @param {String|null} [options.type] The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
-	 * style will be applied.
-	 */
-	execute( options = {} ) {
-		const model = this.editor.model;
-		const document = model.document;
-
-		model.change( writer => {
-			this._tryToConvertItemsToList( options );
-
-			let blocks = Array.from( document.selection.getSelectedBlocks() )
-				.filter( block => block.hasAttribute( 'listType' ) );
-
-			if ( !blocks.length ) {
-				return;
-			}
-
-			blocks = expandListBlocksToCompleteList( blocks );
-
-			for ( const block of blocks ) {
-				writer.setAttribute( 'listStyle', options.type || this._defaultType, block );
-			}
-		} );
-	}
-
-	/**
-	 * Checks if the given style type is supported by this plugin.
-	 *
-	 * @param {String} value
-	 * @returns {Boolean}
-	 */
-	isStyleTypeSupported( value ) {
-		if ( !this._supportedTypes ) {
-			return true;
-		}
-
-		return this._supportedTypes.includes( value );
-	}
-
-	/**
-	 * Checks the command's {@link #value}.
-	 *
-	 * @private
-	 * @returns {String|null} The current value.
-	 */
-	_getValue() {
-		const listItem = first( this.editor.model.document.selection.getSelectedBlocks() );
-
-		if ( isListItemBlock( listItem ) ) {
-			return listItem.getAttribute( 'listStyle' );
-		}
-
-		return null;
-	}
-
-	/**
-	 * Checks whether the command can be enabled in the current context.
-	 *
-	 * @private
-	 * @returns {Boolean} Whether the command should be enabled.
-	 */
-	_checkEnabled() {
-		const editor = this.editor;
-
-		const numberedList = editor.commands.get( 'numberedList' );
-		const bulletedList = editor.commands.get( 'bulletedList' );
-
-		return numberedList.isEnabled || bulletedList.isEnabled;
-	}
-
-	/**
-	 * Check if the provided list style is valid. Also change the selection to a list if it's not set yet.
-	 *
-	 * @private
-	 * @param {Object} options
-	 * @param {String|null} [options.type] The type of the list style. If `null` is specified, the function does nothing.
-	*/
-	_tryToConvertItemsToList( options ) {
-		if ( !options.type ) {
-			return;
-		}
-
-		const listType = getListTypeFromListStyleType( options.type );
-
-		if ( !listType ) {
-			return;
-		}
-
-		const editor = this.editor;
-		const commandName = listType + 'List';
-		const command = editor.commands.get( commandName );
-
-		if ( !command.value ) {
-			editor.execute( commandName );
-		}
-	}
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param defaultType The list type that will be used by default if the value was not specified during
+     * the command execution.
+     * @param supportedTypes The list of supported style types by this command.
+     */
+    constructor(editor, defaultType, supportedTypes) {
+        super(editor);
+        this.defaultType = defaultType;
+        this._supportedTypes = supportedTypes;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        this.value = this._getValue();
+        this.isEnabled = this._checkEnabled();
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
+     * style will be applied.
+     */
+    execute(options = {}) {
+        const model = this.editor.model;
+        const document = model.document;
+        model.change(writer => {
+            this._tryToConvertItemsToList(options);
+            let blocks = Array.from(document.selection.getSelectedBlocks())
+                .filter(block => block.hasAttribute('listType'));
+            if (!blocks.length) {
+                return;
+            }
+            blocks = expandListBlocksToCompleteList(blocks);
+            for (const block of blocks) {
+                writer.setAttribute('listStyle', options.type || this.defaultType, block);
+            }
+        });
+    }
+    /**
+     * Checks if the given style type is supported by this plugin.
+     */
+    isStyleTypeSupported(value) {
+        if (!this._supportedTypes) {
+            return true;
+        }
+        return this._supportedTypes.includes(value);
+    }
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    _getValue() {
+        const listItem = first(this.editor.model.document.selection.getSelectedBlocks());
+        if (isListItemBlock(listItem)) {
+            return listItem.getAttribute('listStyle');
+        }
+        return null;
+    }
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    _checkEnabled() {
+        const editor = this.editor;
+        const numberedList = editor.commands.get('numberedList');
+        const bulletedList = editor.commands.get('bulletedList');
+        return numberedList.isEnabled || bulletedList.isEnabled;
+    }
+    /**
+     * Check if the provided list style is valid. Also change the selection to a list if it's not set yet.
+     *
+     * @param options.type The type of the list style. If `null` is specified, the function does nothing.
+    */
+    _tryToConvertItemsToList(options) {
+        if (!options.type) {
+            return;
+        }
+        const listType = getListTypeFromListStyleType(options.type);
+        if (!listType) {
+            return;
+        }
+        const editor = this.editor;
+        const commandName = `${listType}List`;
+        const command = editor.commands.get(commandName);
+        if (!command.value) {
+            editor.execute(commandName);
+        }
+    }
 }