/**
* Copyright (c) 2016, CKSource - Frederico Knabben. All rights reserved.
*/
import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
import ContextualToolbar from '../../../src/toolbar/contextual/contextualtoolbar';
import ContextualBalloon from '../../../src/panel/balloon/contextualballoon';
import ToolbarView from '../../../src/toolbar/toolbarview';
import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import global from '@ckeditor/ckeditor5-utils/src/dom/global';
import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model.js';
/* global document, setTimeout */
describe( 'ContextualToolbar', () => {
let sandbox, editor, contextualToolbar, balloon, editorElement;
beforeEach( () => {
sandbox = sinon.sandbox.create();
editorElement = document.createElement( 'div' );
document.body.appendChild( editorElement );
return ClassicTestEditor.create( editorElement, {
plugins: [ Paragraph, Bold, Italic, ContextualToolbar ],
contextualToolbar: [ 'bold', 'italic' ]
} )
.then( newEditor => {
newEditor.editing.view.attachDomRoot( editorElement );
editor = newEditor;
contextualToolbar = editor.plugins.get( ContextualToolbar );
balloon = editor.plugins.get( ContextualBalloon );
// Focus the engine.
editor.editing.view.isFocused = true;
// Init child view.
return contextualToolbar.toolbarView.init();
} );
} );
afterEach( () => {
sandbox.restore();
return editor.destroy();
} );
it( 'should create a plugin instance', () => {
expect( contextualToolbar ).to.instanceOf( Plugin );
expect( contextualToolbar ).to.instanceOf( ContextualToolbar );
expect( contextualToolbar.toolbarView ).to.instanceof( ToolbarView );
} );
it( 'should load ContextualBalloon', () => {
expect( balloon ).to.instanceof( ContextualBalloon );
} );
it( 'should create components from config', () => {
expect( contextualToolbar.toolbarView.items ).to.length( 2 );
} );
it( 'should fire internal `_selectionChangeDebounced` event 200 ms after last selection change', ( done ) => {
// This test uses setTimeout to test lodash#debounce because sinon fake timers
// doesn't work with lodash. Lodash keeps time related stuff in a closure
// and sinon is not able to override it.
const spy = sandbox.spy();
setData( editor.document, '[bar]' );
contextualToolbar.on( '_selectionChangeDebounced', spy );
editor.document.selection.fire( 'change:range', {} );
// Not yet.
sinon.assert.notCalled( spy );
// Lets wait 100 ms.
setTimeout( () => {
// Still not yet.
sinon.assert.notCalled( spy );
// Fire event one more time.
editor.document.selection.fire( 'change:range', {} );
// Another 100 ms waiting.
setTimeout( () => {
// Still not yet.
sinon.assert.notCalled( spy );
// Another 101 ms waiting.
setTimeout( () => {
// And here it is.
sinon.assert.calledOnce( spy );
done();
}, 100 );
}, 101 );
}, 100 );
} );
it( 'should open when selection stops changing', () => {
setData( editor.document, '[bar]' );
expect( balloon.visibleView ).to.null;
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
} );
it( 'should add additional class to the ContextualBalloon#view', () => {
setData( editor.document, '[bar]' );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.view.className ).to.equal( 'ck-toolbar__container' );
} );
it( 'should close when selection starts changing by a directChange', () => {
setData( editor.document, '[bar]' );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
editor.document.selection.fire( 'change:range', { directChange: true } );
expect( balloon.visibleView ).to.null;
} );
it( 'should not close when selection starts changing by not a directChange', () => {
setData( editor.document, '[bar]' );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
editor.document.selection.fire( 'change:range', { directChange: false } );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
} );
it( 'should close when selection starts changing by not a directChange but will become collapsed', () => {
setData( editor.document, '[bar]' );
contextualToolbar.fire( '_selectionChangeDebounced' );
// Collapse range silently (without firing `change:range` { directChange: true } event).
const range = editor.document.selection._ranges[ 0 ];
range.end = range.start;
editor.document.selection.fire( 'change:range', { directChange: false } );
expect( balloon.visibleView ).to.null;
} );
it( 'should put balloon on the `south` if the selection is forward', () => {
setData( editor.document, '[bar]' );
stubClientRects();
// Mock limiter rect.
mockBoundingBox( document.body, {
left: 0,
width: 1000,
top: 0,
height: 1000
} );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
// Balloon is attached after internal promise resolve and we have
// no access to this promise so we need to wait for it.
return wait().then( () => {
expect( balloon.view.position ).to.equal( 'arrow_s' );
} );
} );
it( 'should put balloon on the `north` if the selection is forward `south` is limited', () => {
setData( editor.document, '[bar]' );
stubClientRects();
// Mock limiter rect.
mockBoundingBox( document.body, {
left: 0,
width: 1000,
top: 0,
height: 310
} );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
// Balloon is attached after internal promise resolve and we have
// no access to this promise so we need to wait for it.
return wait().then( () => {
expect( balloon.view.position ).to.equal( 'arrow_n' );
} );
} );
it( 'should put balloon on the `north` if the selection is backward', () => {
setData( editor.document, '[bar]', { lastRangeBackward: true } );
stubClientRects();
// Mock limiter rect.
mockBoundingBox( document.body, {
left: 0,
width: 1000,
top: 0,
height: 1000
} );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
// Balloon is attached after internal promise resolve and we have
// no access to this promise so we need to wait for it.
return wait().then( () => {
expect( balloon.view.position ).to.equal( 'arrow_n' );
} );
} );
it( 'should put balloon on the `south` if the selection is backward `north` is limited', () => {
setData( editor.document, '[bar]', { lastRangeBackward: true } );
stubClientRects();
// Mock limiter rect.
mockBoundingBox( document.body, {
left: 0,
width: 1000,
top: 95,
height: 905
} );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
// Balloon is attached after internal promise resolve and we have
// no access to this promise so we need to wait for it.
return wait().then( () => {
expect( balloon.view.position ).to.equal( 'arrow_s' );
} );
} );
it( 'should not open if the collapsed selection is moving', () => {
setData( editor.document, 'ba[]r' );
editor.document.selection.fire( 'change:range', {} );
contextualToolbar.fire( '_selectionChangeDebounced' );
setData( editor.document, 'b[]ar' );
editor.document.selection.fire( 'change:range', {} );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.null;
} );
it( 'should hide if the editor loses focus', () => {
setData( editor.document, '[bar]' );
editor.ui.focusTracker.isFocused = true;
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
editor.ui.focusTracker.isFocused = false;
expect( balloon.visibleView ).to.null;
} );
it( 'should do nothing when panel is being added to balloon stack twice', () => {
setData( editor.document, '[bar]' );
contextualToolbar.fire( '_selectionChangeDebounced' );
expect( balloon.visibleView ).to.equal( contextualToolbar.toolbarView );
expect( () => {
contextualToolbar.fire( '_selectionChangeDebounced' );
} ).to.not.throw();
} );
it( 'should update balloon position when toolbar is opened and editor content has changed', () => {
const spy = sandbox.stub( balloon, 'updatePosition' );
setData( editor.document, '[bar]' );
contextualToolbar.fire( '_selectionChangeDebounced' );
sinon.assert.notCalled( spy );
editor.editing.view.fire( 'render' );
sinon.assert.calledOnce( spy );
} );
it( 'should update balloon position when toolbar is closed', () => {
const spy = sandbox.spy( balloon, 'updatePosition' );
setData( editor.document, '[bar]' );
contextualToolbar.fire( '_selectionChangeDebounced' );
// Hide toolbar.
editor.document.selection.fire( 'change:range', { directChange: true } );
editor.editing.view.fire( 'render' );
sinon.assert.notCalled( spy );
} );
describe( 'pluginName', () => {
it( 'should return plugin by name', () => {
expect( editor.plugins.get( 'contextualballoon' ) ).to.equal( balloon );
} );
} );
describe( 'destroy()', () => {
it( 'should not fire `_selectionChangeDebounced` after plugin destroy', ( done ) => {
const spy = sandbox.spy();
contextualToolbar.on( '_selectionChangeDebounced', spy );
editor.document.selection.fire( 'change:range', { directChange: true } );
contextualToolbar.destroy();
setTimeout( () => {
sinon.assert.notCalled( spy );
done();
}, 200 );
} );
} );
function stubClientRects() {
const editingView = editor.editing.view;
const originalViewRangeToDom = editingView.domConverter.viewRangeToDom;
// Mock selection rect.
sandbox.stub( editingView.domConverter, 'viewRangeToDom', ( ...args ) => {
const domRange = originalViewRangeToDom.apply( editingView.domConverter, args );
sandbox.stub( domRange, 'getClientRects', () => {
return {
length: 2,
item: id => {
if ( id === 0 ) {
return {
top: 100,
height: 10,
bottom: 110,
left: 200,
width: 50,
right: 250
};
}
return {
top: 300,
height: 10,
bottom: 310,
left: 400,
width: 50,
right: 450
};
}
};
} );
return domRange;
} );
// Mock window rect.
sandbox.stub( global.window, 'innerWidth', 1000 );
sandbox.stub( global.window, 'innerHeight', 1000 );
sandbox.stub( global.window, 'scrollX', 0 );
sandbox.stub( global.window, 'scrollY', 0 );
// Mock balloon rect.
mockBoundingBox( balloon.view.element, {
width: 150,
height: 50
} );
}
function mockBoundingBox( element, data ) {
const boundingBox = Object.assign( {}, data );
boundingBox.right = boundingBox.left + boundingBox.width;
boundingBox.bottom = boundingBox.top + boundingBox.height;
sandbox.stub( element, 'getBoundingClientRect' ).returns( boundingBox );
}
} );
function wait( delay = 1 ) {
return new Promise( ( resolve ) => {
setTimeout( () => resolve(), delay );
} );
}