Selaa lähdekoodia

Fix: Aligning with `HighlightDescriptor#class` -> `#classes` change in `ckeditor5-engine`.

Szymon Cofalik 7 vuotta sitten
vanhempi
commit
023f541364

+ 2 - 2
packages/ckeditor5-widget/src/highlightstack.js

@@ -135,7 +135,7 @@ mix( HighlightStack, EmitterMixin );
 // @param {module:engine/conversion/downcast-converters~HighlightDescriptor} b
 // @returns {Boolean} Returns true if both descriptors are defined and have same priority and classes.
 function compareDescriptors( a, b ) {
-	return a && b && a.priority == b.priority && classesToString( a.class ) == classesToString( b.class );
+	return a && b && a.priority == b.priority && classesToString( a.classes ) == classesToString( b.classes );
 }
 
 // Checks whenever first descriptor should be placed in the stack before second one.
@@ -151,7 +151,7 @@ function shouldABeBeforeB( a, b ) {
 	}
 
 	// When priorities are equal and names are different - use classes to compare.
-	return classesToString( a.class ) > classesToString( b.class );
+	return classesToString( a.classes ) > classesToString( b.classes );
 }
 
 // Converts CSS classes passed with {@link module:engine/conversion/downcast-converters~HighlightDescriptor} to

+ 2 - 2
packages/ckeditor5-widget/src/utils.js

