@ckeditor/ckeditor5-list 32.0.0 → 34.0.1

package/src/{listreversedcommand.js → listproperties/listreversedcommand.js}

@@ -4,11 +4,11 @@
  */
 
 /**
- * @module list/listreversedcommand
+ * @module list/listproperties/listreversedcommand
  */
 
 import { Command } from 'ckeditor5/src/core';
-import { getSelectedListItems } from './utils';
+import { getSelectedListItems } from '../list/utils';
 
 /**
  * The reversed list command. It changes the `listReversed` attribute of the selected list items. As a result, the list order will be
@@ -30,9 +30,9 @@ export default class ListReversedCommand extends Command {
 	/**
 	 * Executes the command.
 	 *
+	 * @fires execute
 	 * @param {Object} options
 	 * @param {Boolean} [options.reversed=false] Whether the list should be reversed.
-	 * @protected
 	 */
 	execute( options = {} ) {
 		const model = this.editor.model;

package/src/{liststartcommand.js → listproperties/liststartcommand.js}

@@ -4,11 +4,11 @@
  */
 
 /**
- * @module list/liststartcommand
+ * @module list/listproperties/liststartcommand
  */
 
 import { Command } from 'ckeditor5/src/core';
-import { getSelectedListItems } from './utils';
+import { getSelectedListItems } from '../list/utils';
 
 /**
  * The list start index command. It changes the `listStart` attribute of the selected list items.
@@ -29,9 +29,9 @@ export default class ListStartCommand extends Command {
 	/**
 	 * Executes the command.
 	 *
+	 * @fires execute
 	 * @param {Object} options
 	 * @param {Number} [options.startIndex=1] The list start index.
-	 * @protected
 	 */
 	execute( options = {} ) {
 		const model = this.editor.model;

package/src/{liststylecommand.js → listproperties/liststylecommand.js}

@@ -4,14 +4,17 @@
  */
 
 /**
- * @module list/liststylecommand
+ * @module list/listproperties/liststylecommand
  */
 
 import { Command } from 'ckeditor5/src/core';
-import { getSelectedListItems } from './utils';
+import { getListTypeFromListStyleType, getSelectedListItems } from '../list/utils';
 
 /**
  * The list style command. It changes the `listStyle` attribute of the selected list items.
+ *
+ * If the list type (numbered or bulleted) can be inferred from the passed style type,
+ * the command tries to convert selected items to a list of that type.
  * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
  *
  * @extends module:core/command~Command
@@ -47,12 +50,14 @@ export default class ListStyleCommand extends Command {
 	/**
 	 * 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
+	 * @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.
-	 * @protected
 	 */
 	execute( options = {} ) {
+		this._tryToConvertItemsToList( options );
+
 		const model = this.editor.model;
 		const listItems = getSelectedListItems( model );
 
@@ -97,4 +102,31 @@ export default class ListStyleCommand extends Command {
 
 		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 {Object} options
+	 * @param {String|null} [options.type] The type of the list style. If `null` is specified, the function does nothing.
+	 * @private
+	*/
+	_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 );
+		}
+	}
 }

package/src/{ui → listproperties/ui}/collapsibleview.js

@@ -12,7 +12,7 @@ import { View, ButtonView } from 'ckeditor5/src/ui';
 // eslint-disable-next-line ckeditor5-rules/ckeditor-imports
 import dropdownArrowIcon from '@ckeditor/ckeditor5-ui/theme/icons/dropdown-arrow.svg';
 
-import '../../theme/collapsible.css';
+import '../../../theme/collapsible.css';
 
 /**
  * A collapsible UI component. Consists of a labeled button and a container which can be collapsed

package/src/{ui → listproperties/ui}/listpropertiesview.js

@@ -22,7 +22,7 @@ import {
 
 import CollapsibleView from './collapsibleview';
 
-import '../../theme/listproperties.css';
+import '../../../theme/listproperties.css';
 
 /**
  * The list properties view to be displayed in the list dropdown.

package/src/listproperties.js

@@ -8,14 +8,14 @@
  */
 
 import { Plugin } from 'ckeditor5/src/core';
