imagetoolbar.js 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* global document */
  6. import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
  7. import ImageToolbar from '../src/imagetoolbar';
  8. import Image from '../src/image';
  9. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  10. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  11. import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
  12. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  13. import Range from '@ckeditor/ckeditor5-engine/src/model/range';
  14. import View from '@ckeditor/ckeditor5-ui/src/view';
  15. import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  16. describe( 'ImageToolbar', () => {
  17. let editor, model, doc, editingView, plugin, toolbar, balloon, editorElement;
  18. beforeEach( () => {
  19. editorElement = global.document.createElement( 'div' );
  20. global.document.body.appendChild( editorElement );
  21. return ClassicEditor
  22. .create( editorElement, {
  23. plugins: [ Paragraph, Image, ImageToolbar, FakeButton ],
  24. image: {
  25. toolbar: [ 'fake_button' ]
  26. }
  27. } )
  28. .then( newEditor => {
  29. editor = newEditor;
  30. model = newEditor.model;
  31. doc = model.document;
  32. plugin = editor.plugins.get( ImageToolbar );
  33. toolbar = plugin._toolbar;
  34. editingView = editor.editing.view;
  35. balloon = editor.plugins.get( 'ContextualBalloon' );
  36. } );
  37. } );
  38. afterEach( () => {
  39. editorElement.remove();
  40. return editor.destroy();
  41. } );
  42. it( 'should be loaded', () => {
  43. expect( editor.plugins.get( ImageToolbar ) ).to.be.instanceOf( ImageToolbar );
  44. } );
  45. it( 'should not initialize if there is no configuration', () => {
  46. const editorElement = global.document.createElement( 'div' );
  47. global.document.body.appendChild( editorElement );
  48. return ClassicEditor.create( editorElement, {
  49. plugins: [ ImageToolbar ],
  50. } )
  51. .then( editor => {
  52. expect( editor.plugins.get( ImageToolbar )._toolbar ).to.be.undefined;
  53. editorElement.remove();
  54. return editor.destroy();
  55. } );
  56. } );
  57. describe( 'toolbar', () => {
  58. it( 'should use the config.image.toolbar to create items', () => {
  59. expect( toolbar.items ).to.have.length( 1 );
  60. expect( toolbar.items.get( 0 ).label ).to.equal( 'fake button' );
  61. } );
  62. it( 'should set proper CSS classes', () => {
  63. const spy = sinon.spy( balloon, 'add' );
  64. editor.ui.focusTracker.isFocused = true;
  65. setData( model, '[<image src=""></image>]' );
  66. expect( toolbar.element.classList.contains( 'ck-editor-toolbar' ) ).to.be.true;
  67. sinon.assert.calledWithMatch( spy, {
  68. view: toolbar,
  69. balloonClassName: 'ck-toolbar-container ck-editor-toolbar-container'
  70. } );
  71. } );
  72. } );
  73. describe( 'integration with the editor focus', () => {
  74. it( 'should show the toolbar when the editor gains focus and the image is selected', () => {
  75. editor.ui.focusTracker.isFocused = true;
  76. setData( model, '[<image src=""></image>]' );
  77. editor.ui.focusTracker.isFocused = false;
  78. expect( balloon.visibleView ).to.be.null;
  79. editor.ui.focusTracker.isFocused = true;
  80. expect( balloon.visibleView ).to.equal( toolbar );
  81. } );
  82. it( 'should hide the toolbar when the editor loses focus and the image is selected', () => {
  83. editor.ui.focusTracker.isFocused = false;
  84. setData( model, '[<image src=""></image>]' );
  85. editor.ui.focusTracker.isFocused = true;
  86. expect( balloon.visibleView ).to.equal( toolbar );
  87. editor.ui.focusTracker.isFocused = false;
  88. expect( balloon.visibleView ).to.be.null;
  89. } );
  90. } );
  91. describe( 'integration with the editor selection (#render event)', () => {
  92. beforeEach( () => {
  93. editor.ui.focusTracker.isFocused = true;
  94. } );
  95. it( 'should show the toolbar on render when the image is selected', () => {
  96. setData( model, '<paragraph>[foo]</paragraph><image src=""></image>' );
  97. expect( balloon.visibleView ).to.be.null;
  98. editingView.fire( 'render' );
  99. expect( balloon.visibleView ).to.be.null;
  100. model.change( writer => {
  101. // Select the [<image></image>]
  102. writer.setSelection(
  103. Range.createOn( doc.getRoot().getChild( 1 ) )
  104. );
  105. } );
  106. expect( balloon.visibleView ).to.equal( toolbar );
  107. // Make sure successive render does not throw, e.g. attempting
  108. // to insert the toolbar twice.
  109. editingView.fire( 'render' );
  110. expect( balloon.visibleView ).to.equal( toolbar );
  111. } );
  112. it( 'should not engage when the toolbar is in the balloon yet invisible', () => {
  113. setData( model, '[<image src=""></image>]' );
  114. expect( balloon.visibleView ).to.equal( toolbar );
  115. const lastView = new View();
  116. lastView.element = document.createElement( 'div' );
  117. balloon.add( { view: lastView } );
  118. expect( balloon.visibleView ).to.equal( lastView );
  119. editingView.fire( 'render' );
  120. expect( balloon.visibleView ).to.equal( lastView );
  121. } );
  122. it( 'should hide the toolbar on render if the image is de–selected', () => {
  123. setData( model, '<paragraph>foo</paragraph>[<image src=""></image>]' );
  124. expect( balloon.visibleView ).to.equal( toolbar );
  125. model.change( writer => {
  126. // Select the <paragraph>[...]</paragraph>
  127. writer.setSelection(
  128. Range.createIn( doc.getRoot().getChild( 0 ) )
  129. );
  130. } );
  131. expect( balloon.visibleView ).to.be.null;
  132. // Make sure successive render does not throw, e.g. attempting
  133. // to remove the toolbar twice.
  134. editingView.fire( 'render' );
  135. expect( balloon.visibleView ).to.be.null;
  136. } );
  137. } );
  138. // Plugin that adds fake_button to editor's component factory.
  139. class FakeButton extends Plugin {
  140. init() {
  141. this.editor.ui.componentFactory.add( 'fake_button', locale => {
  142. const view = new ButtonView( locale );
  143. view.set( {
  144. label: 'fake button'
  145. } );
  146. return view;
  147. } );
  148. }
  149. }
  150. } );