| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* global window, document, setTimeout, Event, console */
- import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import global from '@ckeditor/ckeditor5-utils/src/dom/global';
- import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
- import EventInfo from '@ckeditor/ckeditor5-utils/src/eventinfo';
- import ContextualBalloon from '@ckeditor/ckeditor5-ui/src/panel/balloon/contextualballoon';
- import env from '@ckeditor/ckeditor5-utils/src/env';
- import MentionUI, { createRegExp } from '../src/mentionui';
- import MentionEditing from '../src/mentionediting';
- import MentionsView from '../src/ui/mentionsview';
- import { assertCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
- describe( 'MentionUI', () => {
- let editor, model, doc, editingView, mentionUI, editorElement, mentionsView, panelView;
- const staticConfig = {
- feeds: [
- {
- feed: [ '@Barney', '@Lily', '@Marshall', '@Robin', '@Ted' ],
- marker: '@'
- }
- ]
- };
- testUtils.createSinonSandbox();
- beforeEach( () => {
- editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- } );
- afterEach( () => {
- sinon.restore();
- editorElement.remove();
- if ( editor ) {
- return editor.destroy();
- }
- } );
- it( 'should create a plugin instance', () => {
- return createClassicTestEditor().then( () => {
- expect( mentionUI ).to.instanceOf( Plugin );
- expect( mentionUI ).to.instanceOf( MentionUI );
- } );
- } );
- it( 'should load ContextualBalloon plugin', () => {
- return createClassicTestEditor().then( () => {
- expect( editor.plugins.get( ContextualBalloon ) ).to.be.instanceOf( ContextualBalloon );
- } );
- } );
- describe( 'init()', () => {
- it( 'should throw if marker was not provided for feed', () => {
- return createClassicTestEditor( { feeds: [ { feed: [ 'a' ] } ] } ).catch( error => {
- assertCKEditorError( error, /mentionconfig-incorrect-marker/, null, { marker: undefined } );
- } );
- } );
- it( 'should throw if marker is empty string', () => {
- return createClassicTestEditor( { feeds: [ { marker: '', feed: [ 'a' ] } ] } ).catch( error => {
- assertCKEditorError( error, /mentionconfig-incorrect-marker/, null, { marker: '' } );
- } );
- } );
- it( 'should throw if marker is longer then 1 character', () => {
- return createClassicTestEditor( { feeds: [ { marker: '$$', feed: [ 'a' ] } ] } ).catch( error => {
- assertCKEditorError( error, /mentionconfig-incorrect-marker/, null, { marker: '$$' } );
- } );
- } );
- } );
- describe( 'pluginName', () => {
- it( 'should return plugin by its name', () => {
- return createClassicTestEditor().then( () => {
- expect( editor.plugins.get( 'MentionUI' ) ).to.equal( mentionUI );
- } );
- } );
- } );
- describe( 'contextual balloon', () => {
- let balloonAddSpy;
- beforeEach( () => {
- return createClassicTestEditor( staticConfig )
- .then( () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- const contextualBalloon = editor.plugins.get( ContextualBalloon );
- balloonAddSpy = sinon.spy( contextualBalloon, 'add' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce );
- } );
- it( 'should disable arrow', () => {
- sinon.assert.calledOnce( balloonAddSpy );
- sinon.assert.calledWithExactly( balloonAddSpy, sinon.match( data => data.singleViewMode ) );
- expect( panelView.isVisible ).to.be.true;
- expect( panelView.withArrow ).to.be.false;
- } );
- it( 'should add MentionView to a panel', () => {
- expect( editor.plugins.get( ContextualBalloon ).visibleView ).to.be.instanceof( MentionsView );
- } );
- } );
- describe( 'position', () => {
- let pinSpy;
- const caretRect = {
- bottom: 118,
- height: 18,
- left: 500,
- right: 501,
- top: 100,
- width: 1
- };
- const balloonRect = {
- bottom: 150,
- height: 150,
- left: 0,
- right: 200,
- top: 0,
- width: 200
- };
- beforeEach( () => {
- return createClassicTestEditor( staticConfig ).then( () => {
- pinSpy = sinon.spy( panelView, 'pin' );
- } );
- } );
- it( 'should properly calculate position data', () => {
- const editableElement = editingView.document.selection.editableElement;
- setData( model, '<paragraph>foo []</paragraph>' );
- stubSelectionRects( [ caretRect ] );
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- const pinArgument = pinSpy.firstCall.args[ 0 ];
- const { target, positions, limiter, fitInViewport } = pinArgument;
- expect( positions ).to.have.length( 4 );
- // Mention UI should set limiter to the editable area.
- expect( limiter() ).to.equal( editingView.domConverter.mapViewToDom( editableElement ) );
- expect( fitInViewport ).to.be.undefined;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- const mentionMarker = editor.model.markers.get( 'mention' );
- const focus = doc.selection.focus;
- const expectedRange = editor.model.createRange( focus.getShiftedBy( -1 ), focus );
- // It should create a model marker for matcher marker character ('@').
- expect( expectedRange.isEqual( mentionMarker.getRange() ) ).to.be.true;
- const toViewRangeSpy = sinon.spy( editor.editing.mapper, 'toViewRange' );
- expect( target() ).to.deep.equal( caretRect );
- sinon.assert.calledOnce( toViewRangeSpy );
- const range = toViewRangeSpy.firstCall.args[ 0 ];
- expect( mentionMarker.getRange().isEqual( range ), 'Should position to mention marker.' );
- const caretSouthEast = positions[ 0 ];
- const caretSouthWest = positions[ 1 ];
- const caretNorthEast = positions[ 2 ];
- const caretNorthWest = positions[ 3 ];
- expect( caretSouthEast( caretRect, balloonRect ) ).to.deep.equal( {
- left: 501,
- name: 'caret_se',
- top: 121
- } );
- expect( caretSouthWest( caretRect, balloonRect ) ).to.deep.equal( {
- left: 301,
- name: 'caret_sw',
- top: 121
- } );
- expect( caretNorthEast( caretRect, balloonRect ) ).to.deep.equal( {
- left: 501,
- name: 'caret_ne',
- top: -53
- } );
- expect( caretNorthWest( caretRect, balloonRect ) ).to.deep.equal( {
- left: 301,
- name: 'caret_nw',
- top: -53
- } );
- } );
- } );
- it( 'should re-calculate position on typing and stay on selected position', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- stubSelectionRects( [ caretRect ] );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- let positionAfterFirstShow;
- return waitForDebounce()
- .then( () => {
- sinon.assert.calledOnce( pinSpy );
- const pinArgument = pinSpy.firstCall.args[ 0 ];
- const { positions } = pinArgument;
- expect( positions ).to.have.length( 4 );
- positionAfterFirstShow = mentionsView.position;
- model.change( writer => {
- writer.insertText( 't', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- sinon.assert.calledTwice( pinSpy );
- const pinArgument = pinSpy.secondCall.args[ 0 ];
- const { positions } = pinArgument;
- expect( positions, 'should reuse first matched position' ).to.have.length( 1 );
- expect( positions[ 0 ].name ).to.equal( positionAfterFirstShow );
- } );
- } );
- it( 'does not fail if selection has no #editableElement', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- stubSelectionRects( [ caretRect ] );
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- const pinArgument = pinSpy.firstCall.args[ 0 ];
- const { limiter } = pinArgument;
- sinon.stub( editingView.document.selection, 'editableElement' ).value( null );
- // Should not break;
- expect( limiter() ).to.be.null;
- } );
- } );
- } );
- describe( 'typing integration', () => {
- it( 'should show panel for matched marker after typing minimum characters', () => {
- return createClassicTestEditor( { feeds: [ Object.assign( { minimumCharacters: 2 }, staticConfig.feeds[ 0 ] ) ] } )
- .then( () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( () => {
- model.change( writer => {
- writer.insertText( 'B', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } )
- .then( waitForDebounce )
- .then( () => {
- model.change( writer => {
- writer.insertText( 'a', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 1 );
- model.change( writer => {
- writer.insertText( 'r', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 1 );
- } );
- } );
- it( 'should update the marker if the selection was moved from one valid position to another', () => {
- const spy = sinon.spy();
- return createClassicTestEditor( staticConfig )
- .then( () => {
- setData( model, '<paragraph>foo @ bar []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- } )
- .then( () => {
- editor.model.markers.on( 'update', spy );
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 5 );
- } );
- sinon.assert.calledOnce( spy );
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- } );
- } );
- it( 'should not show panel when command is disabled', () => {
- return createClassicTestEditor( staticConfig )
- .then( () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- const mentionCommand = editor.commands.get( 'mention' );
- mentionCommand.forceDisabled( 'mentionCommandDisableTest' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- describe( 'static list with large set of results', () => {
- const bigList = {
- marker: '@',
- feed: [
- '@a01', '@a02', '@a03', '@a04', '@a05', '@a06', '@a07', '@a08', '@a09', '@a10', '@a11', '@a12'
- ]
- };
- beforeEach( () => {
- return createClassicTestEditor( { feeds: [ bigList ] } );
- } );
- it( 'should show panel with no more then 10 items for default static feed', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( mentionsView.items ).to.have.length( 10 );
- } );
- } );
- it( 'should scroll mention panel to the selected item', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- const arrowDownEvtData = {
- keyCode: keyCodes.arrowdown,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- const arrowUpEvtData = {
- keyCode: keyCodes.arrowup,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- return waitForDebounce()
- .then( () => {
- // The scroll test highly depends on browser styles.
- // Some CI test environments might not load theme which will result that tests will not render on CI as locally.
- // To make this test repeatable across different environments it enforces mentions view size to 100px...
- const reset = 'padding:0px;margin:0px;border:0 none;line-height: 1em;';
- const mentionElementSpy = testUtils.sinon.spy( mentionsView.element, 'scrollTop', [ 'set' ] );
- mentionsView.element.style = `min-height:100px;height:100px;max-height:100px;${ reset };`;
- // ...and each list view item size to 25px...
- Array.from( mentionsView.items ).forEach( item => {
- const listItemElement = item.children.get( 0 ).element;
- listItemElement.style = `min-height:unset;height:25px;max-height:25px;${ reset };min-width:12em;`;
- } );
- // ...so after those changes it is safe to assume that:
- // - base offset is 0
- // - only 4 items are visible at once
- // - if scrolled to the last element scrollTop will be set to 150px. The 150px is the offset of the 7th item in the
- // list as last four (7, 8, 9 & 10) will be visible.
- expect( panelView.isVisible ).to.be.true;
- expectChildViewsIsOnState( [ true, false, false, false, false, false, false, false, false, false ] );
- sinon.assert.callCount( mentionElementSpy.set, 0 );
- fireKeyDownEvent( arrowDownEvtData );
- expectChildViewsIsOnState( [ false, true, false, false, false, false, false, false, false, false ] );
- expect( mentionsView.element.scrollTop ).to.equal( 0 );
- sinon.assert.callCount( mentionElementSpy.set, 0 );
- fireKeyDownEvent( arrowUpEvtData );
- expectChildViewsIsOnState( [ true, false, false, false, false, false, false, false, false, false ] );
- expect( mentionsView.element.scrollTop ).to.equal( 0 );
- sinon.assert.callCount( mentionElementSpy.set, 0 );
- fireKeyDownEvent( arrowUpEvtData );
- expectChildViewsIsOnState( [ false, false, false, false, false, false, false, false, false, true ] );
- // We want 150, but sometimes we get e.g. 151.
- expect( mentionsView.element.scrollTop ).to.be.within( 140, 160, 'last item highlighted' );
- sinon.assert.callCount( mentionElementSpy.set, 1 );
- fireKeyDownEvent( arrowDownEvtData );
- expectChildViewsIsOnState( [ true, false, false, false, false, false, false, false, false, false ] );
- // We want 0, but sometimes we get e.g. 1. (Firefox)
- expect( mentionsView.element.scrollTop ).to.be.within( 0, 10 );
- sinon.assert.callCount( mentionElementSpy.set, 2 );
- } );
- } );
- } );
- describe( 'ES2018 RegExp Unicode property escapes fallback', () => {
- let regExpStub;
- // Cache the original value to restore it after the tests.
- const originalGroupSupport = env.features.isRegExpUnicodePropertySupported;
- before( () => {
- env.features.isRegExpUnicodePropertySupported = false;
- } );
- beforeEach( () => {
- return createClassicTestEditor( staticConfig )
- .then( editor => {
- regExpStub = sinon.stub( window, 'RegExp' );
- return editor;
- } );
- } );
- after( () => {
- env.features.isRegExpUnicodePropertySupported = originalGroupSupport;
- } );
- it( 'returns a simplified RegExp for browsers not supporting Unicode punctuation groups', () => {
- env.features.isRegExpUnicodePropertySupported = false;
- createRegExp( '@', 2 );
- sinon.assert.calledOnce( regExpStub );
- sinon.assert.calledWithExactly( regExpStub, '(?:^|[ \\(\\[{"\'])([@])([\\S]{2,})$', 'u' );
- } );
- it( 'returns a ES2018 RegExp for browsers supporting Unicode punctuation groups', () => {
- env.features.isRegExpUnicodePropertySupported = true;
- createRegExp( '@', 2 );
- sinon.assert.calledOnce( regExpStub );
- sinon.assert.calledWithExactly( regExpStub, '(?:^|[ \\p{Ps}\\p{Pi}"\'])([@])([\\S]{2,})$', 'u' );
- } );
- } );
- describe( 'static list with default trigger', () => {
- beforeEach( () => {
- return createClassicTestEditor( staticConfig );
- } );
- it( 'should show panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 5 );
- } );
- } );
- it( 'should show panel for matched marker at the beginning of paragraph', () => {
- setData( model, '<paragraph>[] foo</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 5 );
- } );
- } );
- it( 'should show panel for matched marker after a <softBreak>', () => {
- model.schema.register( 'softBreak', {
- allowWhere: '$text',
- isInline: true
- } );
- editor.conversion.for( 'upcast' )
- .elementToElement( {
- model: 'softBreak',
- view: 'br'
- } );
- editor.conversion.for( 'downcast' )
- .elementToElement( {
- model: 'softBreak',
- view: ( modelElement, { writer } ) => writer.createEmptyElement( 'br' )
- } );
- setData( model, '<paragraph>abc<softBreak></softBreak>[] foo</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 5 );
- } );
- } );
- // Opening parenthesis type characters that should be supported on all environments.
- for ( const character of [ '(', '\'', '"', '[', '{' ] ) {
- testOpeningPunctuationCharacter( character );
- }
- // Excerpt of opening parenthesis type characters that tests ES2018 Unicode property escapes on supported environment.
- for ( const character of [
- // Belongs to Ps (Punctuation, Open) group:
- '〈', '„', '﹛', '⦅', '{',
- // Belongs to Pi (Punctuation, Initial quote) group:
- '«', '‹', '⸌', ' ⸂', '⸠'
- ] ) {
- testOpeningPunctuationCharacter( character, !env.features.isRegExpUnicodePropertySupported );
- }
- it( 'should not show panel for marker in the middle of other word', () => {
- setData( model, '<paragraph>foo[]</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should not show panel when selection is inside a mention', () => {
- setData( model, '<paragraph>foo @Lily bar[]</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionAt( doc.getRoot().getChild( 0 ), 4 ),
- writer.createPositionAt( doc.getRoot().getChild( 0 ), 9 )
- );
- writer.setAttribute( 'mention', { id: '@Lily', uid: 1234 }, range );
- } );
- return waitForDebounce()
- .then( () => {
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 0 );
- } );
- expect( panelView.isVisible ).to.be.false;
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 7 );
- } );
- } )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should not show panel when selection is at the end of a mention', () => {
- setData( model, '<paragraph>foo @Lily bar[]</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionAt( doc.getRoot().getChild( 0 ), 4 ),
- writer.createPositionAt( doc.getRoot().getChild( 0 ), 9 )
- );
- writer.setAttribute( 'mention', { id: '@Lily', uid: 1234 }, range );
- } );
- return waitForDebounce()
- .then( () => {
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 9 );
- } );
- } )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should not show panel when selection is not collapsed', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- model.change( () => {
- model.modifySelection( doc.selection, { direction: 'backward', unit: 'character' } );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should not show panel when selection is changing (non-collapsed)', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- model.change( () => {
- model.modifySelection( doc.selection, { direction: 'backward', unit: 'character' } );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } )
- .then( () => {
- model.change( () => {
- model.modifySelection( doc.selection, { direction: 'backward', unit: 'character' } );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should not show panel when selection is after existing mention', () => {
- setData( model, '<paragraph>foo [@Lily] bar[]</paragraph>' );
- model.change( writer => {
- writer.setAttribute( 'mention', { id: '@Lily', uid: 1234 }, doc.selection.getFirstRange() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 8 );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- } );
- } );
- it( 'should not show panel when selection moves inside existing mention', () => {
- setData( model, '<paragraph>foo @Lily bar[]</paragraph>' );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionAt( doc.getRoot().getChild( 0 ), 4 ),
- writer.createPositionAt( doc.getRoot().getChild( 0 ), 9 )
- );
- writer.setAttribute( 'mention', { id: '@Lily', uid: 1234 }, range );
- } );
- return waitForDebounce()
- .then( () => {
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 9 );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 8 );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- } );
- } );
- it( 'should show filtered results for matched text', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- model.change( writer => {
- writer.insertText( 'T', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 1 );
- } );
- } );
- it( 'should focus the first item in panel', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- const button = mentionsView.items.get( 0 ).children.get( 0 );
- expect( button.isOn ).to.be.true;
- } );
- } );
- it( 'should hide panel if no matched items', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => expect( panelView.isVisible ).to.be.true )
- .then( () => {
- model.change( writer => {
- writer.insertText( 'x', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- expect( mentionsView.items ).to.have.length( 0 );
- } );
- } );
- it( 'should hide panel when text was unmatched', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => expect( panelView.isVisible ).to.be.true )
- .then( () => {
- model.change( writer => {
- const end = doc.selection.getFirstPosition();
- const start = end.getShiftedBy( -1 );
- writer.remove( writer.createRange( start, end ) );
- } );
- } )
- .then( waitForDebounce )
- .then( () => expect( panelView.isVisible ).to.be.false );
- } );
- } );
- describe( 'unicode', () => {
- beforeEach( () => {
- return createClassicTestEditor( {
- feeds: [
- {
- // Always return 5 items
- feed: [ '@תַפּוּחַ', '@אַגָס', '@apple', '@pear' ],
- marker: '@'
- }
- ]
- } );
- } );
- it( 'should open panel for unicode character ב', function() {
- if ( !env.features.isRegExpUnicodePropertySupported ) {
- this.skip();
- }
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@ס', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible, 'panel is visible' ).to.be.true;
- expect( editor.model.markers.has( 'mention' ), 'marker is inserted' ).to.be.true;
- expect( mentionsView.items ).to.have.length( 1 );
- } );
- } );
- } );
- describe( 'callback function using data from editor', () => {
- beforeEach( () => {
- return createClassicTestEditor( {
- feeds: [
- {
- marker: '#',
- feed() {
- expect( this ).to.equal( editor );
- return Promise.resolve( [ 'foo', 'bar' ] );
- }
- }
- ]
- } );
- } );
- it( 'should bind the instance panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 2 );
- } );
- } );
- } );
- describe( 'asynchronous list with custom trigger', () => {
- const issuesNumbers = [ '#100', '#101', '#102', '#103' ];
- let feedCallbackStub, feedCallbackTimeout, feedCallbackCallTimes;
- beforeEach( () => {
- feedCallbackTimeout = 20;
- feedCallbackCallTimes = 0;
- function feedCallback( feedText ) {
- return new Promise( resolve => {
- setTimeout( () => {
- feedCallbackCallTimes++;
- resolve( issuesNumbers.filter( number => number.includes( feedText ) ) );
- }, feedCallbackTimeout );
- } );
- }
- feedCallbackStub = testUtils.sinon.stub().callsFake( feedCallback );
- return createClassicTestEditor( {
- feeds: [
- {
- marker: '#',
- feed: feedCallbackStub
- }
- ]
- } );
- } );
- it( 'should show panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 4 );
- } );
- } );
- it( 'should fire requestFeed:response when request feed return a response', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- const eventSpy = sinon.spy();
- mentionUI.on( 'requestFeed:response', eventSpy );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- sinon.assert.calledOnce( eventSpy );
- sinon.assert.calledWithExactly(
- eventSpy,
- sinon.match.any,
- {
- feed: issuesNumbers,
- marker: '#',
- feedText: ''
- }
- );
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 4 );
- } );
- } );
- it( 'should show filtered results for matched text', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- model.change( writer => {
- writer.insertText( '2', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 1 );
- } );
- } );
- it( 'should hide panel if no matched items', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => expect( panelView.isVisible ).to.be.true )
- .then( () => {
- model.change( writer => {
- writer.insertText( 'x', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- expect( mentionsView.items ).to.have.length( 0 );
- } );
- } );
- it( 'should hide panel when text was unmatched', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => expect( panelView.isVisible ).to.be.true )
- .then( () => {
- model.change( writer => {
- const end = doc.selection.getFirstPosition();
- const start = end.getShiftedBy( -1 );
- writer.remove( writer.createRange( start, end ) );
- } );
- } )
- .then( waitForDebounce )
- .then( () => expect( panelView.isVisible ).to.be.false );
- } );
- it( 'should show panel debounced', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- sinon.assert.notCalled( feedCallbackStub );
- return Promise.resolve()
- .then( wait( 20 ) )
- .then( () => {
- sinon.assert.notCalled( feedCallbackStub );
- model.change( writer => {
- writer.insertText( '1', doc.selection.getFirstPosition() );
- } );
- } )
- .then( wait( 20 ) )
- .then( () => {
- sinon.assert.notCalled( feedCallbackStub );
- model.change( writer => {
- writer.insertText( '0', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- sinon.assert.calledOnce( feedCallbackStub );
- // Should be called with all typed letters before debounce.
- sinon.assert.calledWithExactly( feedCallbackStub, '10' );
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 4 );
- } );
- } );
- it( 'should discard requested feed if they came out of order', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- sinon.assert.notCalled( feedCallbackStub );
- const panelShowSpy = sinon.spy( panelView, 'show' );
- // Increase the response time to extend the debounce time out.
- feedCallbackTimeout = 300;
- return Promise.resolve()
- .then( wait( 20 ) )
- .then( () => {
- sinon.assert.notCalled( feedCallbackStub );
- model.change( writer => {
- writer.insertText( '1', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- sinon.assert.calledOnce( feedCallbackStub );
- sinon.assert.calledWithExactly( feedCallbackStub, '1' );
- expect( panelView.isVisible, 'panel is hidden' ).to.be.false;
- expect( editor.model.markers.has( 'mention' ), 'marker is inserted' ).to.be.true;
- // Make second callback resolve before first.
- feedCallbackTimeout = 50;
- model.change( writer => {
- writer.insertText( '0', doc.selection.getFirstPosition() );
- } );
- } )
- .then( wait( 300 ) ) // Wait longer so the longer callback will be resolved.
- .then( () => {
- sinon.assert.calledTwice( feedCallbackStub );
- sinon.assert.calledWithExactly( feedCallbackStub.getCall( 1 ), '10' );
- sinon.assert.calledOnce( panelShowSpy );
- expect( feedCallbackCallTimes ).to.equal( 2 );
- expect( panelView.isVisible, 'panel is visible' ).to.be.true;
- expect( editor.model.markers.has( 'mention' ), 'marker is inserted' ).to.be.true;
- expect( mentionsView.items ).to.have.length( 4 );
- } );
- } );
- it( 'should fire requestFeed:discarded event when requested feed came out of order', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- sinon.assert.notCalled( feedCallbackStub );
- const panelShowSpy = sinon.spy( panelView, 'show' );
- const eventSpy = sinon.spy();
- mentionUI.on( 'requestFeed:discarded', eventSpy );
- // Increase the response time to extend the debounce time out.
- feedCallbackTimeout = 300;
- return Promise.resolve()
- .then( wait( 20 ) )
- .then( () => {
- sinon.assert.notCalled( feedCallbackStub );
- model.change( writer => {
- writer.insertText( '1', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- sinon.assert.calledOnce( feedCallbackStub );
- sinon.assert.calledWithExactly( feedCallbackStub, '1' );
- expect( panelView.isVisible, 'panel is hidden' ).to.be.false;
- expect( editor.model.markers.has( 'mention' ), 'marker is inserted' ).to.be.true;
- // Make second callback resolve before first.
- feedCallbackTimeout = 50;
- model.change( writer => {
- writer.insertText( '0', doc.selection.getFirstPosition() );
- } );
- } )
- .then( wait( 300 ) ) // Wait longer so the longer callback will be resolved.
- .then( () => {
- sinon.assert.calledTwice( feedCallbackStub );
- sinon.assert.calledWithExactly( feedCallbackStub.getCall( 1 ), '10' );
- sinon.assert.calledOnce( panelShowSpy );
- sinon.assert.calledOnce( eventSpy );
- sinon.assert.calledWithExactly(
- eventSpy,
- sinon.match.any,
- {
- feed: issuesNumbers,
- marker: '#',
- feedText: '1'
- }
- );
- expect( feedCallbackCallTimes ).to.equal( 2 );
- expect( panelView.isVisible, 'panel is visible' ).to.be.true;
- expect( editor.model.markers.has( 'mention' ), 'marker is inserted' ).to.be.true;
- expect( mentionsView.items ).to.have.length( 4 );
- } );
- } );
- it( 'should discard requested feed if mention UI is hidden', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- sinon.assert.notCalled( feedCallbackStub );
- feedCallbackTimeout = 200;
- return Promise.resolve()
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false; // Should be still hidden;
- // Should be called with empty string.
- sinon.assert.calledWithExactly( feedCallbackStub, '' );
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 0 );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should fire requestFeed:error and log warning if requested feed failed', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- feedCallbackStub.returns( Promise.reject( 'Request timeout' ) );
- const warnSpy = sinon.stub( console, 'warn' );
- const eventSpy = sinon.spy();
- mentionUI.on( 'requestFeed:error', eventSpy );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible, 'panel is hidden' ).to.be.false;
- expect( editor.model.markers.has( 'mention' ), 'there is no marker' ).to.be.false;
- sinon.assert.calledWithExactly(
- warnSpy,
- sinon.match( /^mention-feed-callback-error/ ),
- sinon.match( { marker: '#' } ),
- sinon.match.string // Link to the documentation
- );
- sinon.assert.calledOnce( eventSpy );
- } );
- } );
- it( 'should not fail if marker was removed', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- const selectFirstMentionSpy = sinon.spy( mentionsView, 'selectFirst' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- sinon.assert.notCalled( feedCallbackStub );
- // Increase the response time to extend the debounce time out.
- feedCallbackTimeout = 500;
- return Promise.resolve()
- .then( waitForDebounce )
- .then( wait( 20 ) )
- .then( () => {
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 2 );
- } );
- } )
- .then( wait( 20 ) )
- .then( () => {
- feedCallbackTimeout = 1000;
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 'end' );
- } );
- } )
- .then( wait( 500 ) )
- .then( () => {
- expect( panelView.isVisible, 'panel is visible' ).to.be.true;
- // If there were any errors this will not get called.
- // The errors might come from unhandled promise rejections errors.
- sinon.assert.calledOnce( selectFirstMentionSpy );
- } );
- } );
- it( 'should not show panel if selection was moved during fetching a feed', () => {
- setData( model, '<paragraph>foo [#101] bar</paragraph><paragraph></paragraph>' );
- model.change( writer => {
- writer.setAttribute( 'mention', { id: '#101', uid: 1234 }, doc.selection.getFirstRange() );
- } );
- // Increase the response time to extend the debounce time out.
- feedCallbackTimeout = 300;
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 1 ), 0 );
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- sinon.assert.notCalled( feedCallbackStub );
- return Promise.resolve()
- .then( waitForDebounce )
- .then( () => {
- sinon.assert.calledOnce( feedCallbackStub );
- model.change( writer => {
- writer.setSelection( doc.getRoot().getChild( 0 ), 6 );
- } );
- expect( panelView.isVisible ).to.be.false;
- } )
- .then( waitForDebounce )
- .then( wait( 20 ) )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- } );
- function testOpeningPunctuationCharacter( character, skip = false ) {
- it( `should show panel for matched marker after a "${ character }" character`, function() {
- if ( skip ) {
- this.skip();
- }
- setData( model, '<paragraph>[] foo</paragraph>' );
- model.change( writer => {
- writer.insertText( character, doc.selection.getFirstPosition() );
- } );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible, 'panel is visible' ).to.be.true;
- expect( editor.model.markers.has( 'mention' ), 'marker is inserted' ).to.be.true;
- expect( mentionsView.items ).to.have.length( 5 );
- } );
- } );
- }
- } );
- describe( 'panel behavior', () => {
- it( 'should close the opened panel on esc', () => {
- return createClassicTestEditor( staticConfig )
- .then( () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- fireKeyDownEvent( {
- keyCode: keyCodes.esc,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- } );
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should close the opened panel when click outside the panel', () => {
- return createClassicTestEditor( staticConfig )
- .then( () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- document.body.dispatchEvent( new Event( 'mousedown', { bubbles: true } ) );
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should hide the panel on selection change', () => {
- return createClassicTestEditor( staticConfig )
- .then( () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- model.change( writer => {
- // Place position at the beginning of a paragraph.
- writer.setSelection( doc.getRoot().getChild( 0 ), 0 );
- } );
- expect( panelView.isVisible ).to.be.false;
- expect( mentionsView.position ).to.be.undefined;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should hide the panel on selection change triggered by mouse click', () => {
- return createClassicTestEditor( staticConfig )
- .then( () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- // This happens when user clicks outside the panel view and selection is changed.
- // Two panel closing mechanisms are run:
- // - clickOutsideHandler
- // - unmatched text in text watcher
- // which may fail when trying to remove mention marker twice.
- document.body.dispatchEvent( new Event( 'mousedown', { bubbles: true } ) );
- model.change( writer => {
- // Place position at the beginning of a paragraph.
- writer.setSelection( doc.getRoot().getChild( 0 ), 0 );
- } );
- expect( panelView.isVisible ).to.be.false;
- expect( mentionsView.position ).to.be.undefined;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- describe( 'default list item', () => {
- // Create map of expected feed items as objects as they will be stored internally.
- const feedItems = staticConfig.feeds[ 0 ].feed.map( text => ( { text: `${ text }`, id: `${ text }` } ) );
- beforeEach( () => {
- return createClassicTestEditor( staticConfig );
- } );
- describe( 'on arrows', () => {
- it( 'should cycle down on arrow down', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- const keyEvtData = {
- keyCode: keyCodes.arrowdown,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, true, false, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, true, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, true, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, false, true ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- } );
- } );
- it( 'should cycle up on arrow up', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- const keyEvtData = {
- keyCode: keyCodes.arrowup,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, false, true ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, true, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, true, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, true, false, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- } );
- } );
- it( 'should not cycle with only one item in the list', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- const keyDownEvtData = {
- keyCode: keyCodes.arrowdown,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- const keyUpEvtData = {
- keyCode: keyCodes.arrowdown,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- model.change( writer => {
- writer.insertText( '@T', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true ] );
- fireKeyDownEvent( keyDownEvtData );
- expectChildViewsIsOnState( [ true ] );
- fireKeyDownEvent( keyUpEvtData );
- expectChildViewsIsOnState( [ true ] );
- } );
- } );
- } );
- describe( 'on "execute" keys', () => {
- testExecuteKey( 'enter', keyCodes.enter, feedItems );
- testExecuteKey( 'tab', keyCodes.tab, feedItems );
- } );
- describe( 'on other keys', () => {
- it( 'should do nothing on space', async () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- const command = editor.commands.get( 'mention' );
- const spy = testUtils.sinon.spy( command, 'execute' );
- await waitForDebounce();
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- fireKeyDownEvent( {
- keyCodes: keyCodes.space,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- } );
- sinon.assert.notCalled( spy );
- } );
- } );
- } );
- describe( 'default list item with custom feed', () => {
- const issues = [
- { id: '@Ted' },
- { id: '@Barney' },
- { id: '@Robin' },
- { id: '@Lily' },
- { id: '@Marshal' }
- ];
- beforeEach( () => {
- return createClassicTestEditor( {
- feeds: [
- {
- marker: '@',
- feed: feedText => issues.filter( issue => issue.id.includes( feedText ) )
- }
- ]
- } );
- } );
- it( 'should show panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 5 );
- } );
- } );
- } );
- describe( 'custom list item (string)', () => {
- const issues = [
- { id: '@1002', title: 'Some bug in editor.' },
- { id: '@1003', title: 'Introduce this feature.' },
- { id: '@1004', title: 'Missing docs.' },
- { id: '@1005', title: 'Another bug.' },
- { id: '@1006', title: 'More bugs' }
- ];
- beforeEach( () => {
- return createClassicTestEditor( {
- feeds: [
- {
- marker: '@',
- feed: issues,
- itemRenderer: item => item.title
- }
- ]
- } );
- } );
- it( 'should show panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 5 );
- } );
- } );
- describe( 'keys', () => {
- describe( 'on arrows', () => {
- it( 'should cycle down on arrow down', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- const keyEvtData = {
- keyCode: keyCodes.arrowdown,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, true, false, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, true, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, true, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, false, true ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- } );
- } );
- it( 'should cycle up on arrow up', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- const keyEvtData = {
- keyCode: keyCodes.arrowup,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, false, true ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, true, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, true, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, true, false, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- } );
- } );
- } );
- describe( 'on "execute" keys', () => {
- testExecuteKey( 'enter', keyCodes.enter, issues );
- testExecuteKey( 'tab', keyCodes.tab, issues );
- } );
- } );
- } );
- describe( 'custom list item (DOM Element)', () => {
- const issues = [
- { id: '@1002', title: 'Some bug in editor.' },
- { id: '@1003', title: 'Introduce this feature.' },
- { id: '@1004', title: 'Missing docs.' },
- { id: '@1005', title: 'Another bug.' },
- { id: '@1006', title: 'More bugs' }
- ];
- beforeEach( () => {
- return createClassicTestEditor( {
- feeds: [
- {
- marker: '@',
- feed: feedText => {
- return Promise.resolve( issues.filter( issue => issue.id.includes( feedText ) ) );
- },
- itemRenderer: item => {
- const span = global.document.createElementNS( 'http://www.w3.org/1999/xhtml', 'span' );
- span.innerHTML = `<span id="issue-${ item.id.slice( 1 ) }">@${ item.title }</span>`;
- return span;
- }
- }
- ]
- } );
- } );
- it( 'should show panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 5 );
- } );
- } );
- describe( 'keys', () => {
- describe( 'on arrows', () => {
- it( 'should cycle down on arrow down', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- const keyEvtData = {
- keyCode: keyCodes.arrowdown,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, true, false, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, true, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, true, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, false, true ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- } );
- } );
- it( 'should cycle up on arrow up', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- const keyEvtData = {
- keyCode: keyCodes.arrowup,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, false, true ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, false, true, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, false, true, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ false, true, false, false, false ] );
- fireKeyDownEvent( keyEvtData );
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- } );
- } );
- } );
- describe( 'on "execute" keys', () => {
- testExecuteKey( 'enter', keyCodes.enter, issues );
- testExecuteKey( 'tab', keyCodes.tab, issues );
- } );
- describe( 'mouse', () => {
- it( 'should execute selected button on mouse click', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- const command = editor.commands.get( 'mention' );
- const spy = testUtils.sinon.spy( command, 'execute' );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- const element = panelView.element.querySelector( '#issue-1004' );
- element.dispatchEvent( new Event( 'click', { bubbles: true } ) );
- sinon.assert.calledOnce( spy );
- const commandOptions = spy.getCall( 0 ).args[ 0 ];
- const item = issues[ 2 ];
- expect( commandOptions ).to.have.property( 'mention' ).that.deep.equal( item );
- expect( commandOptions ).to.have.property( 'marker', '@' );
- expect( commandOptions ).to.have.property( 'range' );
- const start = model.createPositionAt( doc.getRoot().getChild( 0 ), 4 );
- const expectedRange = model.createRange( start, start.getShiftedBy( 1 ) );
- expect( commandOptions.range.isEqual( expectedRange ) ).to.be.true;
- } );
- } );
- } );
- } );
- } );
- describe( 'multiple feeds configuration', () => {
- beforeEach( () => {
- return createClassicTestEditor( {
- feeds: [
- {
- marker: '@',
- feed: [ '@a1', '@a2', '@a3' ]
- },
- {
- marker: '$',
- feed: [
- '$a1', '$a2', '$a3', '$a4',
- // A case of mention with a marker character from other feed. See #6398.
- '$a@'
- ]
- }
- ]
- } );
- } );
- it( 'should show panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 3 );
- mentionsView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- model.change( writer => {
- writer.insertText( '$', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 5 );
- mentionsView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 3 );
- } );
- } );
- it( 'should show panel for matched marker if it contains the other configured marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- expect( mentionsView.items ).to.have.length( 3 );
- mentionsView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- model.change( writer => {
- writer.insertText( '$a', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- } );
- } );
- } );
- function testExecuteKey( name, keyCode, feedItems ) {
- it( 'should execute selected button on ' + name, () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- const command = editor.commands.get( 'mention' );
- const spy = testUtils.sinon.spy( command, 'execute' );
- return waitForDebounce()
- .then( () => {
- expectChildViewsIsOnState( [ true, false, false, false, false ] );
- fireKeyDownEvent( {
- keyCode: keyCodes.arrowup,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- } );
- expectChildViewsIsOnState( [ false, false, false, false, true ] );
- fireKeyDownEvent( {
- keyCode,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- } );
- sinon.assert.calledOnce( spy );
- assertCommandOptions( spy.getCall( 0 ).args[ 0 ], '@', feedItems[ 4 ] );
- const start = model.createPositionAt( doc.getRoot().getChild( 0 ), 4 );
- const expectedRange = model.createRange( start, start.getShiftedBy( 1 ) );
- expect( spy.getCall( 0 ).args[ 0 ].range.isEqual( expectedRange ) ).to.be.true;
- } );
- } );
- it( 'should do nothing if panel is not visible on ' + name, () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- const command = editor.commands.get( 'mention' );
- const spy = testUtils.sinon.spy( command, 'execute' );
- return waitForDebounce()
- .then( () => {
- expect( panelView.isVisible ).to.be.true;
- expect( editor.model.markers.has( 'mention' ) ).to.be.true;
- fireKeyDownEvent( {
- keyCode: keyCodes.esc,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- } );
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- fireKeyDownEvent( {
- keyCode,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- } );
- sinon.assert.notCalled( spy );
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- }
- } );
- describe( 'execute', () => {
- beforeEach( () => createClassicTestEditor( staticConfig ) );
- it( 'should call the mention command with proper options', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- const command = editor.commands.get( 'mention' );
- const spy = testUtils.sinon.spy( command, 'execute' );
- return waitForDebounce()
- .then( () => {
- mentionsView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
- sinon.assert.calledOnce( spy );
- const commandOptions = spy.getCall( 0 ).args[ 0 ];
- assertCommandOptions( commandOptions, '@', { id: '@Barney', text: '@Barney' } );
- const start = model.createPositionAt( doc.getRoot().getChild( 0 ), 4 );
- const expectedRange = model.createRange( start, start.getShiftedBy( 1 ) );
- expect( commandOptions.range.isEqual( expectedRange ) ).to.be.true;
- } );
- } );
- it( 'should hide panel on execute', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- mentionsView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
- expect( panelView.isVisible ).to.be.false;
- expect( editor.model.markers.has( 'mention' ) ).to.be.false;
- } );
- } );
- it( 'should focus view after command execution', () => {
- const focusSpy = testUtils.sinon.spy( editor.editing.view, 'focus' );
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- mentionsView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
- sinon.assert.calledOnce( focusSpy );
- } );
- } );
- } );
- function createClassicTestEditor( mentionConfig ) {
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ Paragraph, MentionEditing, MentionUI ],
- mention: mentionConfig
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- doc = model.document;
- editingView = editor.editing.view;
- mentionUI = editor.plugins.get( MentionUI );
- panelView = editor.plugins.get( ContextualBalloon ).view;
- mentionsView = mentionUI._mentionsView;
- } );
- }
- function wait( timeout ) {
- return () => new Promise( resolve => {
- setTimeout( () => {
- resolve();
- }, timeout );
- } );
- }
- function waitForDebounce() {
- return wait( 180 )();
- }
- function fireKeyDownEvent( options ) {
- const eventInfo = new EventInfo( editingView.document, 'keydown' );
- const eventData = new DomEventData( editingView.document, {
- target: document.body
- }, options );
- editingView.document.fire( eventInfo, eventData );
- }
- function stubSelectionRects( rects ) {
- const originalViewRangeToDom = editingView.domConverter.viewRangeToDom;
- // Mock selection rect.
- sinon.stub( editingView.domConverter, 'viewRangeToDom' ).callsFake( ( ...args ) => {
- const domRange = originalViewRangeToDom.apply( editingView.domConverter, args );
- sinon.stub( domRange, 'getClientRects' )
- .returns( rects );
- return domRange;
- } );
- }
- function expectChildViewsIsOnState( expectedState ) {
- const childViews = [ ...mentionsView.items ].map( item => item.children.get( 0 ) );
- expect( childViews.map( child => child.isOn ) ).to.deep.equal( expectedState );
- }
- function assertCommandOptions( commandOptions, marker, item ) {
- expect( commandOptions ).to.have.property( 'marker', marker );
- expect( commandOptions ).to.have.property( 'range' );
- expect( commandOptions ).to.have.property( 'mention' );
- const mentionForCommand = commandOptions.mention;
- for ( const key of Object.keys( item ) ) {
- expect( mentionForCommand[ key ] ).to.equal( item[ key ] );
- }
- }
- } );
|