-import ListPropertiesEditing from './listpropertiesediting';
-import ListPropertiesUI from './listpropertiesui';
+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/listpropertiesediting~ListPropertiesEditing list properties editing feature}
- * and the {@link module:list/listpropertiesui~ListPropertiesUI list properties UI 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
  */
@@ -36,12 +36,16 @@ export default class ListProperties extends Plugin {
 }
 
 /**
- * The configuration of the {@link module:list/listproperties~ListProperties list properties} feature.
+ * 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/liststylecommand~ListStyleCommand `'listStyle'`},
- * {@link module:list/liststartcommand~ListStartCommand `'listStart'`},
- * {@link module:list/listreversedcommand~ListReversedCommand `'listReversed'`}), the look of the UI
+ * 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
@@ -88,7 +92,8 @@ export default class ListProperties extends Plugin {
  */
 
 /**
- * The configuration of the {@link module:list/listproperties~ListProperties} feature.
+ * 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}.
  *

package/src/{checktodolistcommand.js → todolist/checktodolistcommand.js}

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module list/checktodolistcommand
+ * @module list/todolist/checktodolistcommand
  */
 
 import { Command } from 'ckeditor5/src/core';
@@ -14,7 +14,7 @@ const attributeKey = 'todoListChecked';
 /**
  * The check to-do command.
  *
- * The command is registered by the {@link module:list/todolistediting~TodoListEditing} as
+ * 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

package/src/{todolistconverters.js → todolist/todolistconverters.js}

@@ -4,14 +4,14 @@
  */
 
 /**
- * @module list/todolistconverters
+ * @module list/todolist/todolistconverters
  */
 
 /* global document */
 
 import { createElement } from 'ckeditor5/src/utils';
 
-import { generateLiInUl, injectViewList, positionAfterUiElements, findNestedList } from './utils';
+import { generateLiInUl, injectViewList, positionAfterUiElements, findNestedList } from '../list/utils';
 
 /**
  * A model-to-view converter for the `listItem` model element insertion.
@@ -171,8 +171,8 @@ export function dataViewModelCheckmarkInsertion( evt, data, conversionApi ) {
  * {@link module:engine/view/uielement~UIElement checkbox UI element} is added at the beginning
  * of the list item element (or vice versa).
  *
- * This converter is preceded by {@link module:list/converters~modelViewChangeType} and followed by
- * {@link module:list/converters~modelViewMergeAfterChangeType} to handle splitting and merging surrounding lists of the same type.
+ * This converter is preceded by {@link module:list/list/converters~modelViewChangeType} and followed by
+ * {@link module:list/list/converters~modelViewMergeAfterChangeType} to handle splitting and merging surrounding lists of the same type.
  *
  * It is used by {@link module:engine/controller/editingcontroller~EditingController}.
  *
@@ -183,6 +183,10 @@ export function dataViewModelCheckmarkInsertion( evt, data, conversionApi ) {
  */
 export function modelViewChangeType( onCheckedChange, view ) {
 	return ( evt, data, conversionApi ) => {
+		if ( !conversionApi.consumable.consume( data.item, evt.name ) ) {
+			return;
+		}
+
 		const viewItem = conversionApi.mapper.toViewElement( data.item );
 		const viewWriter = conversionApi.writer;
 

package/src/{todolistediting.js → todolist/todolistediting.js}

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module list/todolistediting
+ * @module list/todolist/todolistediting
  */
 
 import { Plugin } from 'ckeditor5/src/core';
@@ -14,8 +14,8 @@ import {
 	getLocalizedArrowKeyCodeDirection
 } from 'ckeditor5/src/utils';
 
-import ListCommand from './listcommand';
-import ListEditing from './listediting';
+import ListCommand from '../list/listcommand';
+import ListEditing from '../list/listediting';
 import CheckTodoListCommand from './checktodolistcommand';
 import {
 	dataModelViewInsertion,
@@ -31,7 +31,7 @@ const ITEM_TOGGLE_KEYSTROKE = parseKeystroke( 'Ctrl+Enter' );
 /**
  * The engine of the to-do list feature. It handles creating, editing and removing to-do lists and their items.
  *
- * It registers the entire functionality of the {@link module:list/listediting~ListEditing list editing plugin} and extends
+ * It registers the entire functionality of the {@link module:list/list/listediting~ListEditing list editing plugin} and extends
  * it with the commands:
  *
  * - `'todoList'`,

package/src/{todolistui.js → todolist/todolistui.js}

@@ -4,11 +4,11 @@
  */
 
 /**
- * @module list/todolistui
+ * @module list/todolist/todolistui
  */
 
-import { createUIComponent } from './utils';
-import todoListIcon from '../theme/icons/todolist.svg';
+import { createUIComponent } from '../list/utils';
+import todoListIcon from '../../theme/icons/todolist.svg';
 import { Plugin } from 'ckeditor5/src/core';
 
 /**

package/src/todolist.js

@@ -7,16 +7,16 @@
  * @module list/todolist
  */
 
-import TodoListEditing from './todolistediting';
-import TodoListUI from './todolistui';
+import TodoListEditing from './todolist/todolistediting';
+import TodoListUI from './todolist/todolistui';
 import { Plugin } from 'ckeditor5/src/core';
 import '../theme/todolist.css';
 
 /**
  * The to-do list feature.
  *
- * This is a "glue" plugin that loads the {@link module:list/todolistediting~TodoListEditing to-do list editing feature}
- * and the {@link module:list/todolistui~TodoListUI to-do list UI feature}.
+ * This is a "glue" plugin that loads the {@link module:list/todolist/todolistediting~TodoListEditing to-do list editing feature}
+ * and the {@link module:list/todolist/todolistui~TodoListUI to-do list UI feature}.
  *
  * @extends module:core/plugin~Plugin
  */

package/theme/documentlist.css

@@ -0,0 +1,8 @@
+/*
+ * 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
+ */
+
+.ck-editor__editable .ck-list-bogus-paragraph {
+	display: block;
+}