| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals console */
- import EditingController from '../../src/controller/editingcontroller';
- import Model from '../../src/model/model';
- import ModelElement from '../../src/model/element';
- import ModelText from '../../src/model/text';
- import ViewElement from '../../src/view/element';
- import ViewAttributeElement from '../../src/view/attributeelement';
- import ViewContainerElement from '../../src/view/containerelement';
- import ViewUIElement from '../../src/view/uielement';
- import ViewText from '../../src/view/text';
- import ViewDocument from '../../src/view/document';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import DowncastHelpers, {
- clearAttributes,
- convertCollapsedSelection,
- convertRangeSelection,
- createViewElementFromHighlightDescriptor,
- insertText
- } from '../../src/conversion/downcasthelpers';
- import Mapper from '../../src/conversion/mapper';
- import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
- import { stringify as stringifyView } from '../../src/dev-utils/view';
- import View from '../../src/view/view';
- import createViewRoot from '../view/_utils/createroot';
- import { setData as setModelData } from '../../src/dev-utils/model';
- import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
- import { StylesProcessor } from '../../src/view/stylesmap';
- import DowncastWriter from '../../src/view/downcastwriter';
- describe( 'DowncastHelpers', () => {
- let model, modelRoot, viewRoot, downcastHelpers, controller, modelRootStart;
- beforeEach( () => {
- model = new Model();
- const modelDoc = model.document;
- modelRoot = modelDoc.createRoot();
- controller = new EditingController( model, new StylesProcessor() );
- // 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();
- downcastHelpers = new DowncastHelpers( [ controller.downcastDispatcher ] );
- modelRootStart = model.createPositionAt( modelRoot, 0 );
- } );
- describe( 'elementToElement()', () => {
- it( 'should be chainable', () => {
- expect( downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } ) ).to.equal( downcastHelpers );
- } );
- it( 'config.view is a string', () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- model.change( writer => {
- writer.insertElement( 'paragraph', modelRoot, 0 );
- } );
- expectResult( '<p></p>' );
- } );
- it( 'can be overwritten using converterPriority', () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'foo', converterPriority: 'high' } );
- model.change( writer => {
- writer.insertElement( 'paragraph', modelRoot, 0 );
- } );
- expectResult( '<foo></foo>' );
- } );
- it( 'config.view is a view element definition', () => {
- downcastHelpers.elementToElement( {
- model: 'fancyParagraph',
- view: {
- name: 'p',
- classes: 'fancy'
- }
- } );
- model.change( writer => {
- writer.insertElement( 'fancyParagraph', modelRoot, 0 );
- } );
- expectResult( '<p class="fancy"></p>' );
- } );
- it( 'config.view is a function', () => {
- downcastHelpers.elementToElement( {
- model: 'heading',
- view: ( modelElement, { writer } ) => writer.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) )
- } );
- model.change( writer => {
- writer.insertElement( 'heading', { level: 2 }, modelRoot, 0 );
- } );
- expectResult( '<h2></h2>' );
- } );
- describe( 'config.triggerBy', () => {
- describe( 'with simple block view structure', () => {
- beforeEach( () => {
- model.schema.register( 'simpleBlock', {
- allowIn: '$root',
- allowAttributes: [ 'toStyle', 'toClass' ]
- } );
- downcastHelpers.elementToElement( {
- model: 'simpleBlock',
- view: ( modelElement, { writer } ) => {
- return writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
- },
- triggerBy: [
- 'attribute:toStyle:simpleBlock',
- 'attribute:toClass:simpleBlock'
- ]
- } );
- } );
- it( 'should convert on insert', () => {
- model.change( writer => {
- writer.insertElement( 'simpleBlock', modelRoot, 0 );
- } );
- expectResult( '<div></div>' );
- } );
- it( 'should converter on attribute set', () => {
- setModelData( model, '<simpleBlock></simpleBlock>' );
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div style="display:block"></div>' );
- } );
- it( 'should converter on attribute change', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div style="display:inline"></div>' );
- } );
- it( 'should convert on attribute remove', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
- model.change( writer => {
- writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div></div>' );
- } );
- it( 'should convert on one attribute add and other remove', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
- model.change( writer => {
- writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
- writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="is-classy"></div>' );
- } );
- it( 'should do nothing if other attribute changed', () => {
- setModelData( model, '<simpleBlock></simpleBlock>' );
- model.change( writer => {
- writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div></div>' );
- } );
- } );
- describe.skip( 'with complex view structure', () => {
- beforeEach( () => {
- model.schema.register( 'complex', {
- allowIn: '$root',
- allowAttributes: [ 'toStyle', 'toClass' ]
- } );
- downcastHelpers.elementToElement( {
- model: 'complex',
- view: ( modelElement, conversionApi ) => {
- const { writer, mapper } = conversionApi;
- const outter = writer.createContainerElement( 'c-outter' );
- mapper.bindElements( modelElement, outter );
- const inner = writer.createContainerElement( 'c-inner', getViewAttributes( modelElement ) );
- writer.insert( writer.createPositionAt( outter, 0 ), inner );
- mapper.bindSlotElements( modelElement, inner );
- return outter;
- },
- triggerBy: [
- 'attribute:toStyle:complex',
- 'attribute:toClass:complex'
- ]
- } );
- model.schema.register( 'paragraph', {
- inheritAllFrom: '$block',
- allowIn: 'complex'
- } );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- } );
- it( 'should convert to view on insert', () => {
- model.change( writer => {
- writer.insertElement( 'complex', modelRoot, 0 );
- } );
- expectResult( '<c-outter><c-inner></c-inner></c-outter>' );
- } );
- it( 'should use main converter for attribute set', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<c-outter><c-inner style="display:block"></c-inner></c-outter>' );
- } );
- it( 'should use main converter for attribute remove', () => {
- setModelData( model, '<complex toStyle="display:block"></complex>' );
- model.change( writer => {
- writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<c-outter><c-inner></c-inner></c-outter>' );
- } );
- it( 'should use main converter for attribute add & remove', () => {
- setModelData( model, '<complex toStyle="display:block"></complex>' );
- model.change( writer => {
- writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
- writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<c-outter><c-inner class="is-classy"></c-inner></c-outter>' );
- } );
- it( 'should do nothing if other attribute changed', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<c-outter><c-inner></c-inner></c-outter>' );
- } );
- describe( 'memoization', () => {
- it( 'should create new element on re-converting element', () => {
- setModelData( model, '<complex></complex>' );
- const renderedView = viewRoot.getChild( 0 );
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- const viewAfterReRender = viewRoot.getChild( 0 );
- expect( viewAfterReRender ).to.not.equal( renderedView );
- } );
- it( 'should not re-create child elements on re-converting element', () => {
- setModelData( model, '<complex><paragraph>Foo bar baz</paragraph></complex>' );
- expectResult( '<c-outter><c-inner><p>Foo bar baz</p></c-inner></c-outter>' );
- const renderedViewView = viewRoot.getChild( 0 ).getChild( 0 );
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- const viewAfterReRender = viewRoot.getChild( 0 ).getChild( 0 );
- expect( viewAfterReRender ).to.equal( renderedViewView );
- } );
- } );
- } );
- function getViewAttributes( modelElement ) {
- // TODO decide whether below is readable:
- const toStyle = modelElement.hasAttribute( 'toStyle' ) && { style: modelElement.getAttribute( 'toStyle' ) };
- const toClass = modelElement.hasAttribute( 'toClass' ) && { class: 'is-classy' };
- const attributes = {
- ...toStyle,
- ...toClass
- };
- return attributes;
- }
- } );
- } );
- describe( 'attributeToElement()', () => {
- beforeEach( () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- } );
- it( 'should be chainable', () => {
- expect( downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } ) ).to.equal( downcastHelpers );
- } );
- it( 'config.view is a string', () => {
- downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
- model.change( writer => {
- writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
- } );
- expectResult( '<strong>foo</strong>' );
- } );
- it( 'can be overwritten using converterPriority', () => {
- downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
- downcastHelpers.attributeToElement( { model: 'bold', view: 'b', converterPriority: 'high' } );
- model.change( writer => {
- writer.insertText( 'foo', { bold: true }, modelRoot, 0 );
- } );
- expectResult( '<b>foo</b>' );
- } );
- it( 'config.view is a view element definition', () => {
- downcastHelpers.attributeToElement( {
- model: 'invert',
- view: {
- name: 'span',
- classes: [ 'font-light', 'bg-dark' ]
- }
- } );
- model.change( writer => {
- writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
- } );
- expectResult( '<span class="bg-dark font-light">foo</span>' );
- expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
- } );
- it( 'config.view allows specifying the element\'s priority', () => {
- downcastHelpers.attributeToElement( {
- model: 'invert',
- view: {
- name: 'span',
- priority: 5
- }
- } );
- model.change( writer => {
- writer.insertText( 'foo', { invert: true }, modelRoot, 0 );
- } );
- expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
- } );
- it( 'model attribute value is enum', () => {
- downcastHelpers.attributeToElement( {
- model: {
- key: 'fontSize',
- values: [ 'big', 'small' ]
- },
- view: {
- big: {
- name: 'span',
- styles: {
- 'font-size': '1.2em'
- }
- },
- small: {
- name: 'span',
- styles: {
- 'font-size': '0.8em'
- },
- priority: 5
- }
- }
- } );
- model.change( writer => {
- writer.insertText( 'foo', { fontSize: 'big' }, modelRoot, 0 );
- } );
- expect( viewRoot.getChild( 0 ).priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
- 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>' );
- expect( viewRoot.getChild( 0 ).priority ).to.equal( 5 );
- model.change( writer => {
- writer.removeAttribute( 'fontSize', modelRoot.getChild( 0 ) );
- } );
- expectResult( 'foo' );
- } );
- it( 'config.view is a function', () => {
- downcastHelpers.attributeToElement( {
- model: 'bold',
- view: ( modelAttributeValue, { writer } ) => {
- return writer.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } );
- }
- } );
- model.change( writer => {
- writer.insertText( 'foo', { bold: '500' }, modelRoot, 0 );
- } );
- expectResult( '<span style="font-weight:500">foo</span>' );
- } );
- it( 'config.model.name is given', () => {
- downcastHelpers.attributeToElement( {
- model: {
- key: 'color',
- name: '$text'
- },
- view: ( modelAttributeValue, { writer } ) => {
- return writer.createAttributeElement( 'span', { style: 'color:' + modelAttributeValue } );
- }
- } );
- downcastHelpers.elementToElement( {
- model: 'smiley',
- view: ( modelElement, { writer } ) => {
- return writer.createEmptyElement( 'img', {
- src: 'smile.jpg',
- class: 'smiley'
- } );
- }
- } );
- model.change( writer => {
- writer.insertText( 'foo', { color: '#FF0000' }, modelRoot, 0 );
- writer.insertElement( 'smiley', { color: '#FF0000' }, modelRoot, 3 );
- } );
- expectResult( '<span style="color:#FF0000">foo</span><img class="smiley" src="smile.jpg"></img>' );
- } );
- it( 'should not convert if creator returned null', () => {
- downcastHelpers.elementToElement( { model: 'div', view: () => null } );
- const modelElement = new ModelElement( 'div' );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
- } );
- 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 } ) );
- downcastHelpers.attributeToElement( {
- model: 'bold',
- view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
- } );
- 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', writer.createRangeIn( 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' } ) );
- downcastHelpers.attributeToElement( {
- model: 'style',
- view: ( modelAttributeValue, { writer } ) => {
- if ( modelAttributeValue == 'bold' ) {
- return writer.createAttributeElement( 'b' );
- }
- }
- } );
- 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', writer.createRangeIn( 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' )
- ] );
- downcastHelpers.attributeToElement( {
- model: 'link',
- view: ( modelAttributeValue, { writer } ) => {
- return writer.createAttributeElement( 'a', { href: modelAttributeValue } );
- }
- } );
- 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', writer.createRangeIn( 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 } ), 'கு' ] );
- downcastHelpers.attributeToElement( {
- model: 'bold',
- view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
- } );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
- model.change( writer => {
- writer.removeAttribute( 'bold', writer.createRangeIn( modelElement ) );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
- } );
- it( 'should be possible to override ', () => {
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
- downcastHelpers.attributeToElement( {
- model: 'bold',
- view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'b' )
- } );
- downcastHelpers.attributeToElement( {
- model: 'bold',
- view: ( modelAttributeValue, { writer } ) => writer.createAttributeElement( 'strong' ),
- converterPriority: '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', () => {
- sinon.spy( controller.downcastDispatcher, 'fire' );
- const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
- downcastHelpers.attributeToElement( {
- model: 'italic',
- view: () => null
- } );
- const spy = sinon.spy();
- controller.downcastDispatcher.on( 'attribute:italic', spy );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- expect( controller.downcastDispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
- expect( spy.called ).to.be.true;
- } );
- } );
- describe( 'attributeToAttribute()', () => {
- testUtils.createSinonSandbox();
- beforeEach( () => {
- downcastHelpers.elementToElement( { model: 'image', view: 'img' } );
- downcastHelpers.elementToElement( {
- model: 'paragraph',
- view: ( modelItem, { writer } ) => writer.createContainerElement( 'p' )
- } );
- downcastHelpers.attributeToAttribute( {
- model: 'class',
- view: 'class'
- } );
- } );
- it( 'should be chainable', () => {
- expect( downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } ) ).to.equal( downcastHelpers );
- } );
- it( 'config.view is a string', () => {
- downcastHelpers.attributeToAttribute( { model: 'source', view: 'src' } );
- 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 converterPriority', () => {
- downcastHelpers.attributeToAttribute( { model: 'source', view: 'href' } );
- downcastHelpers.attributeToAttribute( { model: 'source', view: 'src', converterPriority: 'high' } );
- model.change( writer => {
- writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 );
- } );
- expectResult( '<img src="foo.jpg"></img>' );
- } );
- it( 'model element name specified', () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- downcastHelpers.attributeToAttribute( {
- model: {
- name: 'image',
- key: 'source'
- },
- view: 'src'
- } );
- 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', () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- downcastHelpers.attributeToAttribute( {
- model: {
- key: 'styled',
- values: [ 'dark', 'light' ]
- },
- view: {
- dark: {
- key: 'class',
- value: [ 'styled', 'styled-dark' ]
- },
- light: {
- key: 'class',
- value: [ 'styled', 'styled-light' ]
- }
- }
- } );
- 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', () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- downcastHelpers.attributeToAttribute( {
- model: {
- key: 'align',
- values: [ 'right', 'center' ]
- },
- view: {
- right: {
- key: 'style',
- value: {
- 'text-align': 'right'
- }
- },
- center: {
- key: 'style',
- value: {
- 'text-align': 'center'
- }
- }
- }
- } );
- 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 an object, only name and key are provided', () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- downcastHelpers.attributeToAttribute( {
- model: {
- name: 'paragraph',
- key: 'class'
- },
- view: {
- name: 'paragraph',
- key: 'class'
- }
- } );
- model.change( writer => {
- writer.insertElement( 'paragraph', { class: 'dark' }, modelRoot, 0 );
- } );
- expectResult( '<p class="dark"></p>' );
- model.change( writer => {
- writer.setAttribute( 'class', 'light', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<p class="light"></p>' );
- model.change( writer => {
- writer.removeAttribute( 'class', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<p></p>' );
- } );
- it( 'config.view is a function', () => {
- downcastHelpers.attributeToAttribute( {
- model: 'styled',
- view: ( attributeValue, conversionApi ) => {
- // To ensure conversion API is provided.
- expect( conversionApi.writer ).to.instanceof( DowncastWriter );
- return { key: 'class', value: 'styled-' + attributeValue };
- }
- } );
- model.change( writer => {
- writer.insertElement( 'image', { styled: 'pull-out' }, modelRoot, 0 );
- } );
- expectResult( '<img class="styled-pull-out"></img>' );
- } );
- // #1587
- it( 'config.view and config.model as strings in generic conversion (elements only)', () => {
- const consoleWarnStub = testUtils.sinon.stub( console, 'warn' );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
- model.change( writer => {
- writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 0 );
- writer.insertElement( 'paragraph', { test: '2' }, modelRoot, 1 );
- } );
- expectResult( '<p test="1"></p><p test="2"></p>' );
- expect( consoleWarnStub.callCount ).to.equal( 0 );
- model.change( writer => {
- writer.removeAttribute( 'test', modelRoot.getChild( 1 ) );
- } );
- expectResult( '<p test="1"></p><p></p>' );
- } );
- // #1587
- it( 'config.view and config.model as strings in generic conversion (elements + text)', () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- downcastHelpers.attributeToAttribute( { model: 'test', view: 'test' } );
- expectToThrowCKEditorError( () => {
- model.change( writer => {
- writer.insertElement( 'paragraph', modelRoot, 0 );
- writer.insertElement( 'paragraph', { test: '1' }, modelRoot, 1 );
- writer.insertText( 'Foo', { test: '2' }, modelRoot.getChild( 0 ), 0 );
- writer.insertText( 'Bar', { test: '3' }, modelRoot.getChild( 1 ), 0 );
- } );
- }, /^conversion-attribute-to-attribute-on-text/ );
- } );
- 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 be possible to override setAttribute', () => {
- downcastHelpers.attributeToAttribute( {
- model: 'class',
- view: ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.item, 'attribute:class' );
- },
- converterPriority: 'high'
- } );
- model.change( writer => {
- const modelElement = new ModelElement( 'paragraph', { classes: 'foo' }, new ModelText( 'foobar' ) );
- writer.insert( modelElement, modelRootStart );
- } );
- // No attribute set.
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- } );
- it( 'should not convert or consume if element creator returned null', () => {
- const callback = sinon.stub().returns( null );
- downcastHelpers.attributeToAttribute( {
- model: 'class',
- view: callback,
- converterPriority: 'high'
- } );
- 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>' );
- sinon.assert.called( callback );
- } );
- } );
- describe( 'markerToElement()', () => {
- let modelText, modelElement, range;
- it( 'should be chainable', () => {
- expect( downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } ) ).to.equal( downcastHelpers );
- } );
- it( 'config.view is a string', () => {
- downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
- writer.addMarker( 'search', { range, usingOperation: false } );
- } );
- expectResult( 'f<marker-search></marker-search>o<marker-search></marker-search>o' );
- } );
- it( 'can be overwritten using converterPriority', () => {
- downcastHelpers.markerToElement( { model: 'search', view: 'marker-search' } );
- downcastHelpers.markerToElement( { model: 'search', view: 'search', converterPriority: 'high' } );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
- writer.addMarker( 'search', { range, usingOperation: false } );
- } );
- expectResult( 'f<search></search>o<search></search>o' );
- } );
- it( 'config.view is a view element definition', () => {
- downcastHelpers.markerToElement( {
- model: 'search',
- view: {
- name: 'span',
- attributes: {
- 'data-marker': 'search'
- }
- }
- } );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
- writer.addMarker( 'search', { range, usingOperation: false } );
- } );
- expectResult( 'f<span data-marker="search"></span>o<span data-marker="search"></span>o' );
- } );
- it( 'config.view is a function', () => {
- downcastHelpers.markerToElement( {
- model: 'search',
- view: ( data, { writer } ) => {
- return writer.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } );
- }
- } );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 2 ) );
- writer.addMarker( 'search', { range, usingOperation: false } );
- } );
- expectResult( 'f<span data-marker="search" data-start="true"></span>o<span data-marker="search" data-start="false"></span>o' );
- } );
- describe( 'collapsed range', () => {
- beforeEach( () => {
- modelText = new ModelText( 'foobar' );
- modelElement = new ModelElement( 'paragraph', null, modelText );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- range = model.createRange( model.createPositionAt( modelElement, 3 ), model.createPositionAt( modelElement, 3 ) );
- } );
- it( 'should insert and remove ui element', () => {
- downcastHelpers.markerToElement( {
- model: 'marker',
- view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
- } );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- 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( controller.downcastDispatcher, 'fire' );
- downcastHelpers.markerToElement( {
- model: 'marker',
- view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
- } );
- controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' );
- }, { priority: 'high' } );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
- } );
- it( 'should not convert if creator returned null', () => {
- downcastHelpers.markerToElement( {
- model: 'marker',
- view: () => null
- } );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- 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( () => {
- modelText = new ModelText( 'foobar' );
- modelElement = new ModelElement( 'paragraph', null, modelText );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- model.change( writer => {
- writer.insert( modelElement, modelRootStart );
- } );
- range = model.createRange( model.createPositionAt( modelElement, 2 ), model.createPositionAt( modelElement, 5 ) );
- } );
- it( 'should insert and remove ui element - element as a creator', () => {
- downcastHelpers.markerToElement( {
- model: 'marker',
- view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
- } );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- 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', () => {
- downcastHelpers.markerToElement( {
- model: 'marker',
- view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': data.markerName } )
- } );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- 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', () => {
- downcastHelpers.markerToElement( {
- model: 'marker',
- view: ( data, { writer } ) => {
- if ( data.isOpening ) {
- return writer.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
- }
- return writer.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
- }
- } );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- 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', () => {
- sinon.spy( controller.downcastDispatcher, 'fire' );
- downcastHelpers.markerToElement( {
- model: 'marker',
- view: ( data, { writer } ) => writer.createUIElement( 'span', { 'class': 'marker' } )
- } );
- controller.downcastDispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.item, 'addMarker:marker' );
- }, { priority: 'high' } );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
- expect( controller.downcastDispatcher.fire.calledWith( 'addMarker:marker' ) );
- } );
- } );
- } );
- describe( 'markerToData()', () => {
- let root;
- beforeEach( () => {
- root = model.document.getRoot();
- model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- } );
- it( 'should be chainable', () => {
- expect( downcastHelpers.markerToData( { model: 'search' } ) ).to.equal( downcastHelpers );
- } );
- it( 'default conversion, inside text, non-collapsed, no name', () => {
- downcastHelpers.markerToData( { model: 'search' } );
- setModelData( model, '<paragraph>Fo[ob]ar</paragraph>' );
- model.change( writer => {
- writer.addMarker( 'search', { range: model.document.selection.getFirstRange(), usingOperation: false } );
- } );
- expectResult( '<p>Fo<search-start></search-start>ob<search-end></search-end>ar</p>' );
- model.change( writer => {
- writer.removeMarker( 'search' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'default conversion, inside text, non-collapsed, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Fo[ob]ar</paragraph>' );
- model.change( writer => {
- writer.addMarker( 'group:foo:bar:baz', { range: model.document.selection.getFirstRange(), usingOperation: false } );
- } );
- expectResult( '<p>Fo<group-start name="foo:bar:baz"></group-start>ob<group-end name="foo:bar:baz"></group-end>ar</p>' );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar:baz' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'default conversion, inside text, collapsed, no name', () => {
- downcastHelpers.markerToData( { model: 'search' } );
- setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
- model.change( writer => {
- writer.addMarker( 'search', { range: model.document.selection.getFirstRange(), usingOperation: false } );
- } );
- expectResult( '<p>Foo<search-start></search-start><search-end></search-end>bar</p>' );
- model.change( writer => {
- writer.removeMarker( 'search' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'default conversion, inside text, collapsed, multiple markers, no name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
- model.change( writer => {
- writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
- writer.addMarker( 'group:abc', { range: model.document.selection.getFirstRange(), usingOperation: false } );
- } );
- expectResult(
- '<p>' +
- 'Foo' +
- '<group-start name="abc"></group-start><group-end name="abc"></group-end>' +
- '<group-start name="foo"></group-start><group-end name="foo"></group-end>' +
- 'bar' +
- '</p>'
- );
- model.change( writer => {
- writer.removeMarker( 'group:foo' );
- writer.removeMarker( 'group:abc' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'default conversion, on two elements, no name', () => {
- downcastHelpers.markerToData( { model: 'search' } );
- setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
- model.change( writer => {
- const range = writer.createRangeIn( root );
- writer.addMarker( 'search', { range, usingOperation: false } );
- } );
- expectResult( '<p data-search-start-before="">Foo</p><p data-search-end-after="">Bar</p>' );
- model.change( writer => {
- writer.removeMarker( 'search' );
- } );
- expectResult( '<p>Foo</p><p>Bar</p>' );
- } );
- it( 'default conversion, on two elements, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
- model.change( writer => {
- const range = writer.createRangeIn( root );
- writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
- } );
- expectResult( '<p data-group-start-before="foo:bar:baz">Foo</p><p data-group-end-after="foo:bar:baz">Bar</p>' );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar:baz' );
- } );
- expectResult( '<p>Foo</p><p>Bar</p>' );
- } );
- it( 'default conversion, on one element, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foobar</paragraph>' );
- model.change( writer => {
- const range = writer.createRangeIn( root );
- writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
- } );
- expectResult( '<p data-group-end-after="foo:bar:baz" data-group-start-before="foo:bar:baz">Foobar</p>' );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar:baz' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'default conversion, collapsed before element, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foobar</paragraph>' );
- model.change( writer => {
- // Collapsed before <paragraph>.
- const range = writer.createRange(
- writer.createPositionFromPath( root, [ 0 ] )
- );
- writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
- } );
- expectResult( '<p data-group-end-before="foo:bar:baz" data-group-start-before="foo:bar:baz">Foobar</p>' );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar:baz' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'default conversion, collapsed after element, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foobar</paragraph>' );
- model.change( writer => {
- // Collapsed before <paragraph>.
- const range = writer.createRange(
- writer.createPositionFromPath( root, [ 1 ] )
- );
- writer.addMarker( 'group:foo:bar:baz', { range, usingOperation: false } );
- } );
- expectResult( '<p data-group-end-after="foo:bar:baz" data-group-start-after="foo:bar:baz">Foobar</p>' );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar:baz' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'default conversion, mixed, multiple markers, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionFromPath( root, [ 0 ] ),
- writer.createPositionFromPath( root, [ 1, 2 ] )
- );
- writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
- writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
- } );
- expectResult(
- '<p data-group-start-before="abc:xyz,foo:bar">Foo</p>' +
- '<p>Ba<group-end name="abc:xyz"></group-end><group-end name="foo:bar"></group-end>r</p>'
- );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar' );
- writer.removeMarker( 'group:abc:xyz' );
- } );
- expectResult( '<p>Foo</p><p>Bar</p>' );
- } );
- it( 'default conversion, mixed #2, multiple markers, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionFromPath( root, [ 0, 1 ] ),
- writer.createPositionFromPath( root, [ 2 ] )
- );
- writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
- writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
- } );
- expectResult(
- '<p>F<group-start name="abc:xyz"></group-start><group-start name="foo:bar"></group-start>oo</p>' +
- '<p data-group-end-after="abc:xyz,foo:bar">Bar</p>'
- );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar' );
- writer.removeMarker( 'group:abc:xyz' );
- } );
- expectResult( '<p>Foo</p><p>Bar</p>' );
- } );
- it( 'default conversion, mixed #3, multiple markers, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foo</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionFromPath( root, [ 0 ] ),
- writer.createPositionFromPath( root, [ 0, 2 ] )
- );
- writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
- writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
- } );
- expectResult(
- '<p data-group-start-before="abc:xyz,foo:bar">' +
- 'Fo<group-end name="abc:xyz"></group-end><group-end name="foo:bar"></group-end>o' +
- '</p>'
- );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar' );
- writer.removeMarker( 'group:abc:xyz' );
- } );
- expectResult( '<p>Foo</p>' );
- } );
- it( 'default conversion, mixed #4, multiple markers, name', () => {
- downcastHelpers.markerToData( { model: 'group' } );
- setModelData( model, '<paragraph>Foo</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionFromPath( root, [ 0, 2 ] ),
- writer.createPositionFromPath( root, [ 1 ] )
- );
- writer.addMarker( 'group:foo:bar', { range, usingOperation: false } );
- writer.addMarker( 'group:abc:xyz', { range, usingOperation: false } );
- } );
- expectResult(
- '<p data-group-end-after="abc:xyz,foo:bar">' +
- 'Fo<group-start name="abc:xyz"></group-start><group-start name="foo:bar"></group-start>o' +
- '</p>'
- );
- model.change( writer => {
- writer.removeMarker( 'group:foo:bar' );
- writer.removeMarker( 'group:abc:xyz' );
- } );
- expectResult( '<p>Foo</p>' );
- } );
- it( 'conversion callback, mixed, multiple markers, name', () => {
- const customData = {
- foo: 'bar',
- abc: 'xyz'
- };
- downcastHelpers.markerToData( {
- model: 'group',
- view: ( markerName, conversionApi ) => {
- const namePart = markerName.split( ':' )[ 1 ];
- // To ensure conversion API is provided.
- expect( conversionApi.writer ).to.instanceof( DowncastWriter );
- return {
- group: 'g',
- name: namePart + '_' + customData[ namePart ]
- };
- }
- } );
- setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionFromPath( root, [ 0 ] ),
- writer.createPositionFromPath( root, [ 1, 2 ] )
- );
- writer.addMarker( 'group:foo', { range, usingOperation: false } );
- writer.addMarker( 'group:abc', { range, usingOperation: false } );
- } );
- expectResult(
- '<p data-g-start-before="abc_xyz,foo_bar">Foo</p>' +
- '<p>Ba<g-end name="abc_xyz"></g-end><g-end name="foo_bar"></g-end>r</p>'
- );
- model.change( writer => {
- writer.removeMarker( 'group:foo' );
- writer.removeMarker( 'group:abc' );
- } );
- expectResult( '<p>Foo</p><p>Bar</p>' );
- } );
- it( 'conversion callback, mixed #2, multiple markers, name', () => {
- const customData = {
- foo: 'bar',
- abc: 'xyz'
- };
- downcastHelpers.markerToData( {
- model: 'group',
- view: markerName => {
- const namePart = markerName.split( ':' )[ 1 ];
- return {
- group: 'g',
- name: namePart + '_' + customData[ namePart ]
- };
- }
- } );
- setModelData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionFromPath( root, [ 0, 1 ] ),
- writer.createPositionFromPath( root, [ 2 ] )
- );
- writer.addMarker( 'group:foo', { range, usingOperation: false } );
- writer.addMarker( 'group:abc', { range, usingOperation: false } );
- } );
- expectResult(
- '<p>F<g-start name="abc_xyz"></g-start><g-start name="foo_bar"></g-start>oo</p>' +
- '<p data-g-end-after="abc_xyz,foo_bar">Bar</p>'
- );
- model.change( writer => {
- writer.removeMarker( 'group:foo' );
- writer.removeMarker( 'group:abc' );
- } );
- expectResult( '<p>Foo</p><p>Bar</p>' );
- } );
- it( 'can be overwritten using converterPriority', () => {
- downcastHelpers.markerToData( {
- model: 'group'
- } );
- downcastHelpers.markerToData( {
- model: 'group',
- view: markerName => {
- const name = markerName.split( ':' )[ 1 ];
- return {
- group: 'g',
- name
- };
- },
- converterPriority: 'high'
- } );
- setModelData( model, '<paragraph>F[ooba]r</paragraph>' );
- model.change( writer => {
- writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
- } );
- expectResult(
- '<p>F<g-start name="foo"></g-start>ooba<g-end name="foo"></g-end>r</p>'
- );
- model.change( writer => {
- writer.removeMarker( 'group:foo' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'can be overwritten by custom callback', () => {
- downcastHelpers.markerToData( {
- model: 'group'
- } );
- downcastHelpers.add( dispatcher => {
- dispatcher.on( 'addMarker:group', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.markerRange, evt.name );
- }, { priority: 'high' } );
- } );
- setModelData( model, '<paragraph>Foo[]bar</paragraph>' );
- model.change( writer => {
- writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
- } );
- expectResult( '<p>Foobar</p>' );
- model.change( writer => {
- writer.removeMarker( 'group:foo' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- it( 'should not perform conversion if the callback returned falsy value', () => {
- downcastHelpers.markerToData( {
- model: 'group',
- view: () => false
- } );
- setModelData( model, '<paragraph>F[ooba]r</paragraph>' );
- model.change( writer => {
- writer.addMarker( 'group:foo', { range: model.document.selection.getFirstRange(), usingOperation: false } );
- } );
- expectResult( '<p>Foobar</p>' );
- model.change( writer => {
- writer.removeMarker( 'group:foo' );
- } );
- expectResult( '<p>Foobar</p>' );
- } );
- } );
- describe( 'markerToHighlight()', () => {
- it( 'should be chainable', () => {
- expect( downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } ) ).to.equal( downcastHelpers );
- } );
- it( 'config.view is a highlight descriptor', () => {
- downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
- writer.addMarker( 'comment', { range, usingOperation: false } );
- } );
- expectResult( '<span class="comment">foo</span>' );
- } );
- it( 'can be overwritten using converterPriority', () => {
- downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'comment' } } );
- downcastHelpers.markerToHighlight( { model: 'comment', view: { classes: 'new-comment' }, converterPriority: 'high' } );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
- writer.addMarker( 'comment', { range, usingOperation: false } );
- } );
- expectResult( '<span class="new-comment">foo</span>' );
- } );
- it( 'config.view is a function', () => {
- downcastHelpers.markerToHighlight( {
- model: 'comment',
- view: ( data, conversionApi ) => {
- const commentType = data.markerName.split( ':' )[ 1 ];
- // To ensure conversion API is provided.
- expect( conversionApi.writer ).to.instanceof( DowncastWriter );
- return {
- classes: [ 'comment', 'comment-' + commentType ]
- };
- }
- } );
- model.change( writer => {
- writer.insertText( 'foo', modelRoot, 0 );
- const range = writer.createRange( writer.createPositionAt( modelRoot, 0 ), writer.createPositionAt( modelRoot, 3 ) );
- writer.addMarker( 'comment:abc', { range, usingOperation: false } );
- } );
- expectResult( '<span class="comment comment-abc">foo</span>' );
- } );
- describe( 'highlight', () => {
- const highlightConfig = {
- model: 'marker',
- view: {
- classes: 'highlight-class',
- attributes: { title: 'title' }
- },
- converterPriority: 7
- };
- describe( 'on text', () => {
- let markerRange;
- beforeEach( () => {
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- 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 = model.createRangeIn( modelRoot );
- } );
- it( 'should wrap and unwrap text nodes', () => {
- downcastHelpers.markerToHighlight( highlightConfig );
- model.change( writer => {
- writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
- } );
- 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', () => {
- downcastHelpers.markerToHighlight( highlightConfig );
- downcastHelpers.markerToHighlight( {
- model: 'marker',
- view: { classes: 'override-class' },
- converterPriority: 'high'
- } );
- model.change( writer => {
- writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
- } );
- 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', () => {
- downcastHelpers.markerToHighlight( {
- model: 'marker',
- view: () => null,
- converterPriority: 'high'
- } );
- model.change( writer => {
- writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
- } );
- 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', () => {
- downcastHelpers.markerToHighlight( {
- model: 'marker',
- view: { classes: 'foo' },
- converterPriority: 'high'
- } );
- markerRange = model.createRange( model.createPositionAt( modelRoot, 0 ), model.createPositionAt( modelRoot, 0 ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
- } );
- 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', () => {
- downcastHelpers.markerToHighlight( {
- model: 'markerFoo',
- view: { classes: 'foo' }
- } );
- downcastHelpers.markerToHighlight( {
- model: 'markerBar',
- view: { classes: 'bar' }
- } );
- downcastHelpers.markerToHighlight( {
- model: 'markerXyz',
- view: { classes: 'xyz' }
- } );
- const p1 = modelRoot.getChild( 0 );
- const p2 = modelRoot.getChild( 1 );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( p1, 0 ), writer.createPositionAt( p1, 3 ) );
- writer.addMarker( 'markerFoo', { range, usingOperation: false } );
- } );
- expect( viewToString( viewRoot ) ).to.equal(
- '<div>' +
- '<p>' +
- '<span class="foo">foo</span>' +
- '</p>' +
- '<p>bar</p>' +
- '</div>'
- );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( p1, 1 ), writer.createPositionAt( p2, 2 ) );
- writer.addMarker( 'markerBar', { range, usingOperation: false } );
- } );
- 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 => {
- const range = writer.createRange( writer.createPositionAt( p1, 2 ), writer.createPositionAt( p2, 3 ) );
- writer.addMarker( 'markerXyz', { range, usingOperation: false } );
- } );
- 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>' );
- } );
- it( 'should do nothing if marker is applied and removed on empty-ish range', () => {
- downcastHelpers.markerToHighlight( highlightConfig );
- const p1 = modelRoot.getChild( 0 );
- const p2 = modelRoot.getChild( 1 );
- const markerRange = model.createRange( model.createPositionAt( p1, 3 ), model.createPositionAt( p2, 0 ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
- model.change( writer => {
- writer.removeMarker( 'marker', { range: markerRange, usingOperation: false } );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
- } );
- } );
- describe( 'on element', () => {
- const highlightConfig = {
- model: 'marker',
- view: {
- classes: 'highlight-class',
- attributes: { title: 'title' },
- id: 'customId'
- },
- converterPriority: 7
- };
- let markerRange, viewDocument;
- beforeEach( () => {
- viewDocument = new ViewDocument( new StylesProcessor() );
- downcastHelpers.elementToElement( {
- model: 'div',
- view: () => {
- const viewContainer = new ViewContainerElement( viewDocument, 'div' );
- viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => {
- writer.addClass( descriptor.classes, 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 = model.createRangeOn( modelElement );
- downcastHelpers.markerToHighlight( highlightConfig );
- } );
- it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
- model.change( writer => {
- writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
- } );
- 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', () => {
- downcastHelpers.markerToHighlight( {
- model: 'marker',
- view: { classes: 'override-class' },
- converterPriority: 'high'
- } );
- model.change( writer => {
- writer.addMarker( 'marker', { range: markerRange, usingOperation: false } );
- } );
- 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 );
- downcastHelpers.markerToHighlight( {
- model: 'marker2',
- view: () => null,
- converterPriority: 'high'
- } );
- viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => {
- expect( descriptor.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
- 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.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
- } );
- } );
- it( 'should do nothing if descriptor is not provided', () => {
- downcastHelpers.markerToHighlight( {
- model: 'marker2',
- view: () => null
- } );
- model.change( writer => {
- writer.addMarker( 'marker2', { range: markerRange, usingOperation: false } );
- } );
- 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>' );
- } );
- } );
- } );
- } );
- function expectResult( string ) {
- expect( stringifyView( 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, new StylesProcessor() );
- 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;
- const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- modelRootStart = model.createPositionAt( modelRoot, 0 );
- } );
- 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' );
- }, { converterPriority: 'high' } );
- model.change( writer => {
- writer.insert( new ModelText( 'foobar' ), modelRootStart );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
- } );
- } );
- // Remove converter is by default already added in `EditingController` instance.
- describe( 'remove()', () => {
- let viewDocument;
- beforeEach( () => {
- viewDocument = new ViewDocument( new StylesProcessor() );
- } );
- 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(
- writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( 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(
- writer.createRange( writer.createPositionAt( modelElement, 2 ), writer.createPositionAt( 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(
- writer.createRange( writer.createPositionAt( modelElement, 0 ), writer.createPositionAt( 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._appendChild( new ModelText( 'fozbar' ) );
- viewRoot._appendChild( [
- new ViewText( viewDocument, 'foz' ),
- new ViewUIElement( viewDocument, 'span' ),
- new ViewText( viewDocument, 'bar' )
- ] );
- // Remove 'b'.
- model.change( writer => {
- writer.remove(
- writer.createRange( writer.createPositionAt( modelRoot, 3 ), writer.createPositionAt( modelRoot, 4 ) )
- );
- } );
- expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
- // Remove 'z'.
- model.change( writer => {
- writer.remove(
- writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( 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._appendChild( new ModelText( 'fozbar' ) );
- viewRoot._appendChild( [
- new ViewText( viewDocument, 'foz' ),
- new ViewUIElement( viewDocument, 'span' ),
- new ViewText( viewDocument, 'bar' )
- ] );
- // Remove 'z<span></span>b'.
- model.change( writer => {
- writer.remove(
- writer.createRange( writer.createPositionAt( modelRoot, 2 ), writer.createPositionAt( 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 );
- const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
- downcastHelpers.elementToElement( { model: 'widget', view: '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( viewDocument, 'p' );
- const viewUi1 = new ViewUIElement( viewDocument, 'span' );
- const viewUi2 = new ViewUIElement( viewDocument, 'span' );
- const viewP2 = new ViewContainerElement( viewDocument, 'p' );
- modelRoot._appendChild( [ modelP1, modelP2 ] );
- viewRoot._appendChild( [ viewP1, viewUi1, viewUi2, viewP2 ] );
- controller.mapper.bindElements( modelP1, viewP1 );
- controller.mapper.bindElements( modelP2, viewP2 );
- // Remove second paragraph element.
- model.change( writer => {
- writer.remove( writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( 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( 'createViewElementFromHighlightDescriptor()', () => {
- let viewWriter;
- beforeEach( () => {
- viewWriter = new DowncastWriter( controller.view.document );
- } );
- it( 'should return attribute element from descriptor object', () => {
- const descriptor = {
- classes: 'foo-class',
- attributes: { one: '1', two: '2' },
- priority: 7
- };
- const element = createViewElementFromHighlightDescriptor( viewWriter, 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 = {
- classes: [ 'foo-class', 'bar-class' ],
- attributes: { one: '1', two: '2' },
- priority: 7
- };
- const element = createViewElementFromHighlightDescriptor( viewWriter, 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( viewWriter, 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 = {
- classes: 'foo-class',
- attributes: { one: '1', two: '2' }
- };
- const element = createViewElementFromHighlightDescriptor( viewWriter, descriptor );
- expect( element.is( 'attributeElement' ) ).to.be.true;
- expect( element.name ).to.equal( 'span' );
- expect( element.priority ).to.equal( ViewAttributeElement.DEFAULT_PRIORITY );
- 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 = {
- classes: 'foo-class',
- priority: 7
- };
- const element = createViewElementFromHighlightDescriptor( viewWriter, 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;
- } );
- } );
- } );
- describe( 'downcast selection converters', () => {
- let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, downcastHelpers;
- beforeEach( () => {
- model = new Model();
- modelDoc = model.document;
- modelRoot = modelDoc.createRoot();
- docSelection = modelDoc.selection;
- model.schema.extend( '$text', { allowIn: '$root' } );
- view = new View( new StylesProcessor() );
- viewDoc = view.document;
- viewRoot = createViewRoot( viewDoc );
- viewSelection = viewDoc.selection;
- mapper = new Mapper();
- mapper.bindElements( modelRoot, viewRoot );
- dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
- dispatcher.on( 'insert:$text', insertText() );
- downcastHelpers = new DowncastHelpers( [ dispatcher ] );
- downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
- downcastHelpers.markerToHighlight( { model: 'marker', view: { classes: 'marker' }, converterPriority: 1 } );
- // Default selection converters.
- dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
- dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
- dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
- } );
- afterEach( () => {
- view.destroy();
- } );
- describe( 'default converters', () => {
- describe( 'range selection', () => {
- it( 'in same container', () => {
- testSelection(
- [ 1, 4 ],
- 'foobar',
- 'f{oob}ar'
- );
- } );
- it( 'in same container with unicode characters', () => {
- testSelection(
- [ 2, 6 ],
- 'நிலைக்கு',
- 'நி{லைக்}கு'
- );
- } );
- it( 'in same container, over attribute', () => {
- testSelection(
- [ 1, 5 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'f{o<strong>ob</strong>a}r'
- );
- } );
- it( 'in same container, next to attribute', () => {
- testSelection(
- [ 1, 2 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'f{o}<strong>ob</strong>ar'
- );
- } );
- it( 'in same attribute', () => {
- testSelection(
- [ 2, 4 ],
- 'f<$text bold="true">ooba</$text>r',
- 'f<strong>o{ob}a</strong>r'
- );
- } );
- it( 'in same attribute, selection same as attribute', () => {
- testSelection(
- [ 2, 4 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'fo{<strong>ob</strong>}ar'
- );
- } );
- it( 'starts in text node, ends in attribute #1', () => {
- testSelection(
- [ 1, 3 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'f{o<strong>o}b</strong>ar'
- );
- } );
- it( 'starts in text node, ends in attribute #2', () => {
- testSelection(
- [ 1, 4 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'f{o<strong>ob</strong>}ar'
- );
- } );
- it( 'starts in attribute, ends in text node', () => {
- testSelection(
- [ 3, 5 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'fo<strong>o{b</strong>a}r'
- );
- } );
- it( 'consumes consumable values properly', () => {
- // Add callback that will fire before default ones.
- // This should prevent default callback doing anything.
- dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
- expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
- }, { priority: 'high' } );
- // Similar test case as the first in this suite.
- testSelection(
- [ 1, 4 ],
- 'foobar',
- 'foobar' // No selection in view.
- );
- } );
- it( 'should convert backward selection', () => {
- testSelection(
- [ 1, 3, 'backward' ],
- 'foobar',
- 'f{oo}bar'
- );
- expect( viewSelection.focus.offset ).to.equal( 1 );
- } );
- } );
- describe( 'collapsed selection', () => {
- let marker, viewDocument;
- beforeEach( () => {
- viewDocument = new ViewDocument( new StylesProcessor() );
- } );
- it( 'in container', () => {
- testSelection(
- [ 1, 1 ],
- 'foobar',
- 'f{}oobar'
- );
- } );
- it( 'in attribute', () => {
- testSelection(
- [ 3, 3 ],
- 'f<$text bold="true">ooba</$text>r',
- 'f<strong>oo{}ba</strong>r'
- );
- } );
- it( 'in attribute and marker', () => {
- setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
- marker = writer.addMarker( 'marker', { range, usingOperation: false } );
- writer.setSelection( modelRoot, 3 );
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
- '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
- );
- } );
- it( 'in attribute and marker - no attribute', () => {
- setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
- marker = writer.addMarker( 'marker', { range, usingOperation: false } );
- writer.setSelection( modelRoot, 3 );
- writer.removeSelectionAttribute( 'bold' );
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
- } );
- it( 'in marker - using highlight descriptor creator', () => {
- downcastHelpers.markerToHighlight( {
- model: 'marker2',
- view: data => ( { classes: data.markerName } )
- } );
- setModelData( model, 'foobar' );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
- marker = writer.addMarker( 'marker2', { range, usingOperation: false } );
- writer.setSelection( modelRoot, 3 );
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
- } );
- it( 'should do nothing if creator return null', () => {
- downcastHelpers.markerToHighlight( {
- model: 'marker3',
- view: () => null
- } );
- setModelData( model, 'foobar' );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
- marker = writer.addMarker( 'marker3', { range, usingOperation: false } );
- writer.setSelection( modelRoot, 3 );
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div>foo{}bar</div>' );
- } );
- // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
- it( 'selection with attribute before ui element - no non-ui children', () => {
- setModelData( model, '' );
- // Add two ui elements to view.
- viewRoot._appendChild( [
- new ViewUIElement( viewDocument, 'span' ),
- new ViewUIElement( viewDocument, 'span' )
- ] );
- model.change( writer => {
- writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 0 ] ) ) );
- writer.setSelectionAttribute( 'bold', true );
- } );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
- } );
- // #1072.
- it( 'selection with attribute before ui element - has non-ui children #1', () => {
- setModelData( model, 'x' );
- model.change( writer => {
- writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
- writer.setSelectionAttribute( 'bold', true );
- } );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- // Add ui element to view.
- const uiElement = new ViewUIElement( viewDocument, 'span' );
- viewRoot._insertChild( 1, uiElement );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
- } );
- // #1072.
- it( 'selection with attribute before ui element - has non-ui children #2', () => {
- setModelData( model, '<$text bold="true">x</$text>y' );
- model.change( writer => {
- writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
- writer.setSelectionAttribute( 'bold', true );
- } );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- // Add ui element to view.
- const uiElement = new ViewUIElement( viewDocument, 'span' );
- viewRoot._insertChild( 1, uiElement, writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
- } );
- it( 'consumes consumable values properly', () => {
- // Add callbacks that will fire before default ones.
- // This should prevent default callbacks doing anything.
- dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
- expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
- }, { priority: 'high' } );
- dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
- expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
- }, { priority: 'high' } );
- // Similar test case as above.
- testSelection(
- [ 3, 3 ],
- 'f<$text bold="true">ooba</$text>r',
- 'foobar' // No selection in view and no attribute.
- );
- } );
- } );
- } );
- describe( 'clean-up', () => {
- describe( 'convertRangeSelection', () => {
- it( 'should remove all ranges before adding new range', () => {
- testSelection(
- [ 0, 2 ],
- 'foobar',
- '{fo}obar'
- );
- testSelection(
- [ 3, 5 ],
- 'foobar',
- 'foo{ba}r'
- );
- expect( viewSelection.rangeCount ).to.equal( 1 );
- } );
- } );
- describe( 'convertCollapsedSelection', () => {
- it( 'should remove all ranges before adding new range', () => {
- testSelection(
- [ 2, 2 ],
- 'foobar',
- 'fo{}obar'
- );
- testSelection(
- [ 3, 3 ],
- 'foobar',
- 'foo{}bar'
- );
- expect( viewSelection.rangeCount ).to.equal( 1 );
- } );
- } );
- describe( 'clearAttributes', () => {
- it( 'should remove all ranges before adding new range', () => {
- testSelection(
- [ 3, 3 ],
- 'foobar',
- 'foo<strong>[]</strong>bar',
- { bold: 'true' }
- );
- view.change( writer => {
- const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
- model.change( writer => {
- writer.setSelection( modelRange );
- } );
- dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
- } );
- expect( viewSelection.rangeCount ).to.equal( 1 );
- const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
- expect( viewString ).to.equal( '<div>f{}oobar</div>' );
- } );
- it( 'should do nothing if the attribute element had been already removed', () => {
- testSelection(
- [ 3, 3 ],
- 'foobar',
- 'foo<strong>[]</strong>bar',
- { bold: 'true' }
- );
- view.change( writer => {
- // Remove <strong></strong> manually.
- writer.mergeAttributes( viewSelection.getFirstPosition() );
- const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
- model.change( writer => {
- writer.setSelection( modelRange );
- } );
- dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
- } );
- expect( viewSelection.rangeCount ).to.equal( 1 );
- const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
- expect( viewString ).to.equal( '<div>f{}oobar</div>' );
- } );
- it( 'should clear fake selection', () => {
- const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
- view.change( writer => {
- writer.setSelection( modelRange, { fake: true } );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- expect( viewSelection.isFake ).to.be.false;
- } );
- } );
- } );
- describe( 'table cell selection converter', () => {
- beforeEach( () => {
- model.schema.register( 'table', { isLimit: true } );
- model.schema.register( 'tr', { isLimit: true } );
- model.schema.register( 'td', { isLimit: true } );
- model.schema.extend( 'table', { allowIn: '$root' } );
- model.schema.extend( 'tr', { allowIn: 'table' } );
- model.schema.extend( 'td', { allowIn: 'tr' } );
- model.schema.extend( '$text', { allowIn: 'td' } );
- const downcastHelpers = new DowncastHelpers( [ dispatcher ] );
- // "Universal" converter to convert table structure.
- downcastHelpers.elementToElement( { model: 'table', view: 'table' } );
- downcastHelpers.elementToElement( { model: 'tr', view: 'tr' } );
- downcastHelpers.elementToElement( { model: 'td', view: 'td' } );
- // Special converter for table cells.
- dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
- const selection = data.selection;
- if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
- return;
- }
- for ( const range of selection.getRanges() ) {
- const node = range.start.parent;
- if ( !!node && node.is( 'element', 'td' ) ) {
- conversionApi.consumable.consume( selection, 'selection' );
- const viewNode = conversionApi.mapper.toViewElement( node );
- conversionApi.writer.addClass( 'selected', viewNode );
- }
- }
- }, { priority: 'high' } );
- } );
- it( 'should not be used to convert selection that is not on table cell', () => {
- testSelection(
- [ 1, 5 ],
- 'f{o<$text bold="true">ob</$text>a}r',
- 'f{o<strong>ob</strong>a}r'
- );
- } );
- it( 'should add a class to the selected table cell', () => {
- testSelection(
- // table tr#0 td#0 [foo, table tr#0 td#0 bar]
- [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 3 ] ],
- '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
- '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
- );
- } );
- it( 'should not be used if selection contains more than just a table cell', () => {
- testSelection(
- // table tr td#1 f{oo bar, table tr#2 bar]
- [ [ 0, 0, 0, 1 ], [ 0, 0, 1, 3 ] ],
- '<table><tr><td>foo</td><td>bar</td></tr></table>',
- '[<table><tr><td>foo</td><td>bar</td></tr></table>]'
- );
- } );
- } );
- // Tests if the selection got correctly converted.
- // Because `setData` might use selection converters itself to set the selection, we can't use it
- // to set the selection (because then we would test converters using converters).
- // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
- // that are offsets or paths of selection positions in root element.
- function testSelection( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
- // Parse passed `modelInput` string and set it as current model.
- setModelData( model, modelInput );
- // Manually set selection ranges using passed `selectionPaths`.
- const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
- const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
- const startPos = model.createPositionFromPath( modelRoot, startPath );
- const endPos = model.createPositionFromPath( modelRoot, endPath );
- const isBackward = selectionPaths[ 2 ] === 'backward';
- model.change( writer => {
- writer.setSelection( writer.createRange( startPos, endPos ), { backward: isBackward } );
- // And add or remove passed attributes.
- for ( const key in selectionAttributes ) {
- const value = selectionAttributes[ key ];
- if ( value ) {
- writer.setSelectionAttribute( key, value );
- } else {
- writer.removeSelectionAttribute( key );
- }
- }
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
- }
- } );
- 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;
- }
- function viewAttributesToString( item ) {
- let result = '';
- for ( const key of item.getAttributeKeys() ) {
- const value = item.getAttribute( key );
- if ( value ) {
- result += ' ' + key + '="' + value + '"';
- }
- }
- return result;
- }
|