[WiP] Skip level lists

.changelog/20260513132102_ck_9847.md

@@ -0,0 +1,8 @@
+---
+type: Feature
+scope:
+  - ckeditor5-list
+  - ckeditor5-autoformat
+---
+
+Numbered list autoformat now accepts any starting number. Typing any number followed by `.` or `)` and a space (e.g. `5. `) creates a numbered list. When the `list.properties.startIndex` option is enabled, the list starts at the typed number.

.changelog/20260513132321_ck_9847.md

@@ -0,0 +1,7 @@
+---
+type: Feature
+scope:
+  - ckeditor5-list
+---
+
+Added support for skip-level lists. List items can now be indented by more than one level at a time by enabling the `list.allowSkipLevels` configuration option.

packages/ckeditor5-autoformat/src/autoformat.ts

@@ -73,7 +73,10 @@ export class Autoformat extends Plugin {
 	 *
 	 * When typed:
 	 * - `* ` or `- ` – A paragraph will be changed into a bulleted list.
-	 * - `1. ` or `1) ` – A paragraph will be changed into a numbered list ("1" can be any digit or a list of digits).
+	 * - `<number>. ` or `<number>) ` &ndash; A paragraph will be changed into a numbered list.
+	 * If the paragraph is adjacent to an existing list, the typed number is ignored and the item joins the list
+	 * as the next sequential item. Otherwise, a new list is created with the `listStart` attribute set to the typed number
+	 * (when the {@link module:list/listproperties~ListProperties start index feature} is enabled).
 	 * - `[] ` or `[ ] ` &ndash; A paragraph will be changed into a to-do list.
 	 * - `[x] ` or `[ x ] ` &ndash; A paragraph will be changed into a checked to-do list.
 	 */
@@ -85,7 +88,19 @@ export class Autoformat extends Plugin {
 		}
 
 		if ( commands.get( 'numberedList' ) ) {
-			blockAutoformatEditing( this.editor, this, /^1[.|)]\s$/, 'numberedList' );
+			const numberedListCommand = commands.get( 'numberedList' )!;
+			const hasStartIndexFeature = !!commands.get( 'listStart' );
+
+			blockAutoformatEditing( this.editor, this, /^(\d+)[.|)]\s$/, ( { match } ) => {
+				if ( !numberedListCommand.isEnabled || numberedListCommand.value === true ) {
+					return false;
+				}
+
+				this.editor.execute( 'numberedList', hasStartIndexFeature ?
+					{ additionalAttributes: { listStart: parseInt( match[ 1 ] ) } } :
+					undefined
+				);
+			} );
 		}
 
 		if ( commands.get( 'todoList' ) ) {

packages/ckeditor5-autoformat/tests/autoformat.js

@@ -6,7 +6,7 @@
 import { Autoformat } from '../src/autoformat.js';
 
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
-import { ListEditing, TodoListEditing } from '@ckeditor/ckeditor5-list';
+import { ListEditing, ListPropertiesEditing, TodoListEditing } from '@ckeditor/ckeditor5-list';
 import { HeadingEditing, HeadingCommand } from '@ckeditor/ckeditor5-heading';
 import { BoldEditing, StrikethroughEditing, CodeEditing, ItalicEditing } from '@ckeditor/ckeditor5-basic-styles';
 import { BlockQuoteEditing } from '@ckeditor/ckeditor5-block-quote';
@@ -278,11 +278,40 @@ describe( 'Autoformat', () => {
 				);
 			} );
 