@@ -64,8 +64,8 @@ export function toWidget( element, writer, options = {} ) {
 	setHighlightHandling(
 		element,
 		writer,
-		( element, descriptor, writer ) => writer.addClass( normalizeToArray( descriptor.class ), element ),
-		( element, descriptor, writer ) => writer.removeClass( normalizeToArray( descriptor.class ), element )
+		( element, descriptor, writer ) => writer.addClass( normalizeToArray( descriptor.classes ), element ),
+		( element, descriptor, writer ) => writer.removeClass( normalizeToArray( descriptor.classes ), element )
 	);
 
 	return element;

+ 25 - 25
packages/ckeditor5-widget/tests/highlightstack.js

@@ -14,7 +14,7 @@ describe( 'HighlightStack', () => {
 
 	it( 'should fire event when new descriptor is provided to an empty stack', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-id' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-id' };
 
 		stack.on( 'change:top', spy );
 		stack.add( descriptor );
@@ -26,8 +26,8 @@ describe( 'HighlightStack', () => {
 
 	it( 'should fire event when new top element has changed', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
-		const secondDescriptor = { priority: 11, class: 'css-class', id: 'descriptor-2' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
+		const secondDescriptor = { priority: 11, classes: 'css-class', id: 'descriptor-2' };
 
 		stack.on( 'change:top', spy );
 		stack.add( descriptor );
@@ -40,8 +40,8 @@ describe( 'HighlightStack', () => {
 
 	it( 'should fire event when top element has updated', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
-		const secondDescriptor = { priority: 11, class: 'css-class', id: 'descriptor-1' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
+		const secondDescriptor = { priority: 11, classes: 'css-class', id: 'descriptor-1' };
 
 		stack.on( 'change:top', spy );
 		stack.add( descriptor );
@@ -57,8 +57,8 @@ describe( 'HighlightStack', () => {
 
 	it( 'should not fire event when element with lower priority was added', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
-		const secondDescriptor = { priority: 9, class: 'css-class', id: 'descriptor-2' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
+		const secondDescriptor = { priority: 9, classes: 'css-class', id: 'descriptor-2' };
 
 		stack.on( 'change:top', spy );
 		stack.add( descriptor );
@@ -71,8 +71,8 @@ describe( 'HighlightStack', () => {
 
 	it( 'should fire event when top element was removed', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
-		const secondDescriptor = { priority: 11, class: 'css-class', id: 'descriptor-2' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
+		const secondDescriptor = { priority: 11, classes: 'css-class', id: 'descriptor-2' };
 
 		stack.add( descriptor );
 		stack.add( secondDescriptor );
@@ -88,8 +88,8 @@ describe( 'HighlightStack', () => {
 
 	it( 'should not fire event when other than top element is removed', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
-		const secondDescriptor = { priority: 11, class: 'css-class', id: 'descriptor-2' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
+		const secondDescriptor = { priority: 11, classes: 'css-class', id: 'descriptor-2' };
 
 		stack.add( descriptor );
 		stack.add( secondDescriptor );
@@ -103,8 +103,8 @@ describe( 'HighlightStack', () => {
 
 	it( 'should not fire event when same descriptor is added', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
-		const secondDescriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
+		const secondDescriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
 
 		stack.on( 'change:top', spy );
 		stack.add( descriptor );
@@ -117,7 +117,7 @@ describe( 'HighlightStack', () => {
 
 	it( 'should not fire when trying to remove from empty stack', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class' };
+		const descriptor = { priority: 10, classes: 'css-class' };
 
 		stack.on( 'change:top', spy );
 		stack.remove( descriptor );
@@ -127,8 +127,8 @@ describe( 'HighlightStack', () => {
 
 	it( 'should not fire when trying to remove descriptor which is not present', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
-		const secondDescriptor = { priority: 12, class: 'css-class', id: 'descriptor-2' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
+		const secondDescriptor = { priority: 12, classes: 'css-class', id: 'descriptor-2' };
 
 		stack.add( descriptor );
 		stack.on( 'change:top', spy );
@@ -139,7 +139,7 @@ describe( 'HighlightStack', () => {
 
 	it( 'should fire event when last element from stack was removed', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor' };
 
 		stack.add( descriptor );
 		stack.on( 'change:top', spy );
@@ -152,8 +152,8 @@ describe( 'HighlightStack', () => {
 
 	it( 'should not fire event when new top descriptor is same as previous', () => {
 		const spy = sinon.spy();
-		const descriptor = { priority: 10, class: 'css-class', id: 'descriptor-1' };
-		const secondDescriptor = { priority: 10, class: 'css-class', id: 'descriptor-2' };
+		const descriptor = { priority: 10, classes: 'css-class', id: 'descriptor-1' };
+		const secondDescriptor = { priority: 10, classes: 'css-class', id: 'descriptor-2' };
 
 		stack.add( descriptor );
 		stack.add( secondDescriptor );
@@ -165,9 +165,9 @@ describe( 'HighlightStack', () => {
 
 	it( 'should sort by class when priorities are the same', () => {
 		const spy = sinon.spy();
-		const descriptorA = { priority: 10, class: 'css-a', id: 'descriptor-1' };
-		const descriptorB = { priority: 10, class: 'css-b', id: 'descriptor-2' };
-		const descriptorC = { priority: 10, class: 'css-c', id: 'descriptor-3' };
+		const descriptorA = { priority: 10, classes: 'css-a', id: 'descriptor-1' };
+		const descriptorB = { priority: 10, classes: 'css-b', id: 'descriptor-2' };
+		const descriptorC = { priority: 10, classes: 'css-c', id: 'descriptor-3' };
 
 		stack.on( 'change:top', spy );
 		stack.add( descriptorB );
@@ -184,9 +184,9 @@ describe( 'HighlightStack', () => {
 
 	it( 'should sort by class when priorities are the same - array of CSS classes', () => {
 		const spy = sinon.spy();
-		const descriptorA = { priority: 10, class: [ 'css-a', 'css-z' ], id: 'descriptor-1' };
-		const descriptorB = { priority: 10, class: [ 'css-a', 'css-y' ], id: 'descriptor-2' };
-		const descriptorC = { priority: 10, class: 'css-c', id: 'descriptor-3' };
+		const descriptorA = { priority: 10, classes: [ 'css-a', 'css-z' ], id: 'descriptor-1' };
+		const descriptorB = { priority: 10, classes: [ 'css-a', 'css-y' ], id: 'descriptor-2' };
+		const descriptorC = { priority: 10, classes: 'css-c', id: 'descriptor-3' };
 
 		stack.on( 'change:top', spy );
 		stack.add( descriptorB );

+ 13 - 13
packages/ckeditor5-widget/tests/utils.js

@@ -63,7 +63,7 @@ describe( 'widget utils', () => {
 			expect( typeof set ).to.equal( 'function' );
 			expect( typeof remove ).to.equal( 'function' );
 
-			set( element, { priority: 1, class: 'highlight', id: 'highlight' }, writer );
+			set( element, { priority: 1, classes: 'highlight', id: 'highlight' }, writer );
 			expect( element.hasClass( 'highlight' ) ).to.be.true;
 
 			remove( element, 'highlight', writer );
@@ -79,7 +79,7 @@ describe( 'widget utils', () => {
 			expect( typeof set ).to.equal( 'function' );
 			expect( typeof remove ).to.equal( 'function' );
 
-			set( element, { priority: 1, class: [ 'highlight', 'foo' ], id: 'highlight' }, writer );
+			set( element, { priority: 1, classes: [ 'highlight', 'foo' ], id: 'highlight' }, writer );
 			expect( element.hasClass( 'highlight' ) ).to.be.true;
 			expect( element.hasClass( 'foo' ) ).to.be.true;
 
@@ -187,7 +187,7 @@ describe( 'widget utils', () => {
 		} );
 
 		it( 'should call highlight methods when descriptor is added and removed', () => {
-			const descriptor = { priority: 10, class: 'highlight', id: 'highlight' };
+			const descriptor = { priority: 10, classes: 'highlight', id: 'highlight' };
 
 			set( element, descriptor, writer );
 			remove( element, descriptor.id, writer );
@@ -200,8 +200,8 @@ describe( 'widget utils', () => {
 		} );
 
 		it( 'should call highlight methods when next descriptor is added', () => {
-			const descriptor = { priority: 10, class: 'highlight', id: 'highlight-1' };
-			const secondDescriptor = { priority: 11, class: 'highlight', id: 'highlight-2' };
+			const descriptor = { priority: 10, classes: 'highlight', id: 'highlight-1' };
+			const secondDescriptor = { priority: 11, classes: 'highlight', id: 'highlight-2' };
 
 			set( element, descriptor );
 			set( element, secondDescriptor );
@@ -212,8 +212,8 @@ describe( 'widget utils', () => {
 		} );
 
 		it( 'should not call highlight methods when descriptor with lower priority is added', () => {
-			const descriptor = { priority: 10, class: 'highlight', id: 'highlight-1' };
-			const secondDescriptor = { priority: 9, class: 'highlight', id: 'highlight-2' };
+			const descriptor = { priority: 10, classes: 'highlight', id: 'highlight-1' };
+			const secondDescriptor = { priority: 9, classes: 'highlight', id: 'highlight-2' };
 
 			set( element, descriptor );
 			set( element, secondDescriptor );
@@ -223,8 +223,8 @@ describe( 'widget utils', () => {
 		} );
 
 		it( 'should call highlight methods when descriptor is removed changing active descriptor', () => {
-			const descriptor = { priority: 10, class: 'highlight', id: 'highlight-1' };
-			const secondDescriptor = { priority: 11, class: 'highlight', id: 'highlight-2' };
+			const descriptor = { priority: 10, classes: 'highlight', id: 'highlight-1' };
+			const secondDescriptor = { priority: 11, classes: 'highlight', id: 'highlight-2' };
 
 			set( element, descriptor );
 			set( element, secondDescriptor );
@@ -241,8 +241,8 @@ describe( 'widget utils', () => {
 		} );
 
 		it( 'should call highlight methods when descriptor is removed not changing active descriptor', () => {
-			const descriptor = { priority: 10, class: 'highlight', id: 'highlight-1' };
-			const secondDescriptor = { priority: 9, class: 'highlight', id: 'highlight-2' };
+			const descriptor = { priority: 10, classes: 'highlight', id: 'highlight-1' };
+			const secondDescriptor = { priority: 9, classes: 'highlight', id: 'highlight-2' };
 
 			set( element, descriptor );
 			set( element, secondDescriptor );
@@ -255,8 +255,8 @@ describe( 'widget utils', () => {
 		} );
 
 		it( 'should call highlight methods - CSS class array', () => {
-			const descriptor = { priority: 10, class: [ 'highlight', 'a' ], id: 'highlight-1' };
-			const secondDescriptor = { priority: 10, class: [ 'highlight', 'b' ], id: 'highlight-2' };
+			const descriptor = { priority: 10, classes: [ 'highlight', 'a' ], id: 'highlight-1' };
+			const secondDescriptor = { priority: 10, classes: [ 'highlight', 'b' ], id: 'highlight-2' };
 
 			set( element, descriptor );
 			set( element, secondDescriptor );