Merge pull request #13784 from ckeditor/ck/11008-allow-saving-data-in…

…-source-mode Feature (source-editing): Make `SourceEditing.updateEditorData` method public to allow saving source editing data independently of the UI. Closes #11008.
ckeditor · Apr 3, 2023 · acc02f4 · acc02f4
2 parents 90445f8 + 70de37f
commit acc02f4
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 25 deletions.
diff --git a/packages/ckeditor5-source-editing/src/sourceediting.ts b/packages/ckeditor5-source-editing/src/sourceediting.ts
@@ -150,7 +150,7 @@ export default class SourceEditing extends Plugin {
 		// Update the editor data while calling editor.getData() in the source editing mode.
 		editor.data.on( 'get', () => {
 			if ( this.isSourceEditingMode ) {
-				this._updateEditorData();
+				this.updateEditorData();
 			}
 		}, { priority: 'high' } );
 	}
@@ -187,6 +187,29 @@ export default class SourceEditing extends Plugin {
 		}
 	}
 
+	/**
+	 * Updates the source data in all hidden editing roots.
+	 */
+	public updateEditorData(): void {
+		const editor = this.editor;
+		const data: Record<string, string> = {};
+
+		for ( const [ rootName, domSourceEditingElementWrapper ] of this._replacedRoots ) {
+			const oldData = this._dataFromRoots.get( rootName );
+			const newData = domSourceEditingElementWrapper.dataset.value!;
+
+			// Do not set the data unless some changes have been made in the meantime.
+			// This prevents empty undo steps after switching to the normal editor.
+			if ( oldData !== newData ) {
+				data[ rootName ] = newData;
+			}
+		}
+
+		if ( Object.keys( data ).length ) {
+			editor.data.set( data, { batchType: { isUndoable: true } } );
+		}
+	}
+
 	/**
 	 * Creates source editing wrappers that replace each editing root. Each wrapper contains the document source from the corresponding
 	 * root.
@@ -262,7 +285,7 @@ export default class SourceEditing extends Plugin {
 		const editor = this.editor;
 		const editingView = editor.editing.view;
 
-		this._updateEditorData();
+		this.updateEditorData();
 
 		editingView.change( writer => {
 			for ( const [ rootName ] of this._replacedRoots ) {
@@ -278,29 +301,6 @@ export default class SourceEditing extends Plugin {
 		editingView.focus();
 	}
 
-	/**
-	 * Updates the source data in all hidden editing roots.
-	 */
-	private _updateEditorData(): void {
-		const editor = this.editor;
-		const data: Record<string, string> = {};
-
-		for ( const [ rootName, domSourceEditingElementWrapper ] of this._replacedRoots ) {
-			const oldData = this._dataFromRoots.get( rootName );
-			const newData = domSourceEditingElementWrapper.dataset.value!;
-
-			// Do not set the data unless some changes have been made in the meantime.
-			// This prevents empty undo steps after switching to the normal editor.
-			if ( oldData !== newData ) {
-				data[ rootName ] = newData;
-			}
-		}
-
-		if ( Object.keys( data ).length ) {
-			editor.data.set( data, { batchType: { isUndoable: true } } );
-		}
-	}
-
 	/**
 	 * Focuses the textarea containing document source from the first editing root.
 	 */

diff --git a/packages/ckeditor5-source-editing/tests/sourceediting.js b/packages/ckeditor5-source-editing/tests/sourceediting.js
@@ -514,6 +514,22 @@ describe( 'SourceEditing', () => {
 		} );
 	} );
 
+	describe( 'updateEditorData', () => {
+		it( 'should update editor model when called', () => {
+			button.fire( 'execute' );
+
+			const domRoot = editor.editing.view.getDomRoot();
+			const textarea = domRoot.nextSibling.children[ 0 ];
+
+			textarea.value = 'bar';
+			textarea.dispatchEvent( new Event( 'input' ) );
+
+			expect( getData( editor.model, { withoutSelection: true } ) ).to.equal( '<paragraph>Foo</paragraph>' );
+			plugin.updateEditorData();
+			expect( getData( editor.model, { withoutSelection: true } ) ).to.equal( '<paragraph>bar</paragraph>' );
+		} );
+	} );
+
 	describe( 'integration with undo', () => {
 		it( 'should preserve the undo/redo stacks when no changes has been in the source editing mode', () => {
 			editor.model.change( writer => {