-			it( 'should not replace digit with numbered list item when digit is different than "1"', () => {
+			it( 'should replace digit with numbered list item when digit is different than "1"', () => {
 				_setModelData( model, '<paragraph>3.[]</paragraph>' );
 				insertSpace();
 
-				expect( _getModelData( model ) ).to.equal( '<paragraph>3. []</paragraph>' );
+				expect( _getModelData( model ) ).to.equal(
+					'<paragraph listIndent="0" listItemId="a00" listType="numbered">[]</paragraph>'
+				);
+			} );
+
+			it( 'should replace multi-digit number with numbered list item', () => {
+				_setModelData( model, '<paragraph>12.[]</paragraph>' );
+				insertSpace();
+
+				expect( _getModelData( model ) ).to.equal(
+					'<paragraph listIndent="0" listItemId="a00" listType="numbered">[]</paragraph>'
+				);
+			} );
+
+			it( 'should replace digit with numbered list item using the parenthesis format when digit is not "1"', () => {
+				_setModelData( model, '<paragraph>5)[]</paragraph>' );
+				insertSpace();
+
+				expect( _getModelData( model ) ).to.equal(
+					'<paragraph listIndent="0" listItemId="a00" listType="numbered">[]</paragraph>'
+				);
+			} );
+
+			it( 'should not replace digit character when inside numbered list item (digit different than "1")', () => {
+				_setModelData( model, '<paragraph listIndent="0" listItemId="a00" listType="numbered">5.[]</paragraph>' );
+				insertSpace();
+
+				expect( _getModelData( model ) ).to.equal(
+					'<paragraph listIndent="0" listItemId="a00" listType="numbered">5. []</paragraph>'
+				);
 			} );
 
 			it( 'should not replace digit character after <softBreak>', () => {
@@ -1631,11 +1660,40 @@ describe( 'Autoformat', () => {
 				);
 			} );
 
-			it( 'should not replace digit with numbered list item when digit is different than "1"', () => {
+			it( 'should replace digit with numbered list item when digit is different than "1"', () => {
 				_setModelData( model, '<paragraph>3.[]</paragraph>' );
 				insertSpace();
 
-				expect( _getModelData( model ) ).to.equal( '<paragraph>3. []</paragraph>' );
+				expect( _getModelData( model ) ).to.equal(
+					'<listItem listIndent="0" listItemId="a00" listType="numbered">[]</listItem>'
+				);
+			} );
+
+			it( 'should replace multi-digit number with numbered list item', () => {
+				_setModelData( model, '<paragraph>12.[]</paragraph>' );
+				insertSpace();
+
+				expect( _getModelData( model ) ).to.equal(
+					'<listItem listIndent="0" listItemId="a00" listType="numbered">[]</listItem>'
+				);
+			} );
+
+			it( 'should replace digit with numbered list item using the parenthesis format when digit is not "1"', () => {
+				_setModelData( model, '<paragraph>5)[]</paragraph>' );
+				insertSpace();
+
+				expect( _getModelData( model ) ).to.equal(
+					'<listItem listIndent="0" listItemId="a00" listType="numbered">[]</listItem>'
+				);
+			} );
+
+			it( 'should not replace digit character when inside numbered list item (digit different than "1")', () => {
+				_setModelData( model, '<listItem listIndent="0" listItemId="a00" listType="numbered">5.[]</listItem>' );
+				insertSpace();
+
+				expect( _getModelData( model ) ).to.equal(
+					'<listItem listIndent="0" listItemId="a00" listType="numbered">5. []</listItem>'
+				);
 			} );
 
 			it( 'should not replace digit character after <softBreak>', () => {
@@ -2698,6 +2756,192 @@ describe( 'Autoformat', () => {
 		} );
 	} );
 
+	describe( 'with list properties (startIndex)', () => {
+		beforeEach( async () => {
+			editor = await VirtualTestEditor.create( {
+				plugins: [
+					Enter,
+					Paragraph,
+					Autoformat,
+					ListEditing,
+					ListPropertiesEditing,
+					HeadingEditing,
+					UndoEditing
+				],
+				list: {
+					properties: {
+						startIndex: true,
+						reversed: false,
+						styles: false
+					}
+				}
+			} );
+
+			model = editor.model;
+			doc = model.document;
+
+			stubUid();
+		} );
+
+		afterEach( () => {
+			return editor.destroy();
+		} );
+
+		it( 'should set listStart attribute to 1 when typing "1. "', () => {
+			_setModelData( model, '<paragraph>1.[]</paragraph>' );
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<paragraph listIndent="0" listItemId="a00" listStart="1" listType="numbered">[]</paragraph>'
+			);
+		} );
+
+		it( 'should set listStart attribute to the typed number when typing "5. "', () => {
+			_setModelData( model, '<paragraph>5.[]</paragraph>' );
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<paragraph listIndent="0" listItemId="a00" listStart="5" listType="numbered">[]</paragraph>'
+			);
+		} );
+
+		it( 'should set listStart attribute to the typed number for multi-digit "12. "', () => {
+			_setModelData( model, '<paragraph>12.[]</paragraph>' );
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<paragraph listIndent="0" listItemId="a00" listStart="12" listType="numbered">[]</paragraph>'
+			);
+		} );
+
+		it( 'should set listStart attribute to 0 when typing "0. "', () => {
+			_setModelData( model, '<paragraph>0.[]</paragraph>' );
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<paragraph listIndent="0" listItemId="a00" listStart="0" listType="numbered">[]</paragraph>'
+			);
+		} );
+
+		it( 'should set listStart attribute to the typed number for the parenthesis format "5) "', () => {
+			_setModelData( model, '<paragraph>5)[]</paragraph>' );
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<paragraph listIndent="0" listItemId="a00" listStart="5" listType="numbered">[]</paragraph>'
+			);
+		} );
+
+		it( 'should ignore typed number and inherit listStart from adjacent numbered list above', () => {
+			_setModelData( model,
+				'<paragraph listIndent="0" listItemId="a01" listStart="1" listType="numbered">Item 1</paragraph>' +
+				'<paragraph>5.[]</paragraph>'
+			);
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<paragraph listIndent="0" listItemId="a01" listStart="1" listType="numbered">Item 1</paragraph>' +
+				'<paragraph listIndent="0" listItemId="a00" listStart="1" listType="numbered">[]</paragraph>'
+			);
+		} );
+
+		it( 'should start a new numbered list with typed listStart when adjacent list is bulleted', () => {
+			_setModelData( model,
+				'<paragraph listIndent="0" listItemId="a01" listType="bulleted">Item 1</paragraph>' +
+				'<paragraph>5.[]</paragraph>'
+			);
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<paragraph listIndent="0" listItemId="a01" listType="bulleted">Item 1</paragraph>' +
+				'<paragraph listIndent="0" listItemId="a00" listStart="5" listType="numbered">[]</paragraph>'
+			);
+		} );
+	} );
+
+	describe( 'with list properties but startIndex disabled', () => {
+		beforeEach( async () => {
+			editor = await VirtualTestEditor.create( {
+				plugins: [
+					Enter,
+					Paragraph,
+					Autoformat,
+					ListEditing,
+					ListPropertiesEditing,
+					HeadingEditing,
+					UndoEditing
+				],
+				list: {
+					properties: {
+						startIndex: false,
+						reversed: false,
+						styles: false
+					}
+				}
+			} );
+
+			model = editor.model;
+			doc = model.document;
+
+			stubUid();
+		} );
+
+		afterEach( () => {
+			return editor.destroy();
+		} );
+
+		it( 'should not set listStart attribute when typing "5. "', () => {
+			_setModelData( model, '<paragraph>5.[]</paragraph>' );
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<paragraph listIndent="0" listItemId="a00" listType="numbered">[]</paragraph>'
+			);
+		} );
+	} );
+
+	describe( 'with single-block lists plugin and list properties (startIndex)', () => {
+		beforeEach( async () => {
+			editor = await VirtualTestEditor.create( {
+				plugins: [
+					Enter,
+					Paragraph,
+					Autoformat,
+					ListEditing,
+					ListPropertiesEditing,
+					HeadingEditing,
+					UndoEditing
+				],
+				list: {
+					multiBlock: false,
+					properties: {
+						startIndex: true,
+						reversed: false,
+						styles: false
+					}
+				}
+			} );
+
+			model = editor.model;
+			doc = model.document;
+
+			stubUid();
+		} );
+
+		afterEach( () => {
+			return editor.destroy();
+		} );
+
+		it( 'should set listStart attribute to the typed number when typing "5. "', () => {
+			_setModelData( model, '<paragraph>5.[]</paragraph>' );
+			insertSpace();
+
+			expect( _getModelData( model ) ).to.equal(
+				'<listItem listIndent="0" listItemId="a00" listStart="5" listType="numbered">[]</listItem>'
+			);
+		} );
+	} );
+
 	function insertSpace() {
 		model.change( writer => {
 			writer.insertText( ' ', doc.selection.getFirstPosition() );

packages/ckeditor5-indent/src/integrations/indentblocklistintegration.ts

@@ -242,7 +242,11 @@ export class IndentBlockListIntegration extends Plugin {
 		const indentCommand = editor.commands.get( 'indent' ) as MultiCommand;
 		const outdentCommand = editor.commands.get( 'outdent' ) as MultiCommand;
 
-		indentCommand.registerChildCommand( editor.commands.get( 'indentBlockList' )! );
+		// Priority is highest so that block indent takes precedence over list indent (`indentList` is registered
+		// at `high`). When the selection is at the start of the first list item at indent 0, the block indent
+		// command adds margin instead of increasing the list indent level. For items at higher indent levels,
+		// this command is disabled and falls through to `indentList`.
+		indentCommand.registerChildCommand( editor.commands.get( 'indentBlockList' )!, { priority: 'highest' } );
 		outdentCommand.registerChildCommand( editor.commands.get( 'outdentBlockList' )! );
 
 		indentCommand.registerChildCommand( editor.commands.get( 'indentBlockListItem' )! );