| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import Model from '../../src/model/model';
- import ModelElement from '../../src/model/element';
- import ModelText from '../../src/model/text';
- import ModelRange from '../../src/model/range';
- import ModelPosition from '../../src/model/position';
- import ViewElement from '../../src/view/element';
- import ViewContainerElement from '../../src/view/containerelement';
- import ViewAttributeElement from '../../src/view/attributeelement';
- import ViewUIElement from '../../src/view/uielement';
- import ViewText from '../../src/view/text';
- import {
- insertElement,
- insertUIElement,
- changeAttribute,
- wrap,
- removeUIElement,
- highlightElement,
- highlightText,
- removeHighlight,
- createViewElementFromHighlightDescriptor
- } from '../../src/conversion/model-to-view-converters';
- import EditingController from '../../src/controller/editingcontroller';
- describe( 'model-to-view-converters', () => {
- let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
- beforeEach( () => {
- model = new Model();
- modelDoc = model.document;
- modelRoot = modelDoc.createRoot();
- controller = new EditingController( model );
- viewRoot = controller.view.getRoot();
- // Set name of view root the same as dom root.
- // This is a mock of attaching view root to dom root.
- controller.view.getRoot()._name = 'div';
- dispatcher = controller.modelToView;
- dispatcher.on( 'insert:paragraph', insertElement( () => new ViewContainerElement( 'p' ) ) );
- dispatcher.on( 'attribute:class', changeAttribute() );
- modelRootStart = ModelPosition.createAt( modelRoot, 0 );
- } );
- function viewAttributesToString( item ) {
- let result = '';
- for ( const key of item.getAttributeKeys() ) {
- const value = item.getAttribute( key );
- if ( value ) {
- result += ' ' + key + '="' + value + '"';
- }
- }
- return result;
- }
- function viewToString( item ) {
- let result = '';
- if ( item instanceof ViewText ) {
- result = item.data;
- } else {
- // ViewElement or ViewDocumentFragment.
- for ( const child of item.getChildren() ) {
- result += viewToString( child );
- }
- if ( item instanceof ViewElement ) {
- result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
- }
- }
- return result;
- }
- describe( 'insertText', () => {
- it( 'should convert text insertion in model to view text', () => {
- model.change( writer => {
- writer.insert( new ModelText( 'foobar' ), modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
- } );
- it( 'should support unicode', () => {
- model.change( writer => {
- writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
- } );
- it( 'should be possible to override it', () => {
- dispatcher.on( 'insert:$text', ( evt, data, consumable ) => {
- consumable.consume( data.item, 'insert' );
- }, { priority: 'high' } );
- model.change( writer => {
- writer.insert( new ModelText( 'foobar' ), modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
- } );
- } );
- describe( 'insertElement', () => {
- it( 'should convert element insertion in model to and map positions for future converting', () => {
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should take view element function generator as a parameter', () => {
- const elementGenerator = ( modelItem, consumable ) => {
- if ( consumable.consume( modelItem, 'attribute:nice' ) ) {
- return new ViewContainerElement( 'div' );
- }
- // Test if default converter will be fired for paragraph, if `null` is returned and consumable was not consumed.
- return null;
- };
- dispatcher.on( 'insert:paragraph', insertElement( elementGenerator ), { priority: 'high' } );
- const niceP = new ModelElement( 'paragraph', { nice: true }, new ModelText( 'foo' ) );
- const badP = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
- model.change( writer => {
- writer.insert( [ niceP, badP ], modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
- } );
- } );
- describe( 'setAttribute', () => {
- it( 'should convert attribute insert/change/remove on a model node', () => {
- const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
- model.change( writer => {
- writer.setAttribute( 'class', 'bar', modelElement );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
- model.change( writer => {
- writer.removeAttribute( 'class', modelElement );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
- const themeConverter = ( value, data ) => {
- if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
- value += ' fix-content';
- }
- return { key: 'class', value };
- };
- dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
- dispatcher.on( 'attribute:theme', changeAttribute( themeConverter ) );
- const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
- const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
- model.change( writer => {
- writer.insert( [ modelParagraph, modelDiv ], modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
- model.change( writer => {
- writer.setAttribute( 'theme', 'awesome', modelParagraph );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
- model.change( writer => {
- writer.removeAttribute( 'theme', modelParagraph );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
- } );
- it( 'should be possible to override setAttribute', () => {
- const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
- dispatcher.on( 'attribute:class', ( evt, data, consumable ) => {
- consumable.consume( data.item, 'attribute:class' );
- }, { priority: 'high' } );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- // No attribute set.
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- } );
- describe( 'wrap', () => {
- it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
- const viewB = new ViewAttributeElement( 'b' );
- dispatcher.on( 'attribute:bold', wrap( viewB ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
- model.change( writer => {
- writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
- const elementGenerator = value => {
- if ( value == 'bold' ) {
- return new ViewAttributeElement( 'b' );
- }
- };
- dispatcher.on( 'attribute:style', wrap( elementGenerator ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
- model.change( writer => {
- writer.removeAttribute( 'style', ModelRange.createIn( modelElement ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should update range on re-wrapping attribute (#475)', () => {
- const modelElement = new ModelElement( 'paragraph', null, [
- new ModelText( 'x' ),
- new ModelText( 'foo', { link: 'http://foo.com' } ),
- new ModelText( 'x' )
- ] );
- const elementGenerator = href => new ViewAttributeElement( 'a', { href } );
- dispatcher.on( 'attribute:link', wrap( elementGenerator ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
- // Set new attribute on old link but also on non-linked characters.
- model.change( writer => {
- writer.setAttribute( 'link', 'http://foobar.com', ModelRange.createIn( modelElement ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
- } );
- it( 'should support unicode', () => {
- const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
- const viewB = new ViewAttributeElement( 'b' );
- dispatcher.on( 'attribute:bold', wrap( viewB ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
- model.change( writer => {
- writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
- } );
- it( 'should be possible to override wrap', () => {
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
- const viewB = new ViewAttributeElement( 'b' );
- dispatcher.on( 'attribute:bold', wrap( viewB ) );
- dispatcher.on( 'attribute:bold', ( evt, data, consumable ) => {
- consumable.consume( data.item, 'attribute:bold' );
- }, { priority: 'high' } );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should not convert and not consume if creator function returned null', () => {
- const elementGenerator = () => null;
- sinon.spy( dispatcher, 'fire' );
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
- dispatcher.on( 'attribute:italic', wrap( elementGenerator ) );
- dispatcher.on( 'attribute:italic', ( evt, data, consumable ) => {
- expect( consumable.test( data.item, 'attribute:italic' ) ).to.be.true;
- } );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- expect( dispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
- } );
- } );
- describe( 'insertUIElement/removeUIElement', () => {
- let modelText, modelElement, range;
- beforeEach( () => {
- modelText = new ModelText( 'foobar' );
- modelElement = new ModelElement( 'paragraph', null, modelText );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- } );
- describe( 'collapsed range', () => {
- beforeEach( () => {
- range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
- } );
- it( 'should insert and remove ui element - element as a creator', () => {
- const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
- dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
- dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
- model.change( writer => {
- writer.setMarker( 'marker', range );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should insert and remove ui element - function as a creator', () => {
- const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
- dispatcher.on( 'addMarker:marker', insertUIElement( () => viewUi ) );
- dispatcher.on( 'removeMarker:marker', removeUIElement( () => viewUi ) );
- model.change( writer => {
- writer.setMarker( 'marker', range );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should not convert if consumable was consumed', () => {
- const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
- sinon.spy( dispatcher, 'fire' );
- dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
- dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
- consumable.consume( data.markerRange, 'addMarker:marker' );
- }, { priority: 'high' } );
- dispatcher.convertMarkerAdd( 'marker', range );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
- } );
- it( 'should not convert if creator returned null', () => {
- dispatcher.on( 'addMarker:marker', insertUIElement( () => null ) );
- dispatcher.on( 'removeMarker:marker', removeUIElement( () => null ) );
- model.change( writer => {
- writer.setMarker( 'marker', range );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- } );
- describe( 'non-collapsed range', () => {
- beforeEach( () => {
- range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 5 );
- } );
- it( 'should insert and remove ui element - element as a creator', () => {
- const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
- dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
- dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
- model.change( writer => {
- writer.setMarker( 'marker', range );
- } );
- expect( viewToString( viewRoot ) )
- .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should insert and remove ui element - function as a creator', () => {
- const viewUi = data => new ViewUIElement( 'span', { 'class': data.markerName } );
- dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
- dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
- model.change( writer => {
- writer.setMarker( 'marker', range );
- } );
- expect( viewToString( viewRoot ) )
- .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should insert and remove different opening and ending element', () => {
- function creator( data ) {
- if ( data.isOpening ) {
- return new ViewUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
- }
- return new ViewUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
- }
- dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
- dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
- model.change( writer => {
- writer.setMarker( 'marker', range );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
- );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should not convert if consumable was consumed', () => {
- const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
- sinon.spy( dispatcher, 'fire' );
- dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
- dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
- consumable.consume( data.item, 'addMarker:marker' );
- }, { priority: 'high' } );
- dispatcher.convertMarkerAdd( 'marker', range );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
- } );
- } );
- } );
- // Remove converter is by default already added in `EditingController` instance.
- describe( 'remove', () => {
- it( 'should remove items from view accordingly to changes in model #1', () => {
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- model.change( writer => {
- writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
- } );
- it( 'should be possible to overwrite', () => {
- dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- model.change( writer => {
- writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should support unicode', () => {
- const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- model.change( writer => {
- writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 0, modelElement, 6 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
- } );
- it( 'should not remove view ui elements that are placed next to removed content', () => {
- modelRoot.appendChildren( new ModelText( 'fozbar' ) );
- viewRoot.appendChildren( [
- new ViewText( 'foz' ),
- new ViewUIElement( 'span' ),
- new ViewText( 'bar' )
- ] );
- // Remove 'b'.
- model.change( writer => {
- writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
- // Remove 'z'.
- model.change( writer => {
- writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 3 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
- } );
- it( 'should remove correct amount of text when it is split by view ui element', () => {
- modelRoot.appendChildren( new ModelText( 'fozbar' ) );
- viewRoot.appendChildren( [
- new ViewText( 'foz' ),
- new ViewUIElement( 'span' ),
- new ViewText( 'bar' )
- ] );
- // Remove 'z<span></span>b'.
- model.change( writer => {
- writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
- } );
- it( 'should unbind elements', () => {
- const modelElement = new ModelElement( 'paragraph' );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- const viewElement = controller.mapper.toViewElement( modelElement );
- expect( viewElement ).not.to.be.undefined;
- expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
- model.change( writer => {
- writer.remove( modelElement );
- } );
- expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
- expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
- } );
- it( 'should not break when remove() is used as part of unwrapping', () => {
- const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
- const modelWidget = new ModelElement( 'widget', null, modelP );
- dispatcher.on( 'insert:widget', insertElement( () => new ViewContainerElement( 'widget' ) ) );
- model.change( writer => {
- writer.insert( modelWidget, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
- const viewP = controller.mapper.toViewElement( modelP );
- expect( viewP ).not.to.be.undefined;
- model.change( writer => {
- writer.unwrap( modelWidget );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
- // `modelP` is now bound with newly created view element.
- expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
- // `viewP` is no longer bound with model element.
- expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
- // View element from view root is bound to `modelP`.
- expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
- } );
- it( 'should work correctly if container element after ui element is removed', () => {
- // Prepare a model and view structure.
- // This is done outside of conversion to put view ui elements inside easily.
- const modelP1 = new ModelElement( 'paragraph' );
- const modelP2 = new ModelElement( 'paragraph' );
- const viewP1 = new ViewContainerElement( 'p' );
- const viewUi1 = new ViewUIElement( 'span' );
- const viewUi2 = new ViewUIElement( 'span' );
- const viewP2 = new ViewContainerElement( 'p' );
- modelRoot.appendChildren( [ modelP1, modelP2 ] );
- viewRoot.appendChildren( [ viewP1, viewUi1, viewUi2, viewP2 ] );
- controller.mapper.bindElements( modelP1, viewP1 );
- controller.mapper.bindElements( modelP2, viewP2 );
- // Remove second paragraph element.
- model.change( writer => {
- writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
- } );
- it( 'should work correctly if container element after text node is removed', () => {
- const modelText = new ModelText( 'foo' );
- const modelP = new ModelElement( 'paragraph' );
- model.change( writer => {
- writer.insert( [ modelText, modelP ], modelRootStart );
- } );
- model.change( writer => {
- writer.remove( modelP );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
- } );
- } );
- describe( 'highlight', () => {
- describe( 'on text', () => {
- const highlightDescriptor = {
- class: 'highlight-class',
- priority: 7,
- attributes: { title: 'title' }
- };
- let markerRange;
- beforeEach( () => {
- const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
- const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
- model.change( writer => {
- writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
- } );
- markerRange = ModelRange.createIn( modelRoot );
- } );
- it( 'should wrap and unwrap text nodes', () => {
- dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
- dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
- dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
- model.change( writer => {
- writer.setMarker( 'marker', markerRange );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<p>' +
- '<span class="highlight-class" title="title">foo</span>' +
- '</p>' +
- '<p>' +
- '<span class="highlight-class" title="title">bar</span>' +
- '</p>' +
- '</div>'
- );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
- } );
- it( 'should be possible to overwrite', () => {
- dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
- dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
- dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
- const newDescriptor = { class: 'override-class' };
- dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
- dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
- dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
- model.change( writer => {
- writer.setMarker( 'marker', markerRange );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<p>' +
- '<span class="override-class">foo</span>' +
- '</p>' +
- '<p>' +
- '<span class="override-class">bar</span>' +
- '</p>' +
- '</div>'
- );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
- } );
- it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
- dispatcher.on( 'addMarker:marker', highlightText( () => null ), { priority: 'high' } );
- dispatcher.on( 'addMarker:marker', highlightElement( () => null ), { priority: 'high' } );
- dispatcher.on( 'removeMarker:marker', removeHighlight( () => null ), { priority: 'high' } );
- model.change( writer => {
- writer.setMarker( 'marker', markerRange );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
- } );
- } );
- describe( 'on element', () => {
- const highlightDescriptor = {
- class: 'highlight-class',
- priority: 7,
- attributes: { title: 'title' },
- id: 'customId'
- };
- let markerRange;
- beforeEach( () => {
- // Provide converter for div element. View div element will have custom highlight handling.
- dispatcher.on( 'insert:div', insertElement( () => {
- const viewContainer = new ViewContainerElement( 'div' );
- viewContainer.setCustomProperty( 'addHighlight', ( element, descriptor ) => {
- element.addClass( descriptor.class );
- } );
- viewContainer.setCustomProperty( 'removeHighlight', element => {
- element.setAttribute( 'class', '' );
- } );
- return viewContainer;
- } ) );
- const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- markerRange = ModelRange.createOn( modelElement );
- dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
- dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
- dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
- } );
- it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
- model.change( writer => {
- writer.setMarker( 'marker', markerRange );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<div class="highlight-class">' +
- 'foo' +
- '</div>' +
- '</div>'
- );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
- } );
- it( 'should be possible to override', () => {
- const newDescriptor = { class: 'override-class' };
- dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
- dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
- dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
- model.change( writer => {
- writer.setMarker( 'marker', markerRange );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<div class="override-class">' +
- 'foo' +
- '</div>' +
- '</div>'
- );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
- } );
- it( 'should use default priority and id if not provided', () => {
- const viewDiv = viewRoot.getChild( 0 );
- dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
- dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
- dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
- viewDiv.setCustomProperty( 'addHighlight', ( element, descriptor ) => {
- expect( descriptor.priority ).to.equal( 10 );
- expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
- } );
- viewDiv.setCustomProperty( 'removeHighlight', ( element, id ) => {
- expect( id ).to.equal( 'marker:foo-bar-baz' );
- } );
- model.change( writer => {
- writer.setMarker( 'marker2', markerRange );
- } );
- } );
- it( 'should do nothing if descriptor is not provided', () => {
- dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
- dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
- dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
- model.change( writer => {
- writer.setMarker( 'marker2', markerRange );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
- model.change( writer => {
- writer.removeMarker( 'marker2' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
- } );
- } );
- } );
- describe( 'createViewElementFromHighlightDescriptor()', () => {
- it( 'should return attribute element from descriptor object', () => {
- const descriptor = {
- class: 'foo-class',
- attributes: { one: '1', two: '2' },
- priority: 7,
- };
- const element = createViewElementFromHighlightDescriptor( descriptor );
- expect( element.is( 'attributeElement' ) ).to.be.true;
- expect( element.name ).to.equal( 'span' );
- expect( element.priority ).to.equal( 7 );
- expect( element.hasClass( 'foo-class' ) ).to.be.true;
- for ( const key of Object.keys( descriptor.attributes ) ) {
- expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
- }
- } );
- it( 'should return attribute element from descriptor object - array with classes', () => {
- const descriptor = {
- class: [ 'foo-class', 'bar-class' ],
- attributes: { one: '1', two: '2' },
- priority: 7,
- };
- const element = createViewElementFromHighlightDescriptor( descriptor );
- expect( element.is( 'attributeElement' ) ).to.be.true;
- expect( element.name ).to.equal( 'span' );
- expect( element.priority ).to.equal( 7 );
- expect( element.hasClass( 'foo-class' ) ).to.be.true;
- expect( element.hasClass( 'bar-class' ) ).to.be.true;
- for ( const key of Object.keys( descriptor.attributes ) ) {
- expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
- }
- } );
- it( 'should create element without class', () => {
- const descriptor = {
- attributes: { one: '1', two: '2' },
- priority: 7,
- };
- const element = createViewElementFromHighlightDescriptor( descriptor );
- expect( element.is( 'attributeElement' ) ).to.be.true;
- expect( element.name ).to.equal( 'span' );
- expect( element.priority ).to.equal( 7 );
- for ( const key of Object.keys( descriptor.attributes ) ) {
- expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
- }
- } );
- it( 'should create element without priority', () => {
- const descriptor = {
- class: 'foo-class',
- attributes: { one: '1', two: '2' },
- };
- const element = createViewElementFromHighlightDescriptor( descriptor );
- expect( element.is( 'attributeElement' ) ).to.be.true;
- expect( element.name ).to.equal( 'span' );
- expect( element.priority ).to.equal( 10 );
- expect( element.hasClass( 'foo-class' ) ).to.be.true;
- for ( const key of Object.keys( descriptor.attributes ) ) {
- expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
- }
- } );
- it( 'should create element without attributes', () => {
- const descriptor = {
- class: 'foo-class',
- priority: 7
- };
- const element = createViewElementFromHighlightDescriptor( descriptor );
- expect( element.is( 'attributeElement' ) ).to.be.true;
- expect( element.name ).to.equal( 'span' );
- expect( element.priority ).to.equal( 7 );
- expect( element.hasClass( 'foo-class' ) ).to.be.true;
- } );
- it( 'should create similar elements if they are created using same descriptor id', () => {
- const a = createViewElementFromHighlightDescriptor( {
- id: 'id',
- class: 'classA',
- priority: 1
- } );
- const b = createViewElementFromHighlightDescriptor( {
- id: 'id',
- class: 'classB',
- priority: 2
- } );
- expect( a.isSimilar( b ) ).to.be.true;
- } );
- it( 'should create non-similar elements if they have different descriptor id', () => {
- const a = createViewElementFromHighlightDescriptor( {
- id: 'a',
- class: 'foo',
- priority: 1
- } );
- const b = createViewElementFromHighlightDescriptor( {
- id: 'b',
- class: 'foo',
- priority: 1
- } );
- expect( a.isSimilar( b ) ).to.be.false;
- } );
- } );
- } );
|