| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332 |
- /**
- * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /* global window, document, setTimeout */
- 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 BalloonPanelView from '@ckeditor/ckeditor5-ui/src/panel/balloon/balloonpanelview';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import MentionUI from '../src/mentionui';
- import MentionEditing from '../src/mentionediting';
- import MentionsView from '../src/ui/mentionsview';
- import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- describe( 'BalloonToolbar', () => {
- let editor, model, doc, editingView, mentionUI, editorElement;
- const staticConfig = [
- { feed: [ 'Barney', 'Lily', 'Marshall', 'Robin', 'Ted' ] }
- ];
- testUtils.createSinonSandbox();
- beforeEach( () => {
- editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- } );
- afterEach( () => {
- sinon.restore();
- editorElement.remove();
- return editor.destroy();
- } );
- it( 'should create a plugin instance', () => {
- return createClassicTestEditor().then( () => {
- expect( mentionUI ).to.instanceOf( Plugin );
- expect( mentionUI ).to.instanceOf( MentionUI );
- } );
- } );
- describe( 'pluginName', () => {
- it( 'should return plugin by its name', () => {
- return createClassicTestEditor().then( () => {
- expect( editor.plugins.get( 'MentionUI' ) ).to.equal( mentionUI );
- } );
- } );
- } );
- describe( 'child views', () => {
- beforeEach( () => createClassicTestEditor() );
- describe( 'panelView', () => {
- it( 'should create a view instance', () => {
- expect( mentionUI.panelView ).to.instanceof( BalloonPanelView );
- } );
- it( 'should be added to the ui.view.body collection', () => {
- expect( Array.from( editor.ui.view.body ) ).to.include( mentionUI.panelView );
- } );
- it( 'should have disabled arrow', () => {
- expect( mentionUI.panelView.withArrow ).to.be.false;
- } );
- it( 'should have added MentionView as a child', () => {
- expect( mentionUI.panelView.content.get( 0 ) ).to.be.instanceof( MentionsView );
- } );
- } );
- } );
- describe( 'typing integration', () => {
- describe( 'static list with default trigger', () => {
- beforeEach( () => {
- return createClassicTestEditor( staticConfig );
- } );
- it( 'should show panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( mentionUI.panelView.isVisible ).to.be.true;
- expect( mentionUI._mentionsView.listView.items ).to.have.length( 5 );
- } );
- } );
- 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( mentionUI.panelView.isVisible ).to.be.true;
- expect( mentionUI._mentionsView.listView.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( mentionUI.panelView.isVisible ).to.be.true )
- .then( () => {
- model.change( writer => {
- writer.insertText( 'x', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( mentionUI.panelView.isVisible ).to.be.false;
- expect( mentionUI._mentionsView.listView.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( mentionUI.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( mentionUI.panelView.isVisible ).to.be.false );
- } );
- } );
- describe( 'asynchronous list with custom trigger', () => {
- beforeEach( () => {
- const issuesNumbers = [ '100', '101', '102', '103' ];
- return createClassicTestEditor( [
- {
- marker: '#',
- feed: feedText => {
- return new Promise( resolve => {
- setTimeout( () => {
- resolve( issuesNumbers.filter( number => number.includes( feedText ) ) );
- }, 20 );
- } );
- }
- }
- ] );
- } );
- it( 'should show panel for matched marker', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '#', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- expect( mentionUI.panelView.isVisible ).to.be.true;
- expect( mentionUI._mentionsView.listView.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( mentionUI.panelView.isVisible ).to.be.true;
- expect( mentionUI._mentionsView.listView.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( mentionUI.panelView.isVisible ).to.be.true )
- .then( () => {
- model.change( writer => {
- writer.insertText( 'x', doc.selection.getFirstPosition() );
- } );
- } )
- .then( waitForDebounce )
- .then( () => {
- expect( mentionUI.panelView.isVisible ).to.be.false;
- expect( mentionUI._mentionsView.listView.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( mentionUI.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( mentionUI.panelView.isVisible ).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( () => {
- mentionUI._mentionsView.listView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
- sinon.assert.calledOnce( spy );
- const commandOptions = spy.getCall( 0 ).args[ 0 ];
- expect( commandOptions ).to.have.property( 'mention', 'Barney' );
- 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;
- } );
- } );
- it( 'should hide panel on execute', () => {
- setData( model, '<paragraph>foo []</paragraph>' );
- model.change( writer => {
- writer.insertText( '@', doc.selection.getFirstPosition() );
- } );
- return waitForDebounce()
- .then( () => {
- mentionUI._mentionsView.listView.items.get( 0 ).children.get( 0 ).fire( 'execute' );
- expect( mentionUI.panelView.isVisible ).to.be.false;
- } );
- } );
- } );
- 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 );
- editingView.attachDomRoot( editorElement );
- // Focus the engine.
- editingView.document.isFocused = true;
- editingView.getDomRoot().focus();
- // Remove all selection ranges from DOM before testing.
- window.getSelection().removeAllRanges();
- } );
- }
- function waitForDebounce() {
- return new Promise( resolve => {
- setTimeout( () => {
- resolve();
- }, 50 );
- } );
- }
- } );
|