| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import EditingController from '../../src/controller/editingcontroller';
- import Conversion from '../../src/conversion/conversion';
- 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 ViewUIElement from '../../src/view/uielement';
- import ViewText from '../../src/view/text';
- import {
- downcastElementToElement, downcastAttributeToElement, downcastAttributeToAttribute, downcastMarkerToElement, downcastMarkerToHighlight,
- insertElement, insertUIElement, changeAttribute, wrap, removeUIElement,
- highlightElement, highlightText, removeHighlight, createViewElementFromHighlightDescriptor
- } from '../../src/conversion/downcast-converters';
- import { stringify } from '../../src/dev-utils/view';
- describe( 'downcast-helpers', () => {
- let conversion, model, modelRoot, viewRoot;
- beforeEach( () => {
- model = new Model();
- const modelDoc = model.document;
- modelRoot = modelDoc.createRoot();
- const controller = new EditingController( model );
- // Set name of view root the same as dom root.
- // This is a mock of attaching view root to dom root.
- controller.view.document.getRoot()._name = 'div';
- viewRoot = controller.view.document.getRoot();
- conversion = new Conversion();
- conversion.register( 'downcast', [ controller.downcastDispatcher ] );
- } );
- describe( 'downcastElementToElement', () => {
- it( 'config.view is a string', () => {
- const helper = downcastElementToElement( { model: 'paragraph', view: 'p' } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertElement( 'paragraph', modelRoot, 0 );
- } );
- expectResult( '<p></p>' );
- } );
- it( 'can be overwritten using priority', () => {
- const helperA = downcastElementToElement( { model: 'paragraph', view: 'p' } );
- const helperB = downcastElementToElement( { model: 'paragraph', view: 'foo', priority: 'high' } );
- conversion.for( 'downcast' ).add( helperA ).add( helperB );
- model.change( writer => {
- writer.insertElement( 'paragraph', modelRoot, 0 );
- } );
- expectResult( '<foo></foo>' );
- } );
- it( 'config.view is a view element definition', () => {
- const helper = downcastElementToElement( {
- model: 'fancyParagraph',
- view: {
- name: 'p',
- class: 'fancy'
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertElement( 'fancyParagraph', modelRoot, 0 );
- } );
- expectResult( '<p class="fancy"></p>' );
- } );
- it( 'config.view is a function', () => {
- const helper = downcastElementToElement( {
- model: 'heading',
- view: ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) )
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertElement( 'heading', { level: 2 }, modelRoot, 0 );
- } );
- expectResult( '<h2></h2>' );
- } );
- } );
- describe( 'downcastAttributeToElement', () => {
- it( 'config.view is a string', () => {
- const helper = downcastAttributeToElement( { model: 'bold', view: 'strong' } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
- } );
- expectResult( '<strong>foo</strong>' );
- } );
- it( 'can be overwritten using priority', () => {
- const helperA = downcastAttributeToElement( { model: 'bold', view: 'strong' } );
- const helperB = downcastAttributeToElement( { model: 'bold', view: 'b', priority: 'high' } );
- conversion.for( 'downcast' ).add( helperA ).add( helperB );
- model.change( writer => {
- writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
- } );
- expectResult( '<b>foo</b>' );
- } );
- it( 'config.view is a view element definition', () => {
- const helper = downcastAttributeToElement( {
- model: 'invert',
- view: {
- name: 'span',
- class: [ 'font-light', 'bg-dark' ]
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
- } );
- expectResult( '<span class="bg-dark font-light">foo</span>' );
- } );
- it( 'model attribute value is enum', () => {
- const helper = downcastAttributeToElement( {
- model: {
- key: 'fontSize',
- values: [ 'big', 'small' ]
- },
- view: {
- big: {
- name: 'span',
- style: {
- 'font-size': '1.2em'
- }
- },
- small: {
- name: 'span',
- style: {
- 'font-size': '0.8em'
- }
- }
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
- } );
- expectResult( '<span style="font-size:1.2em">foo</span>' );
- model.change( writer => {
- writer.setAttribute( 'fontSize', 'small', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<span style="font-size:0.8em">foo</span>' );
- model.change( writer => {
- writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
- } );
- expectResult( 'foo' );
- } );
- it( 'config.view is a function', () => {
- const helper = downcastAttributeToElement( {
- model: 'bold',
- view: ( modelAttributeValue, viewWriter ) => {
- return viewWriter.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
- } );
- expectResult( '<span style="font-weight:500">foo</span>' );
- } );
- } );
- describe( 'downcastAttributeToAttribute', () => {
- beforeEach( () => {
- conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'image', view: 'img' } ) );
- } );
- it( 'config.view is a string', () => {
- const helper = downcastAttributeToAttribute( { model: 'source', view: 'src' } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
- } );
- expectResult( '<img src="foo.jpg"></img>' );
- model.change( writer => {
- writer.removeAttribute( 'source', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<img></img>' );
- } );
- it( 'can be overwritten using priority', () => {
- const helperA = downcastAttributeToAttribute( { model: 'source', view: 'href' } );
- const helperB = downcastAttributeToAttribute( { model: 'source', view: 'src', priority: 'high' } );
- conversion.for( 'downcast' ).add( helperA ).add( helperB );
- model.change( writer => {
- writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
- } );
- expectResult( '<img src="foo.jpg"></img>' );
- } );
- it( 'model element name specified', () => {
- conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
- const helper = downcastAttributeToAttribute( {
- model: {
- name: 'image',
- key: 'source'
- },
- view: 'src'
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
- } );
- expectResult( '<img src="foo.jpg"></img>' );
- model.change( writer => {
- writer.rename( modelRoot.getChild( 0 ), 'paragraph' );
- } );
- expectResult( '<p></p>' );
- } );
- it( 'config.view is an object, model attribute value is enum', () => {
- conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
- const helper = downcastAttributeToAttribute( {
- model: {
- key: 'styled',
- values: [ 'dark', 'light' ]
- },
- view: {
- dark: {
- key: 'class',
- value: [ 'styled', 'styled-dark' ]
- },
- light: {
- key: 'class',
- value: [ 'styled', 'styled-light' ]
- }
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 );
- } );
- expectResult( '<p class="styled styled-dark"></p>' );
- model.change( writer => {
- writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<p class="styled styled-light"></p>' );
- model.change( writer => {
- writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<p></p>' );
- } );
- it( 'config.view is an object, model attribute value is enum, view has style', () => {
- conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) );
- const helper = downcastAttributeToAttribute( {
- model: {
- key: 'align',
- values: [ 'right', 'center' ]
- },
- view: {
- right: {
- key: 'style',
- value: {
- 'text-align': 'right'
- }
- },
- center: {
- key: 'style',
- value: {
- 'text-align': 'center'
- }
- }
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 );
- } );
- expectResult( '<p style="text-align:right"></p>' );
- model.change( writer => {
- writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<p style="text-align:center"></p>' );
- model.change( writer => {
- writer.removeAttribute( 'align', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<p></p>' );
- } );
- it( 'config.view is a function', () => {
- const helper = downcastAttributeToAttribute( {
- model: 'styled',
- view: attributeValue => ( { key: 'class', value: 'styled-' + attributeValue } )
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
- } );
- expectResult( '<img class="styled-pull-out"></img>' );
- } );
- } );
- describe( 'downcastMarkerToElement', () => {
- it( 'config.view is a string', () => {
- const helper = downcastMarkerToElement( { model: 'search', view: 'marker-search' } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- writer.setMarker( 'search', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
- } );
- expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
- } );
- it( 'can be overwritten using priority', () => {
- const helperA = downcastMarkerToElement( { model: 'search', view: 'marker-search' } );
- const helperB = downcastMarkerToElement( { model: 'search', view: 'search', priority: 'high' } );
- conversion.for( 'downcast' ).add( helperA ).add( helperB );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- writer.setMarker( 'search', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
- } );
- expectResult( 'f<search></search>o<search></search>o' );
- } );
- it( 'config.view is a view element definition', () => {
- const helper = downcastMarkerToElement( {
- model: 'search',
- view: {
- name: 'span',
- attribute: {
- 'data-marker': 'search'
- }
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- writer.setMarker( 'search', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
- } );
- expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
- } );
- it( 'config.view is a function', () => {
- const helper = downcastMarkerToElement( {
- model: 'search',
- view: ( data, viewWriter ) => {
- return viewWriter.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- writer.setMarker( 'search', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
- } );
- expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
- } );
- } );
- describe( 'downcastMarkerToHighlight', () => {
- it( 'config.view is a highlight descriptor', () => {
- const helper = downcastMarkerToHighlight( { model: 'comment', view: { class: 'comment' } } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- writer.setMarker( 'comment', ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 ) );
- } );
- expectResult( '<span class="comment">foo</span>' );
- } );
- it( 'can be overwritten using priority', () => {
- const helperA = downcastMarkerToHighlight( { model: 'comment', view: { class: 'comment' } } );
- const helperB = downcastMarkerToHighlight( { model: 'comment', view: { class: 'new-comment' }, priority: 'high' } );
- conversion.for( 'downcast' ).add( helperA ).add( helperB );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- writer.setMarker( 'comment', ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 ) );
- } );
- expectResult( '<span class="new-comment">foo</span>' );
- } );
- it( 'config.view is a function', () => {
- const helper = downcastMarkerToHighlight( {
- model: 'comment',
- view: data => {
- const commentType = data.markerName.split( ':' )[ 1 ];
- return {
- class: [ 'comment', 'comment-' + commentType ]
- };
- }
- } );
- conversion.for( 'downcast' ).add( helper );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- writer.setMarker( 'comment:abc', ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 ) );
- } );
- expectResult( '<span class="comment comment-abc">foo</span>' );
- } );
- } );
- function expectResult( string ) {
- expect( stringify( viewRoot, null, { ignoreRoot: true } ) ).to.equal( string );
- }
- } );
- describe( 'downcast-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.document.getRoot();
- // Set name of view root the same as dom root.
- // This is a mock of attaching view root to dom root.
- controller.view.document.getRoot()._name = 'div';
- dispatcher = controller.downcastDispatcher;
- dispatcher.on(
- 'insert:paragraph',
- insertElement(
- ( modelItem, viewWriter ) => viewWriter.createContainerElement( '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 downcast 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, conversionApi ) => {
- conversionApi.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', () => {
- 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 not convert if creator returned null', () => {
- dispatcher.on( 'insert:div', insertElement( () => null ) );
- const modelElement = new ModelElement( 'div' );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div></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( ( modelElement, viewWriter ) => viewWriter.createContainerElement( '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, conversionApi ) => {
- conversionApi.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 creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' );
- dispatcher.on( 'attribute:bold', wrap( creator ) );
- 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 = ( modelAttributeValue, viewWriter ) => {
- if ( modelAttributeValue == 'bold' ) {
- return viewWriter.createAttributeElement( '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 = ( modelAttributeValue, viewWriter ) => {
- return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } );
- };
- 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 creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' );
- dispatcher.on( 'attribute:bold', wrap( creator ) );
- 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 } ) );
- dispatcher.on( 'attribute:bold', wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' ) ) );
- dispatcher.on(
- 'attribute:bold',
- wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' ) ),
- { priority: 'high' }
- );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p><strong>foobar</strong></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 ) );
- const spy = sinon.spy();
- dispatcher.on( 'attribute:italic', spy );
- 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;
- expect( spy.called ).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', () => {
- const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
- 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>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', () => {
- sinon.spy( dispatcher, 'fire' );
- dispatcher.on( 'addMarker:marker', insertUIElement(
- ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ) )
- );
- dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
- }, { priority: 'high' } );
- model.change( writer => {
- writer.setMarker( '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 creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
- 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"></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 creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': data.markerName } );
- 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"></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, viewWriter ) {
- if ( data.isOpening ) {
- return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
- }
- return viewWriter.createUIElement( '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 creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } );
- sinon.spy( dispatcher, 'fire' );
- dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
- dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.item, 'addMarker:marker' );
- }, { priority: 'high' } );
- model.change( writer => {
- writer.setMarker( '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(
- ( modelElement, viewWriter ) => viewWriter.createContainerElement( '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>' );
- } );
- it( 'should do nothing if collapsed marker is converted', () => {
- const descriptor = { class: 'foo' };
- dispatcher.on( 'addMarker:marker', highlightText( descriptor ), { priority: 'high' } );
- dispatcher.on( 'addMarker:marker', highlightElement( descriptor ), { priority: 'high' } );
- dispatcher.on( 'removeMarker:marker', removeHighlight( descriptor ), { priority: 'high' } );
- markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 0 );
- model.change( () => {
- model.markers._set( 'marker', markerRange );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
- model.change( () => {
- model.markers._remove( 'marker' );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
- } );
- it( 'should correctly wrap and unwrap multiple, intersecting markers', () => {
- const descriptorFoo = { class: 'foo' };
- const descriptorBar = { class: 'bar' };
- const descriptorXyz = { class: 'xyz' };
- dispatcher.on( 'addMarker:markerFoo', highlightText( descriptorFoo ) );
- dispatcher.on( 'addMarker:markerBar', highlightText( descriptorBar ) );
- dispatcher.on( 'addMarker:markerXyz', highlightText( descriptorXyz ) );
- dispatcher.on( 'removeMarker:markerFoo', removeHighlight( descriptorFoo ) );
- dispatcher.on( 'removeMarker:markerBar', removeHighlight( descriptorBar ) );
- dispatcher.on( 'removeMarker:markerXyz', removeHighlight( descriptorXyz ) );
- const p1 = modelRoot.getChild( 0 );
- const p2 = modelRoot.getChild( 1 );
- model.change( writer => {
- writer.setMarker( 'markerFoo', ModelRange.createFromParentsAndOffsets( p1, 0, p1, 3 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<p>' +
- '<span class="foo">foo</span>' +
- '</p>' +
- '<p>bar</p>' +
- '</div>'
- );
- model.change( writer => {
- writer.setMarker( 'markerBar', ModelRange.createFromParentsAndOffsets( p1, 1, p2, 2 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<p>' +
- '<span class="foo">f</span>' +
- '<span class="bar">' +
- '<span class="foo">oo</span>' +
- '</span>' +
- '</p>' +
- '<p>' +
- '<span class="bar">ba</span>' +
- 'r' +
- '</p>' +
- '</div>'
- );
- model.change( writer => {
- writer.setMarker( 'markerXyz', ModelRange.createFromParentsAndOffsets( p1, 2, p2, 3 ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<p>' +
- '<span class="foo">f</span>' +
- '<span class="bar">' +
- '<span class="foo">' +
- 'o' +
- '<span class="xyz">o</span>' +
- '</span>' +
- '</span>' +
- '</p>' +
- '<p>' +
- '<span class="bar">' +
- '<span class="xyz">ba</span>' +
- '</span>' +
- '<span class="xyz">r</span>' +
- '</p>' +
- '</div>'
- );
- model.change( writer => {
- writer.removeMarker( 'markerBar' );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<p>' +
- '<span class="foo">' +
- 'fo' +
- '<span class="xyz">o</span>' +
- '</span>' +
- '</p>' +
- '<p>' +
- '<span class="xyz">bar</span>' +
- '</p>' +
- '</div>'
- );
- model.change( writer => {
- writer.removeMarker( 'markerFoo' );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<p>' +
- 'fo' +
- '<span class="xyz">o</span>' +
- '</p>' +
- '<p>' +
- '<span class="xyz">bar</span>' +
- '</p>' +
- '</div>'
- );
- model.change( writer => {
- writer.removeMarker( 'markerXyz' );
- } );
- 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, writer ) => {
- writer.addClass( descriptor.class, element );
- } );
- viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => {
- writer.setAttribute( 'class', '', element );
- } );
- 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;
- } );
- } );
- } );
|