| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041 |
- /**
- * @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';
- import { toWidget } from '@ckeditor/ckeditor5-widget/src/utils';
- 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 (without children)', () => {
- beforeEach( () => {
- model.schema.register( 'simpleBlock', {
- allowIn: '$root',
- allowAttributes: [ 'toStyle', 'toClass' ]
- } );
- downcastHelpers.elementToElement( {
- model: 'simpleBlock',
- view: ( modelElement, { writer } ) => {
- return writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
- },
- triggerBy: {
- attributes: [ 'toStyle', 'toClass' ]
- }
- } );
- } );
- it( 'should convert on insert', () => {
- model.change( writer => {
- writer.insertElement( 'simpleBlock', modelRoot, 0 );
- } );
- expectResult( '<div></div>' );
- } );
- it( 'should convert on attribute set', () => {
- setModelData( model, '<simpleBlock></simpleBlock>' );
- const [ viewBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- const [ viewAfter ] = getNodes();
- expectResult( '<div style="display:block"></div>' );
- expect( viewAfter ).to.not.equal( viewBefore );
- } );
- it( 'should convert on attribute change', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"></simpleBlock>' );
- const [ viewBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
- } );
- const [ viewAfter ] = getNodes();
- expectResult( '<div style="display:inline"></div>' );
- expect( viewAfter ).to.not.equal( viewBefore );
- } );
- 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 properly re-bind mapper', () => {
- downcastHelpers.elementToElement( {
- model: 'simpleBlock',
- view: ( modelElement, { writer } ) => {
- const viewElement = writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
- return toWidget( viewElement, writer );
- },
- triggerBy: {
- attributes: [ 'toStyle', 'toClass' ]
- },
- converterPriority: 'high'
- } );
- const mapper = controller.mapper;
- downcastHelpers.markerToHighlight( {
- model: 'myMarker',
- view: { classes: 'foo' }
- } );
- setModelData( model, '<simpleBlock></simpleBlock>' );
- const modelElement = modelRoot.getChild( 0 );
- const [ viewBefore ] = getNodes();
- model.change( writer => {
- writer.addMarker( 'myMarker', { range: writer.createRangeOn( modelElement ), usingOperation: false } );
- } );
- expect( mapper.toViewElement( modelElement ) ).to.equal( viewBefore );
- expect( mapper.toModelElement( viewBefore ) ).to.equal( modelElement );
- expect( mapper.markerNameToElements( 'myMarker' ).has( viewBefore ) ).to.be.true;
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelElement );
- } );
- const [ viewAfter ] = getNodes();
- expect( mapper.toViewElement( modelElement ) ).to.equal( viewAfter );
- expect( mapper.toModelElement( viewBefore ) ).to.be.undefined;
- expect( mapper.toModelElement( viewAfter ) ).to.equal( modelElement );
- expect( mapper.markerNameToElements( 'myMarker' ).has( viewAfter ) ).to.be.true;
- expect( mapper.markerNameToElements( 'myMarker' ).has( viewBefore ) ).to.be.false;
- } );
- it( 'should do nothing if non-triggerBy attribute has changed', () => {
- setModelData( model, '<simpleBlock></simpleBlock>' );
- const [ viewBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
- } );
- const [ viewAfter ] = getNodes();
- expectResult( '<div></div>' );
- expect( viewAfter ).to.equal( viewBefore );
- } );
- } );
- describe( 'with simple block view structure (with children)', () => {
- beforeEach( () => {
- model.schema.register( 'simpleBlock', {
- allowIn: '$root',
- allowAttributes: [ 'toStyle', 'toClass' ]
- } );
- downcastHelpers.elementToElement( {
- model: 'simpleBlock',
- view: ( modelElement, { writer } ) => {
- return writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
- },
- triggerBy: {
- attributes: [ 'toStyle', 'toClass' ]
- }
- } );
- model.schema.register( 'paragraph', {
- inheritAllFrom: '$block',
- allowIn: 'simpleBlock'
- } );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- } );
- it( 'should convert on insert', () => {
- model.change( writer => {
- const simpleBlock = writer.createElement( 'simpleBlock' );
- const paragraph = writer.createElement( 'paragraph' );
- writer.insert( simpleBlock, modelRoot, 0 );
- writer.insert( paragraph, simpleBlock, 0 );
- writer.insertText( 'foo', paragraph, 0 );
- } );
- expectResult( '<div><p>foo</p></div>' );
- } );
- it( 'should convert on attribute set', () => {
- setModelData( model, '<simpleBlock><paragraph>foo</paragraph></simpleBlock>' );
- const [ viewBefore, paraBefore, textBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- const [ viewAfter, paraAfter, textAfter ] = getNodes();
- expectResult( '<div style="display:block"><p>foo</p></div>' );
- expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
- expect( paraAfter, 'para' ).to.equal( paraBefore );
- expect( textAfter, 'text' ).to.equal( textBefore );
- } );
- it( 'should convert on attribute change', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
- const [ viewBefore, paraBefore, textBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
- } );
- const [ viewAfter, paraAfter, textAfter ] = getNodes();
- expectResult( '<div style="display:inline"><p>foo</p></div>' );
- expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
- expect( paraAfter, 'para' ).to.equal( paraBefore );
- expect( textAfter, 'text' ).to.equal( textBefore );
- } );
- it( 'should convert on attribute remove', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
- model.change( writer => {
- writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div><p>foo</p></div>' );
- } );
- it( 'should convert on one attribute add and other remove', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
- model.change( writer => {
- writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
- writer.setAttribute( 'toClass', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="is-classy"><p>foo</p></div>' );
- } );
- it( 'should do nothing if non-triggerBy attribute has changed', () => {
- setModelData( model, '<simpleBlock><paragraph>foo</paragraph></simpleBlock>' );
- const [ viewBefore, paraBefore, textBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
- } );
- const [ viewAfter, paraAfter, textAfter ] = getNodes();
- expectResult( '<div><p>foo</p></div>' );
- expect( viewAfter, 'simpleBlock' ).to.equal( viewBefore );
- expect( paraAfter, 'para' ).to.equal( paraBefore );
- // TODO - is text always re-converted?
- expect( textAfter, 'text' ).to.equal( textBefore );
- } );
- } );
- describe( 'with simple block view structure (with children - reconvert on child add)', () => {
- beforeEach( () => {
- model.schema.register( 'simpleBlock', {
- allowIn: '$root'
- } );
- downcastHelpers.elementToElement( {
- model: 'simpleBlock',
- view: 'div',
- triggerBy: {
- children: [ 'paragraph' ]
- }
- } );
- model.schema.register( 'paragraph', {
- inheritAllFrom: '$block',
- allowIn: 'simpleBlock'
- } );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- } );
- it( 'should convert on insert', () => {
- model.change( writer => {
- const simpleBlock = writer.createElement( 'simpleBlock' );
- const paragraph = writer.createElement( 'paragraph' );
- writer.insert( simpleBlock, modelRoot, 0 );
- writer.insert( paragraph, simpleBlock, 0 );
- writer.insertText( 'foo', paragraph, 0 );
- } );
- expectResult( '<div><p>foo</p></div>' );
- } );
- it( 'should convert on adding a child (at the beginning)', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
- const [ viewBefore, paraBefore, textBefore ] = getNodes();
- model.change( writer => {
- const paragraph = writer.createElement( 'paragraph' );
- const text = writer.createText( 'bar' );
- writer.insert( paragraph, modelRoot.getChild( 0 ), 0 );
- writer.insert( text, paragraph, 0 );
- } );
- const [ viewAfter, /* insertedPara */, /* insertedText */, paraAfter, textAfter ] = getNodes();
- expectResult( '<div><p>bar</p><p>foo</p></div>' );
- expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
- expect( paraAfter, 'para' ).to.equal( paraBefore );
- expect( textAfter, 'text' ).to.equal( textBefore );
- } );
- it( 'should convert on adding a child (in the middle)', () => {
- setModelData( model,
- '<simpleBlock toStyle="display:block">' +
- '<paragraph>foo</paragraph><paragraph>bar</paragraph>' +
- '</simpleBlock>' );
- const [ viewBefore, paraFooBefore, textFooBefore, paraBarBefore, textBarBefore ] = getNodes();
- model.change( writer => {
- const paragraph = writer.createElement( 'paragraph' );
- const text = writer.createText( 'baz' );
- writer.insert( paragraph, modelRoot.getChild( 0 ), 1 );
- writer.insert( text, paragraph, 0 );
- } );
- const [ viewAfter,
- paraFooAfter, textFooAfter, /* insertedPara */, /* insertedText */, paraBarAfter, textBarAfter
- ] = getNodes();
- expectResult( '<div><p>foo</p><p>baz</p><p>bar</p></div>' );
- expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
- expect( paraFooAfter, 'para foo' ).to.equal( paraFooBefore );
- expect( textFooAfter, 'text foo' ).to.equal( textFooBefore );
- expect( paraBarAfter, 'para bar' ).to.equal( paraBarBefore );
- expect( textBarAfter, 'text bar' ).to.equal( textBarBefore );
- } );
- it( 'should convert on adding a child (at the end)', () => {
- setModelData( model, '<simpleBlock toStyle="display:block"><paragraph>foo</paragraph></simpleBlock>' );
- const [ viewBefore, paraBefore, textBefore ] = getNodes();
- model.change( writer => {
- const paragraph = writer.createElement( 'paragraph' );
- const text = writer.createText( 'bar' );
- writer.insert( paragraph, modelRoot.getChild( 0 ), 1 );
- writer.insert( text, paragraph, 0 );
- } );
- const [ viewAfter, paraAfter, textAfter ] = getNodes();
- expectResult( '<div><p>foo</p><p>bar</p></div>' );
- expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
- expect( paraAfter, 'para' ).to.equal( paraBefore );
- expect( textAfter, 'text' ).to.equal( textBefore );
- } );
- it( 'should convert on removing a child', () => {
- setModelData( model,
- '<simpleBlock><paragraph>foo</paragraph><paragraph>bar</paragraph></simpleBlock>' );
- const [ viewBefore, paraBefore, textBefore ] = getNodes();
- model.change( writer => {
- writer.remove( modelRoot.getNodeByPath( [ 0, 1 ] ) );
- } );
- const [ viewAfter, paraAfter, textAfter ] = getNodes();
- expectResult( '<div><p>foo</p></div>' );
- expect( viewAfter, 'simpleBlock' ).to.not.equal( viewBefore );
- expect( paraAfter, 'para' ).to.equal( paraBefore );
- expect( textAfter, 'text' ).to.equal( textBefore );
- } );
- } );
- describe( 'with complex view structure - no children allowed', () => {
- beforeEach( () => {
- model.schema.register( 'complex', {
- allowIn: '$root',
- allowAttributes: [ 'toStyle', 'toClass' ]
- } );
- downcastHelpers.elementToElement( {
- model: 'complex',
- view: ( modelElement, { writer } ) => {
- const outer = writer.createContainerElement( 'div', { class: 'complex-outer' } );
- const inner = writer.createContainerElement( 'div', getViewAttributes( modelElement ) );
- writer.insert( writer.createPositionAt( outer, 0 ), inner );
- return outer;
- },
- triggerBy: {
- attributes: [ 'toStyle', 'toClass' ]
- }
- } );
- } );
- it( 'should convert on insert', () => {
- model.change( writer => {
- writer.insertElement( 'complex', modelRoot, 0 );
- } );
- expectResult( '<div class="complex-outer"><div></div></div>' );
- } );
- it( 'should convert on attribute set', () => {
- setModelData( model, '<complex></complex>' );
- const [ outerDivBefore, innerDivBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- const [ outerDivAfter, innerDivAfter ] = getNodes();
- expectResult( '<div class="complex-outer"><div style="display:block"></div></div>' );
- expect( outerDivAfter, 'outer div' ).to.not.equal( outerDivBefore );
- expect( innerDivAfter, 'inner div' ).to.not.equal( innerDivBefore );
- } );
- it( 'should convert on attribute change', () => {
- setModelData( model, '<complex toStyle="display:block"></complex>' );
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:inline', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="complex-outer"><div style="display:inline"></div></div>' );
- } );
- it( 'should convert on attribute remove', () => {
- setModelData( model, '<complex toStyle="display:block"></complex>' );
- model.change( writer => {
- writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="complex-outer"><div></div></div>' );
- } );
- it( 'should convert on one attribute add and other 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( '<div class="complex-outer"><div class="is-classy"></div></div>' );
- } );
- it( 'should do nothing if non-triggerBy attribute has changed', () => {
- setModelData( model, '<complex></complex>' );
- const [ outerDivBefore, innerDivBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
- } );
- const [ outerDivAfter, innerDivAfter ] = getNodes();
- expectResult( '<div class="complex-outer"><div></div></div>' );
- expect( outerDivAfter, 'outer div' ).to.equal( outerDivBefore );
- expect( innerDivAfter, 'inner div' ).to.equal( innerDivBefore );
- } );
- } );
- describe( 'with complex view structure (without slots)', () => {
- beforeEach( () => {
- model.schema.register( 'complex', {
- allowIn: '$root',
- allowAttributes: [ 'toStyle', 'toClass' ]
- } );
- downcastHelpers.elementToElement( {
- model: 'complex',
- view: ( modelElement, { writer, mapper } ) => {
- const outer = writer.createContainerElement( 'c-outer' );
- const inner = writer.createContainerElement( 'c-inner', getViewAttributes( modelElement ) );
- writer.insert( writer.createPositionAt( outer, 0 ), inner );
- mapper.bindElements( modelElement, outer ); // Need for nested mapping
- mapper.bindElements( modelElement, inner );
- return outer;
- },
- triggerBy: {
- attributes: [ 'toStyle', 'toClass' ]
- }
- } );
- model.schema.register( 'paragraph', {
- inheritAllFrom: '$block',
- allowIn: 'complex'
- } );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- } );
- it( 'should convert on insert', () => {
- model.change( writer => {
- writer.insertElement( 'complex', modelRoot, 0 );
- } );
- expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
- } );
- it( 'should convert on attribute set', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<c-outer><c-inner style="display:block"></c-inner></c-outer>' );
- } );
- it( 'should convert on attribute remove', () => {
- setModelData( model, '<complex toStyle="display:block"></complex>' );
- model.change( writer => {
- writer.removeAttribute( 'toStyle', modelRoot.getChild( 0 ) );
- } );
- expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
- } );
- it( 'should convert on one attribute add and other 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-outer><c-inner class="is-classy"></c-inner></c-outer>' );
- } );
- it( 'should do nothing if non-triggerBy attribute has changed', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'notTriggered', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<c-outer><c-inner></c-inner></c-outer>' );
- } );
- describe( 'memoization', () => {
- it( 'should create new element on re-converting element', () => {
- setModelData( model, '<complex></complex>' );
- const [ outerBefore, innerBefore ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'toStyle', 'display:block', modelRoot.getChild( 0 ) );
- } );
- const [ outerAfter, innerAfter ] = getNodes();
- expect( outerAfter, 'outer' ).to.not.equal( outerBefore );
- expect( innerAfter, 'inner' ).to.not.equal( innerBefore );
- } );
- // Skipped, as it would require two-level mapping. See https://github.com/ckeditor/ckeditor5/issues/1589.
- // Doable as a similar case works in table scenario for table cells (table is refreshed).
- it.skip( 'should not re-create child elements on re-converting element', () => {
- setModelData( model, '<complex><paragraph>Foo bar baz</paragraph></complex>' );
- expectResult( '<c-outer><c-inner><p>Foo bar baz</p></c-inner></c-outer>' );
- 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 );
- } );
- } );
- } );
- describe( 'with complex view structure (slot conversion)', () => {
- beforeEach( () => {
- model.schema.register( 'complex', {
- allowIn: '$root',
- allowAttributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
- } );
- downcastHelpers.elementToElement( {
- model: 'complex',
- view: ( modelElement, { writer, mapper } ) => {
- const classForMain = !!modelElement.getAttribute( 'classForMain' );
- const classForWrap = !!modelElement.getAttribute( 'classForWrap' );
- const attributeToElement = !!modelElement.getAttribute( 'attributeToElement' );
- const outer = writer.createContainerElement( 'div', {
- class: `complex-slots${ classForMain ? ' with-class' : '' }`
- } );
- const inner = writer.createContainerElement( 'div', {
- class: `slots${ classForWrap ? ' with-class' : '' }`
- } );
- if ( attributeToElement ) {
- const optional = writer.createEmptyElement( 'div', { class: 'optional' } );
- writer.insert( writer.createPositionAt( outer, 0 ), optional );
- }
- writer.insert( writer.createPositionAt( outer, 'end' ), inner );
- mapper.bindElements( modelElement, inner );
- for ( const slot of modelElement.getChildren() ) {
- const viewSlot = writer.createContainerElement( 'div', { class: 'slot' } );
- writer.insert( writer.createPositionAt( inner, slot.index ), viewSlot );
- mapper.bindElements( slot, viewSlot );
- }
- return outer;
- },
- triggerBy: {
- attributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ],
- children: [ 'slot' ]
- }
- } );
- model.schema.register( 'slot', {
- allowIn: 'complex'
- } );
- model.schema.register( 'paragraph', {
- inheritAllFrom: '$block',
- allowIn: 'slot'
- } );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- } );
- it( 'should convert on insert', () => {
- model.change( writer => {
- writer.insertElement( 'complex', modelRoot, 0 );
- } );
- expectResult( '<div class="complex-slots"><div class="slots"></div></div>' );
- } );
- it( 'should convert on attribute set (main element)', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="complex-slots with-class"><div class="slots"></div></div>' );
- } );
- it( 'should convert on attribute set (other element)', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'classForWrap', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="complex-slots"><div class="slots with-class"></div></div>' );
- } );
- it( 'should convert on attribute set (insert new view element)', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'attributeToElement', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="complex-slots"><div class="optional"></div><div class="slots"></div></div>' );
- } );
- it( 'should convert element with slots', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- expectResult(
- '<div class="complex-slots">' +
- '<div class="slots">' +
- '<div class="slot"><p>foo</p></div>' +
- '<div class="slot"><p>bar</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should convert element on adding slot', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- insertBazSlot( writer, modelRoot );
- } );
- expectResult(
- '<div class="complex-slots">' +
- '<div class="slots">' +
- '<div class="slot"><p>foo</p></div>' +
- '<div class="slot"><p>bar</p></div>' +
- '<div class="slot"><p>baz</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should convert element on removing slot', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
- } );
- expectResult(
- '<div class="complex-slots">' +
- '<div class="slots">' +
- '<div class="slot"><p>bar</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should convert element on multiple triggers (remove + insert)', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
- insertBazSlot( writer, modelRoot );
- } );
- expectResult(
- '<div class="complex-slots">' +
- '<div class="slots">' +
- '<div class="slot"><p>bar</p></div>' +
- '<div class="slot"><p>baz</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should convert element on multiple triggers (remove + attribute)', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
- writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
- } );
- expectResult(
- '<div class="complex-slots with-class">' +
- '<div class="slots">' +
- '<div class="slot"><p>bar</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should convert element on multiple triggers (insert + attribute)', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- insertBazSlot( writer, modelRoot );
- writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
- } );
- expectResult(
- '<div class="complex-slots with-class">' +
- '<div class="slots">' +
- '<div class="slot"><p>foo</p></div>' +
- '<div class="slot"><p>bar</p></div>' +
- '<div class="slot"><p>baz</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should not trigger refresh on adding a slot to an element without triggerBy conversion', () => {
- model.schema.register( 'other', {
- allowIn: '$root'
- } );
- model.schema.extend( 'slot', {
- allowIn: 'other'
- } );
- downcastHelpers.elementToElement( {
- model: 'other',
- view: {
- name: 'div',
- classes: 'other'
- }
- } );
- downcastHelpers.elementToElement( {
- model: 'slot',
- view: {
- name: 'div',
- classes: 'slot'
- }
- } );
- setModelData( model,
- '<other>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</other>'
- );
- const otherView = viewRoot.getChild( 0 );
- model.change( writer => {
- insertBazSlot( writer, modelRoot );
- } );
- expectResult(
- '<div class="other">' +
- '<div class="slot"><p>foo</p></div>' +
- '<div class="slot"><p>bar</p></div>' +
- '<div class="slot"><p>baz</p></div>' +
- '</div>'
- );
- const otherViewAfter = viewRoot.getChild( 0 );
- expect( otherView, 'the view should not be refreshed' ).to.equal( otherViewAfter );
- } );
- describe( 'memoization', () => {
- it( 'should create new element on re-converting element', () => {
- setModelData( model, '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>'
- );
- const [ complexView ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
- } );
- const [ viewAfterReRender ] = getNodes();
- expect( viewAfterReRender, 'the view should be refreshed' ).to.not.equal( complexView );
- } );
- it( 'should not re-create slot\'s child elements on re-converting main element (attribute changed)', () => {
- setModelData( model, '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>'
- );
- const [ main, /* unused */,
- slotOne, paraOne, textNodeOne,
- slotTwo, paraTwo, textNodeTwo ] = getNodes();
- model.change( writer => {
- writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
- } );
- const [ mainAfter, /* unused */,
- slotOneAfter, paraOneAfter, textNodeOneAfter,
- slotTwoAfter, paraTwoAfter, textNodeTwoAfter ] = getNodes();
- expect( mainAfter, 'main view' ).to.not.equal( main );
- expect( slotOneAfter, 'first slot view' ).to.not.equal( slotOne );
- expect( slotTwoAfter, 'second slot view' ).to.not.equal( slotTwo );
- expect( paraOneAfter, 'first slot paragraph view' ).to.equal( paraOne );
- expect( textNodeOneAfter, 'first slot text node view' ).to.equal( textNodeOne );
- expect( paraTwoAfter, 'second slot paragraph view' ).to.equal( paraTwo );
- expect( textNodeTwoAfter, 'second slot text node view' ).to.equal( textNodeTwo );
- } );
- it( 'should not re-create slot\'s child elements on re-converting main element (slot added)', () => {
- setModelData( model, '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>'
- );
- const [ main, /* unused */,
- slotOne, paraOne, textNodeOne,
- slotTwo, paraTwo, textNodeTwo ] = getNodes();
- model.change( writer => {
- const slot = writer.createElement( 'slot' );
- const paragraph = writer.createElement( 'paragraph' );
- writer.insertText( 'baz', paragraph, 0 );
- writer.insert( paragraph, slot, 0 );
- writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
- } );
- const [ mainAfter, /* unused */,
- slotOneAfter, paraOneAfter, textNodeOneAfter,
- slotTwoAfter, paraTwoAfter, textNodeTwoAfter,
- slotThreeAfter, paraThreeAfter, textNodeThreeAfter
- ] = getNodes();
- expect( mainAfter, 'main view' ).to.not.equal( main );
- expect( slotOneAfter, 'first slot view' ).to.not.equal( slotOne );
- expect( slotTwoAfter, 'second slot view' ).to.not.equal( slotTwo );
- expect( paraOneAfter, 'first slot paragraph view' ).to.equal( paraOne );
- expect( textNodeOneAfter, 'first slot text node view' ).to.equal( textNodeOne );
- expect( paraTwoAfter, 'second slot paragraph view' ).to.equal( paraTwo );
- expect( textNodeTwoAfter, 'second slot text node view' ).to.equal( textNodeTwo );
- expect( slotThreeAfter, 'third slot view' ).to.not.be.undefined;
- expect( paraThreeAfter, 'third slot paragraph view' ).to.not.be.undefined;
- expect( textNodeThreeAfter, 'third slot text node view' ).to.not.be.undefined;
- } );
- } );
- } );
- // Skipped, as it would require two-level mapping. See https://github.com/ckeditor/ckeditor5/issues/1589.
- describe.skip( 'with complex view structure (slot conversion atomic converters for some changes)', () => {
- beforeEach( () => {
- model.schema.register( 'complex', {
- allowIn: '$root',
- allowAttributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
- } );
- function createViewSlot( slot, { writer, mapper } ) {
- const viewSlot = writer.createContainerElement( 'div', { class: 'slot' } );
- mapper.bindElements( slot, viewSlot );
- return viewSlot;
- }
- downcastHelpers.elementToElement( {
- model: 'complex',
- view: ( modelElement, { writer, mapper, consumable } ) => {
- const classForMain = !!modelElement.getAttribute( 'classForMain' );
- const classForWrap = !!modelElement.getAttribute( 'classForWrap' );
- const attributeToElement = !!modelElement.getAttribute( 'attributeToElement' );
- const outer = writer.createContainerElement( 'div', {
- class: `complex-slots${ classForMain ? ' with-class' : '' }`
- } );
- const inner = writer.createContainerElement( 'div', {
- class: `slots${ classForWrap ? ' with-class' : '' }`
- } );
- if ( attributeToElement ) {
- const optional = writer.createEmptyElement( 'div', { class: 'optional' } );
- writer.insert( writer.createPositionAt( outer, 0 ), optional );
- }
- writer.insert( writer.createPositionAt( outer, 'end' ), inner );
- mapper.bindElements( modelElement, outer );
- mapper.bindElements( modelElement, inner );
- for ( const slot of modelElement.getChildren() ) {
- const viewSlot = createViewSlot( slot, { writer, mapper } );
- writer.insert( writer.createPositionAt( inner, slot.index ), viewSlot );
- consumable.consume( slot, 'insert' );
- }
- return outer;
- },
- triggerBy: {
- attributes: [ 'classForMain', 'classForWrap', 'attributeToElement' ]
- // Contrary to the previous test - do not act on child changes.
- // children: [ 'slot' ]
- }
- } );
- downcastHelpers.elementToElement( {
- model: 'slot',
- view: createViewSlot
- } );
- model.schema.register( 'slot', {
- allowIn: 'complex'
- } );
- model.schema.register( 'paragraph', {
- inheritAllFrom: '$block',
- allowIn: 'slot'
- } );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- } );
- it( 'should convert on insert', () => {
- model.change( writer => {
- writer.insertElement( 'complex', modelRoot, 0 );
- } );
- expectResult( '<div class="complex-slots"><div class="slots"></div></div>' );
- } );
- it( 'should convert on attribute set (main element)', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="complex-slots with-class"><div class="slots"></div></div>' );
- } );
- it( 'should convert on attribute set (other element)', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'classForWrap', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="complex-slots"><div class="slots with-class"></div></div>' );
- } );
- it( 'should convert on attribute set (insert new view element)', () => {
- setModelData( model, '<complex></complex>' );
- model.change( writer => {
- writer.setAttribute( 'attributeToElement', true, modelRoot.getChild( 0 ) );
- } );
- expectResult( '<div class="complex-slots"><div class="optional"></div><div class="slots"></div></div>' );
- } );
- it( 'should convert element with slots', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- expectResult(
- '<div class="complex-slots">' +
- '<div class="slots">' +
- '<div class="slot"><p>foo</p></div>' +
- '<div class="slot"><p>bar</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should not convert element on adding slot', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- const slot = writer.createElement( 'slot' );
- const paragraph = writer.createElement( 'paragraph' );
- writer.insertText( 'baz', paragraph, 0 );
- writer.insert( paragraph, slot, 0 );
- writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
- } );
- expectResult(
- '<div class="complex-slots">' +
- '<div class="slots">' +
- '<div class="slot"><p>foo</p></div>' +
- '<div class="slot"><p>bar</p></div>' +
- '<div class="slot"><p>baz</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should not convert element on removing slot', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
- } );
- expectResult(
- '<div class="complex-slots">' +
- '<div class="slots">' +
- '<div class="slot"><p>bar</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should convert element on a trigger and block atomic converters (remove + attribute)', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- writer.remove( modelRoot.getChild( 0 ).getChild( 0 ) );
- writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
- } );
- expectResult(
- '<div class="complex-slots with-class">' +
- '<div class="slots">' +
- '<div class="slot"><p>bar</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- it( 'should convert element on a trigger and block atomic converters (insert + attribute)', () => {
- setModelData( model,
- '<complex>' +
- '<slot><paragraph>foo</paragraph></slot>' +
- '<slot><paragraph>bar</paragraph></slot>' +
- '</complex>' );
- model.change( writer => {
- writer.insert( modelRoot.getChild( 0 ).getChild( 0 ) );
- writer.setAttribute( 'classForMain', true, modelRoot.getChild( 0 ) );
- } );
- expectResult(
- '<div class="complex-slots with-class">' +
- '<div class="slots">' +
- '<div class="slot"><p>foo</p></div>' +
- '<div class="slot"><p>bar</p></div>' +
- '<div class="slot"><p>baz</p></div>' +
- '</div>' +
- '</div>'
- );
- } );
- } );
- function getViewAttributes( modelElement ) {
- const toStyle = modelElement.hasAttribute( 'toStyle' ) && { style: modelElement.getAttribute( 'toStyle' ) };
- const toClass = modelElement.hasAttribute( 'toClass' ) && { class: 'is-classy' };
- return {
- ...toStyle,
- ...toClass
- };
- }
- function insertBazSlot( writer, modelRoot ) {
- const slot = writer.createElement( 'slot' );
- const paragraph = writer.createElement( 'paragraph' );
- writer.insertText( 'baz', paragraph, 0 );
- writer.insert( paragraph, slot, 0 );
- writer.insert( slot, modelRoot.getChild( 0 ), 'end' );
- }
- function* getNodes() {
- const main = viewRoot.getChild( 0 );
- yield main;
- for ( const { item } of controller.view.createRangeIn( main ) ) {
- if ( item.is( 'textProxy' ) ) {
- // TreeWalker always create a new instance of a TextProxy so use referenced textNode.
- yield item.textNode;
- } else {
- yield item;
- }
- }
- }
- } );
- } );
- 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;
- }
|