/** * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor'; import ContextualBalloon from '../../../src/panel/balloon/contextualballoon'; import BalloonPanelView from '../../../src/panel/balloon/balloonpanelview'; import View from '../../../src/view'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import Plugin from '@ckeditor/ckeditor5-core/src/plugin'; import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; import ViewContainerElement from '@ckeditor/ckeditor5-engine/src/view/containerelement'; import ViewEditableElement from '@ckeditor/ckeditor5-engine/src/view/editableelement'; import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter'; import { setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; /* global document, Event */ describe( 'ContextualBalloon', () => { let editor, editorElement, balloon, viewA, viewB; beforeEach( () => { editorElement = document.createElement( 'div' ); document.body.appendChild( editorElement ); return ClassicTestEditor .create( editorElement, { plugins: [ Paragraph, ContextualBalloon ] } ) .then( newEditor => { editor = newEditor; balloon = editor.plugins.get( ContextualBalloon ); // We don't need to execute BalloonPanel pin and attachTo methods // it's enough to check if was called with the proper data. sinon.stub( balloon.view, 'attachTo' ).returns( {} ); sinon.stub( balloon.view, 'pin' ).returns( {} ); viewA = new View(); viewB = new View(); // Add viewA to the pane and init viewB. balloon.add( { view: viewA, position: { target: 'fake' } } ); viewB.init(); } ); } ); afterEach( () => { editor.destroy(); } ); it( 'should create a plugin instance', () => { expect( balloon ).to.instanceof( Plugin ); expect( balloon ).to.instanceof( ContextualBalloon ); } ); describe( 'pluginName', () => { it( 'should return plugin by name', () => { expect( editor.plugins.get( 'ContextualBalloon' ) ).to.equal( balloon ); } ); } ); describe( 'init()', () => { it( 'should create a plugin instance with properties', () => { expect( balloon.view ).to.instanceof( BalloonPanelView ); } ); describe( 'positionLimiter', () => { let doc, viewDocument, root; beforeEach( () => { doc = editor.document; viewDocument = editor.editing.view; root = viewDocument.getRoot(); } ); it( 'obtains the root of the selection', () => { setModelData( doc, '[]bar' ); expect( balloon.positionLimiter() ).to.equal( viewDocument.domConverter.mapViewToDom( root ) ); } ); it( 'does not fail if selection has no #editableElement', () => { sinon.stub( viewDocument.selection, 'editableElement' ).value( null ); expect( balloon.positionLimiter() ).to.equal( null ); } ); it( 'obtains the farthest root of the selection (nested editable)', () => { doc.schema.registerItem( 'widget' ); doc.schema.registerItem( 'nestededitable' ); doc.schema.objects.add( 'widget' ); doc.schema.allow( { name: 'widget', inside: '$root' } ); doc.schema.allow( { name: 'nestededitable', inside: 'widget' } ); doc.schema.allow( { name: '$inline', inside: 'nestededitable' } ); buildModelConverter().for( editor.data.modelToView, editor.editing.modelToView ) .fromElement( 'widget' ) .toElement( () => new ViewContainerElement( 'figure', { contenteditable: 'false' } ) ); buildModelConverter().for( editor.data.modelToView, editor.editing.modelToView ) .fromElement( 'nestededitable' ) .toElement( () => new ViewEditableElement( 'figcaption', { contenteditable: 'true' } ) ); setModelData( doc, '[]foo' ); expect( balloon.positionLimiter() ).to.equal( viewDocument.domConverter.mapViewToDom( root ) ); } ); } ); it( 'should add balloon panel view to editor `body` collection', () => { expect( editor.ui.view.body.getIndex( balloon.view ) ).to.above( -1 ); } ); it( 'should register balloon panel element in editor.ui#focusTracker', () => { editor.ui.focusTracker.isfocused = false; balloon.add( { view: viewB, position: { target: 'fake', limiter: balloon.positionLimiter } } ); balloon.view.element.dispatchEvent( new Event( 'focus' ) ); expect( editor.ui.focusTracker.isFocused ).to.true; } ); } ); describe( 'hasView()', () => { it( 'should return true when given view is in stack', () => { expect( balloon.hasView( viewA ) ).to.true; } ); it( 'should return true when given view is in stack but is not visible', () => { balloon.add( { view: viewB, position: { target: 'fake', limiter: balloon.positionLimiter } } ); expect( balloon.visibleView ).to.equal( viewB ); expect( balloon.hasView( viewA ) ).to.true; } ); it( 'should return false when given view is not in stack', () => { expect( balloon.hasView( viewB ) ).to.false; } ); } ); describe( 'add()', () => { it( 'should add view to the stack and display in balloon attached using given position options', () => { expect( balloon.view.content.length ).to.equal( 1 ); expect( balloon.view.content.get( 0 ) ).to.deep.equal( viewA ); expect( balloon.view.pin.calledOnce ).to.true; sinon.assert.calledWithMatch( balloon.view.pin.firstCall, { target: 'fake', limiter: balloon.positionLimiter } ); } ); it( 'should use a provided limiter instead of #positionLimiter', () => { balloon.remove( viewA ); balloon.view.pin.resetHistory(); balloon.add( { view: viewB, position: { target: 'foo', limiter: 'customLimiter' } } ); sinon.assert.calledWithMatch( balloon.view.pin, { target: 'foo', limiter: 'customLimiter' } ); } ); it( 'should use a custom #positionLimiter', () => { balloon.remove( viewA ); balloon.view.pin.resetHistory(); balloon.positionLimiter = 'customLimiter'; balloon.add( { view: viewB, position: { target: 'foo', } } ); sinon.assert.calledWithMatch( balloon.view.pin, { target: 'foo', limiter: 'customLimiter' } ); } ); it( 'should not alter the view data if no limiter is provided and the #positionLimiter is used', () => { const data = { view: viewB, position: { target: 'foo', } }; balloon.remove( viewA ); balloon.add( data ); expect( data ).to.deep.equal( { view: viewB, position: { target: 'foo' } } ); } ); it( 'should pin balloon to the target element', () => { sinon.assert.calledOnce( balloon.view.pin ); } ); it( 'should throw an error when try to add the same view more than once', () => { expect( () => { balloon.add( { view: viewA, position: { target: 'fake', limiter: balloon.positionLimiter } } ); } ).to.throw( CKEditorError, /^contextualballoon-add-view-exist/ ); } ); it( 'should add multiple views to he stack and display last one', () => { balloon.add( { view: viewB, position: { target: 'fake', limiter: balloon.positionLimiter } } ); expect( balloon.view.content.length ).to.equal( 1 ); expect( balloon.view.content.get( 0 ) ).to.deep.equal( viewB ); } ); it( 'should keep balloon at the same position after adding next view', () => { balloon.add( { view: viewB, position: { target: 'other' } } ); expect( balloon.view.pin.calledTwice ).to.true; sinon.assert.calledWithMatch( balloon.view.pin.firstCall, { target: 'fake', limiter: balloon.positionLimiter } ); sinon.assert.calledWithMatch( balloon.view.pin.secondCall, { target: 'fake', limiter: balloon.positionLimiter } ); } ); it( 'should set additional css class of visible view to BalloonPanelView', () => { const view = new View(); balloon.add( { view, position: { target: 'fake', limiter: balloon.positionLimiter }, balloonClassName: 'foo' } ); expect( balloon.view.className ).to.equal( 'foo' ); balloon.add( { view: viewB, position: { target: 'fake', limiter: balloon.positionLimiter }, balloonClassName: 'bar' } ); expect( balloon.view.className ).to.equal( 'bar' ); } ); } ); describe( 'visibleView', () => { it( 'should return data of currently visible view', () => { expect( balloon.visibleView ).to.equal( viewA ); } ); it( 'should return data of currently visible view when there is more than one in the stack', () => { balloon.add( { view: viewB, position: { target: 'fake', limiter: balloon.positionLimiter } } ); expect( balloon.visibleView ).to.equal( viewB ); } ); it( 'should return `null` when the stack is empty', () => { balloon.remove( viewA ); expect( balloon.visibleView ).to.null; } ); } ); describe( 'remove()', () => { it( 'should remove given view and hide balloon when there is no other view to display', () => { balloon.view.isVisible = true; balloon.remove( viewA ); expect( balloon.visibleView ).to.null; expect( balloon.view.isVisible ).to.false; } ); it( 'should remove given view and set preceding in the stack as visible when removed view was visible', () => { balloon.add( { view: viewB, position: { target: 'fake', limiter: balloon.positionLimiter } } ); balloon.remove( viewB ); expect( balloon.visibleView ).to.equal( viewA ); } ); it( 'should remove given view from the stack when view is not visible', () => { balloon.add( { view: viewB, position: { target: 'fake', limiter: balloon.positionLimiter } } ); balloon.remove( viewA ); expect( balloon.visibleView ).to.equal( viewB ); } ); it( 'should throw an error when there is no given view in the stack', () => { expect( () => { balloon.remove( viewB ); } ).to.throw( CKEditorError, /^contextualballoon-remove-view-not-exist/ ); } ); it( 'should set additional css class of visible view to BalloonPanelView', () => { const view = new View(); balloon.add( { view, position: { target: 'fake', limiter: balloon.positionLimiter }, balloonClassName: 'foo' } ); balloon.add( { view: viewB, position: { target: 'fake', limiter: balloon.positionLimiter }, balloonClassName: 'bar' } ); balloon.remove( viewB ); expect( balloon.view.className ).to.equal( 'foo' ); } ); } ); describe( 'updatePosition()', () => { it( 'should attach balloon to the target using position option from the first view in the stack', () => { balloon.add( { view: viewB, position: { target: 'other' } } ); balloon.view.attachTo.reset(); balloon.updatePosition(); expect( balloon.view.attachTo.calledOnce ); sinon.assert.calledWithMatch( balloon.view.attachTo.firstCall, { target: 'fake', limiter: balloon.positionLimiter } ); } ); it( 'should set given position to the currently visible view and use position from the first view in the stack #1', () => { balloon.view.attachTo.reset(); balloon.updatePosition( { target: 'new' } ); expect( balloon.view.attachTo.calledOnce ); sinon.assert.calledWithMatch( balloon.view.attachTo.firstCall, { target: 'new', limiter: balloon.positionLimiter } ); } ); it( 'should set given position to the currently visible view and use position from the first view in the stack #2', () => { balloon.add( { view: viewB, position: { target: 'other' } } ); balloon.view.attachTo.reset(); balloon.updatePosition( { target: 'new' } ); expect( balloon.view.attachTo.calledOnce ); sinon.assert.calledWithMatch( balloon.view.attachTo.firstCall, { target: 'fake', limiter: balloon.positionLimiter } ); balloon.remove( viewA ); balloon.updatePosition(); expect( balloon.view.attachTo.calledTwice ); sinon.assert.calledWithMatch( balloon.view.attachTo.secondCall, { target: 'new', limiter: balloon.positionLimiter } ); } ); it( 'should use a given position limiter instead of the default one', () => { balloon.view.attachTo.reset(); balloon.updatePosition( { target: 'new', limiter: 'customLimiter' } ); expect( balloon.view.attachTo.calledOnce ); sinon.assert.calledWithMatch( balloon.view.attachTo.firstCall, { target: 'new', limiter: 'customLimiter' } ); } ); it( 'should throw an error when there is no given view in the stack', () => { expect( () => { balloon.remove( viewB ); } ).to.throw( CKEditorError, /^contextualballoon-remove-view-not-exist/ ); } ); } ); describe( 'destroy()', () => { it( 'can be called multiple times', () => { expect( () => { balloon.destroy(); balloon.destroy(); } ).to.not.throw(); } ); it( 'should not touch the DOM', () => { balloon.destroy(); expect( editor.ui.view.body.getIndex( balloon.view ) ).to.not.equal( -1 ); } ); } ); } );