Przeglądaj źródła

Update remaining jsdoc snippets & tests to the latest conversion API changes.

Maciej Gołaszewski 5 lat temu
rodzic
commit
0e03283e45

+ 6 - 6
packages/ckeditor5-engine/src/conversion/downcasthelpers.js

@@ -710,8 +710,8 @@ export function clearAttributes() {
  * The converter automatically consumes the corresponding value from the consumables list and stops the event (see
  * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}).
  *
- *		modelDispatcher.on( 'attribute:bold', wrap( ( modelAttributeValue, viewWriter ) => {
- *			return viewWriter.createAttributeElement( 'strong' );
+ *		modelDispatcher.on( 'attribute:bold', wrap( ( modelAttributeValue, { writer } ) => {
+ *			return writer.createAttributeElement( 'strong' );
  *		} );
  *
  * @protected
@@ -769,9 +769,9 @@ export function wrap( elementCreator ) {
  *
  *		downcastDispatcher.on(
  *			'insert:myElem',
- *			insertElement( ( modelItem, viewWriter ) => {
- *				const text = viewWriter.createText( 'myText' );
- *				const myElem = viewWriter.createElement( 'myElem', { myAttr: 'my-' + modelItem.getAttribute( 'myAttr' ) }, text );
+ *			insertElement( ( modelItem, { writer } ) => {
+ *				const text = writer.createText( 'myText' );
+ *				const myElem = writer.createElement( 'myElem', { myAttr: 'my-' + modelItem.getAttribute( 'myAttr' ) }, text );
  *
  *				// Do something fancy with `myElem` using `modelItem` or other parameters.
  *
@@ -1098,7 +1098,7 @@ function changeAttribute( attributeCreator ) {
 			 *				key: 'attribute-name',
 			 *				name: '$text'
 			 *			},
-			 *			view: ( value, writer ) => {
+			 *			view: ( value, { writer } ) => {
 			 *				return writer.createAttributeElement( 'span', { 'attribute-name': value } );
 			 *			},
 			 *			converterPriority: 'high'

+ 4 - 4
packages/ckeditor5-engine/tests/manual/highlight.js

@@ -38,11 +38,11 @@ class FancyWidget extends Plugin {
 
 		conversion.for( 'editingDowncast' ).elementToElement( {
 			model: 'fancywidget',
-			view: ( modelItem, viewWriter ) => {
-				const widgetElement = viewWriter.createContainerElement( 'figure', { class: 'fancy-widget' } );
-				viewWriter.insert( viewWriter.createPositionAt( widgetElement, 0 ), viewWriter.createText( 'widget' ) );
+			view: ( modelItem, { writer } ) => {
+				const widgetElement = writer.createContainerElement( 'figure', { class: 'fancy-widget' } );
+				writer.insert( writer.createPositionAt( widgetElement, 0 ), writer.createText( 'widget' ) );
 
-				return toWidget( widgetElement, viewWriter );
+				return toWidget( widgetElement, writer );
 			}
 		} );
 

+ 2 - 2
packages/ckeditor5-engine/tests/manual/nestededitable.js

@@ -50,8 +50,8 @@ class NestedEditable extends Plugin {
 
 		editor.conversion.for( 'downcast' ).elementToElement( {
 			model: 'figcaption',
-			view: ( modelItem, viewWriter ) => {
-				const element = viewWriter.createEditableElement( 'figcaption', { contenteditable: 'true' } );
+			view: ( modelItem, { writer } ) => {
+				const element = writer.createEditableElement( 'figcaption', { contenteditable: 'true' } );
 
 				element.on( 'change:isFocused', ( evt, property, is ) => {
 					if ( is ) {

+ 4 - 4
packages/ckeditor5-engine/tests/manual/selection.js

@@ -47,16 +47,16 @@ class SelectionTest extends Plugin {
 
 		editor.conversion.for( 'downcast' ).elementToElement( {
 			model: 'table',
-			view: ( modelItem, viewWriter ) => {
-				return toWidget( viewWriter.createContainerElement( 'table' ), viewWriter );
+			view: ( modelItem, { writer } ) => {
+				return toWidget( writer.createContainerElement( 'table' ), writer );
 			}
 		} );
 		editor.conversion.for( 'downcast' ).elementToElement( { model: 'tableRow', view: 'tr' } );
 
 		editor.conversion.for( 'downcast' ).elementToElement( {
 			model: 'tableCell',
-			view: ( modelItem, viewWriter ) => {
-				return toWidgetEditable( viewWriter.createEditableElement( 'td' ), viewWriter );
+			view: ( modelItem, { writer } ) => {
+				return toWidgetEditable( writer.createEditableElement( 'td' ), writer );
 			}
 		} );
 	}

+ 2 - 2
packages/ckeditor5-engine/tests/manual/tickets/475/1.js

@@ -25,8 +25,8 @@ class Link extends Plugin {
 
 		editor.conversion.for( 'downcast' ).attributeToElement( {
 			model: 'link',
-			view: ( modelAttributeValue, viewWriter ) => {
-				return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } );
+			view: ( modelAttributeValue, { writer } ) => {
+				return writer.createAttributeElement( 'a', { href: modelAttributeValue } );
 			}
 		} );
 

+ 2 - 2
packages/ckeditor5-engine/tests/manual/tickets/ckeditor5-721/1.js

@@ -42,7 +42,7 @@ ClassicEditor
 		editor.conversion.for( 'downcast' )
 			.elementToElement( {
 				model: 'widget',
-				view: ( modelItem, writer ) => {
+				view: ( modelItem, { writer } ) => {
 					const b = writer.createAttributeElement( 'b' );
 					const div = writer.createContainerElement( 'div' );
 
@@ -53,7 +53,7 @@ ClassicEditor
 			} )
 			.elementToElement( {
 				model: 'nested',
-				view: ( item, writer ) => writer.createEditableElement( 'figcaption', { contenteditable: true } )
+				view: ( item, { writer } ) => writer.createEditableElement( 'figcaption', { contenteditable: true } )
 			} );
 
 		setData( editor.model,

+ 2 - 2
packages/ckeditor5-mention/tests/manual/mention.js

@@ -44,7 +44,7 @@ class InlineWidget extends Plugin {
 
 		editor.conversion.for( 'upcast' ).elementToElement( {
 			view: 'placeholder',
-			model: ( viewElement, modelWriter ) => {
+			model: ( viewElement, { writer } ) => {
 				let type = 'general';
 
 				if ( viewElement.childCount ) {
@@ -55,7 +55,7 @@ class InlineWidget extends Plugin {
 					}
 				}
 
-				return modelWriter.createElement( 'placeholder', { type } );
+				return writer.createElement( 'placeholder', { type } );
 			}
 		} );
 

+ 2 - 2
packages/ckeditor5-widget/tests/manual/inline-widget.js

@@ -50,7 +50,7 @@ class InlineWidget extends Plugin {
 
 		editor.conversion.for( 'upcast' ).elementToElement( {
 			view: 'placeholder',
-			model: ( viewElement, modelWriter ) => {
+			model: ( viewElement, { writer } ) => {
 				let type = 'general';
 
 				if ( viewElement.childCount ) {
@@ -61,7 +61,7 @@ class InlineWidget extends Plugin {
 					}
 				}
 
-				return modelWriter.createElement( 'placeholder', { type } );
+				return writer.createElement( 'placeholder', { type } );
 			}
 		} );
 

+ 4 - 4
packages/ckeditor5-widget/tests/manual/keyboard.js

@@ -56,13 +56,13 @@ function BlockWidgetWithNestedEditable( editor ) {
 	editor.conversion.for( 'dataDowncast' )
 		.elementToElement( {
 			model: 'widget',
-			view: ( modelItem, writer ) => {
+			view: ( modelItem, { writer } ) => {
 				return writer.createContainerElement( 'figure' );
 			}
 		} )
 		.elementToElement( {
 			model: 'nested',
-			view: ( modelItem, writer ) => {
+			view: ( modelItem, { writer } ) => {
 				return writer.createContainerElement( 'figcaption' );
 			}
 		} );
@@ -70,7 +70,7 @@ function BlockWidgetWithNestedEditable( editor ) {
 	editor.conversion.for( 'editingDowncast' )
 		.elementToElement( {
 			model: 'widget',
-			view: ( modelItem, writer ) => {
+			view: ( modelItem, { writer } ) => {
 				const div = writer.createContainerElement( 'figure' );
 
 				return toWidget( div, writer, { label: 'widget label' } );
@@ -78,7 +78,7 @@ function BlockWidgetWithNestedEditable( editor ) {
 		} )
 		.elementToElement( {
 			model: 'nested',
-			view: ( modelItem, writer ) => {
+			view: ( modelItem, { writer } ) => {
 				const nested = writer.createEditableElement( 'figcaption' );
 
 				return toWidgetEditable( nested, writer );

+ 4 - 4
packages/ckeditor5-widget/tests/widgettoolbarrepository.js

@@ -761,8 +761,8 @@ class FakeWidget extends Plugin {
 			view: {
 				name: 'div'
 			},
-			model: ( view, modelWriter ) => {
-				return modelWriter.createElement( 'fake-widget' );
+			model: ( view, { writer } ) => {
+				return writer.createElement( 'fake-widget' );
 			}
 		} );
 	}
@@ -813,8 +813,8 @@ class FakeChildWidget extends Plugin {
 			view: {
 				name: 'div'
 			},
-			model: ( view, modelWriter ) => {
-				return modelWriter.createElement( 'fake-child-widget' );
+			model: ( view, { writer } ) => {
+				return writer.createElement( 'fake-child-widget' );
 			}
 		} );
 	}