Merge pull request #12603 from ckeditor/cf/4746-table-caption-tc

Fix (table): Selection should not change when table caption is turned off. Internal (table, list): Use `model.insertContent()` in table caption instead of using the writer directly.
ckeditor · Oct 17, 2022 · ffe3fe0 · ffe3fe0
2 parents 4c5815f + d8f9054
commit ffe3fe0
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 14 deletions.
diff --git a/packages/ckeditor5-list/src/list/converters.js b/packages/ckeditor5-list/src/list/converters.js
@@ -762,7 +762,7 @@ export function modelChangePostFixer( model, writer ) {
  * @param {module:utils/eventinfo~EventInfo} evt An object containing information about the fired event.
  * @param {Array} args Arguments of {@link module:engine/model/model~Model#insertContent}.
  */
-export function modelIndentPasteFixer( evt, [ content, selectable ] ) {
+export function modelIndentPasteFixer( evt, [ content, selectable, placeOrOffset ] ) {
 	// Check whether inserted content starts from a `listItem`. If it does not, it means that there are some other
 	// elements before it and there is no need to fix indents, because even if we insert that content into a list,
 	// that list will be broken.
@@ -775,7 +775,7 @@ export function modelIndentPasteFixer( evt, [ content, selectable ] ) {
 	if ( !selectable ) {
 		selection = this.document.selection;
 	} else {
-		selection = this.createSelection( selectable );
+		selection = this.createSelection( selectable, placeOrOffset );
 	}
 
 	if ( item && item.is( 'element', 'listItem' ) ) {

diff --git a/packages/ckeditor5-list/tests/list/listediting.js b/packages/ckeditor5-list/tests/list/listediting.js
@@ -4156,6 +4156,17 @@ describe( 'ListEditing', () => {
 			);
 		} );
 
+		it( 'should work if a selectable element is passed to DataController#insertContent()', () => {
+			model.change( writer => {
+				const listItem = writer.createElement( 'listItem', { listType: 'bulleted', listIndent: '0' } );
+				model.insertContent( listItem, modelRoot, 'in' );
+			} );
+
+			expect( getModelData( model ) ).to.equal(
+				'<listItem listIndent="0" listType="bulleted">[]</listItem>'
+			);
+		} );
+
 		it( 'should fix indents of pasted list items', () => {
 			setModelData( model,
 				'<listItem listType="bulleted" listIndent="0">A</listItem>' +

diff --git a/packages/ckeditor5-table/src/tablecaption/toggletablecaptioncommand.js b/packages/ckeditor5-table/src/tablecaption/toggletablecaptioncommand.js
@@ -89,7 +89,7 @@ export default class ToggleTableCaptionCommand extends Command {
 		// Try restoring the caption from the TableCaptionEditing plugin storage.
 		const newCaptionElement = savedCaptionElement || writer.createElement( 'caption' );
 
-		writer.append( newCaptionElement, tableElement );
+		model.insertContent( newCaptionElement, tableElement, 'end' );
 
 		if ( focusCaptionOnShow ) {
 			writer.setSelection( newCaptionElement, 'in' );
@@ -114,7 +114,6 @@ export default class ToggleTableCaptionCommand extends Command {
 		// Store the caption content so it can be restored quickly if the user changes their mind.
 		tableCaptionEditing._saveCaption( tableElement, captionElement );
 
-		writer.setSelection( writer.createRangeIn( tableElement.getChild( 0 ).getChild( 0 ) ) );
-		writer.remove( captionElement );
+		model.deleteContent( writer.createSelection( captionElement, 'on' ) );
 	}
 }
diff --git a/packages/ckeditor5-table/tests/tablecaption/toggletablecaptioncommand.js b/packages/ckeditor5-table/tests/tablecaption/toggletablecaptioncommand.js
@@ -13,14 +13,15 @@ import { modelTable } from '../_utils/utils';
 
 import ToggleTableCaptionCommand from '../../src/tablecaption/toggletablecaptioncommand';
 import TableCaptionEditing from '../../src/tablecaption/tablecaptionediting';
+import { BoldEditing } from '@ckeditor/ckeditor5-basic-styles';
 
 describe( 'ToggleTableCaptionCommand', () => {
 	let editor, model, command;
 
 	beforeEach( () => {
 		return ModelTestEditor
 			.create( {
-				plugins: [ Paragraph, TableEditing, TableCaptionEditing, TableSelection ]
+				plugins: [ Paragraph, TableEditing, TableCaptionEditing, TableSelection, BoldEditing ]
 			} )
 			.then( newEditor => {
 				editor = newEditor;
@@ -119,7 +120,7 @@ describe( 'ToggleTableCaptionCommand', () => {
 				'<table>' +
 					'<tableRow>' +
 						'<tableCell>' +
-							'<paragraph>[11]</paragraph>' +
+							'<paragraph>11[]</paragraph>' +
 						'</tableCell>' +
 						'<tableCell>' +
 							'<paragraph>12</paragraph>' +
@@ -177,13 +178,13 @@ describe( 'ToggleTableCaptionCommand', () => {
 			command.execute();
 
 			expect( getData( model ) ).to.equalMarkup(
-				'<table>' +
+				'[<table>' +
 					'<tableRow>' +
 						'<tableCell>' +
-							'<paragraph>[]</paragraph>' +
+							'<paragraph></paragraph>' +
 						'</tableCell>' +
 					'</tableRow>' +
-				'</table>'
+				'</table>]'
 			);
 		} );
 
@@ -217,7 +218,7 @@ describe( 'ToggleTableCaptionCommand', () => {
 				'<table>' +
 					'<tableRow>' +
 						'<tableCell>' +
-							'<paragraph></paragraph>' +
+							'<paragraph>[]</paragraph>' +
 						'</tableCell>' +
 					'</tableRow>' +
 					'<caption>Foo<$text bold="true">bar</$text></caption>' +
@@ -255,7 +256,7 @@ describe( 'ToggleTableCaptionCommand', () => {
 				'<table>' +
 					'<tableRow>' +
 						'<tableCell>' +
-							'<paragraph></paragraph>' +
+							'<paragraph>A[]bc</paragraph>' +
 						'</tableCell>' +
 					'</tableRow>' +
 					'<caption>Foo</caption>' +
@@ -269,7 +270,7 @@ describe( 'ToggleTableCaptionCommand', () => {
 				'<table>' +
 					'<tableRow>' +
 						'<tableCell>' +
-							'<paragraph>[]</paragraph>' +
+							'<paragraph>A[]bc</paragraph>' +
 						'</tableCell>' +
 					'</tableRow>' +
 				'</table>'
@@ -294,7 +295,7 @@ describe( 'ToggleTableCaptionCommand', () => {
 				'<table>' +
 					'<tableRow>' +
 						'<tableCell>' +
-							'<paragraph>[]</paragraph>' +
+							'<paragraph>A[]bc</paragraph>' +
 						'</tableCell>' +
 					'</tableRow>' +