imagetoolbar.js 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* global document, console */
  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 View from '@ckeditor/ckeditor5-ui/src/view';
  14. import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  15. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  16. describe( 'ImageToolbar', () => {
  17. let editor, model, doc, toolbar, balloon, widgetToolbarRepository, editorElement;
  18. testUtils.createSinonSandbox();
  19. beforeEach( () => {
  20. editorElement = global.document.createElement( 'div' );
  21. global.document.body.appendChild( editorElement );
  22. return ClassicEditor
  23. .create( editorElement, {
  24. plugins: [ Paragraph, Image, ImageToolbar, FakeButton ],
  25. image: {
  26. toolbar: [ 'fake_button' ]
  27. }
  28. } )
  29. .then( newEditor => {
  30. editor = newEditor;
  31. model = newEditor.model;
  32. doc = model.document;
  33. widgetToolbarRepository = editor.plugins.get( 'WidgetToolbarRepository' );
  34. toolbar = widgetToolbarRepository._toolbarDefinitions.get( 'image' ).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 consoleWarnStub = sinon.stub( console, 'warn' );
  47. const editorElement = global.document.createElement( 'div' );
  48. global.document.body.appendChild( editorElement );
  49. return ClassicEditor.create( editorElement, {
  50. plugins: [ ImageToolbar ]
  51. } )
  52. .then( editor => {
  53. expect( editor.plugins.get( ImageToolbar )._toolbar ).to.be.undefined;
  54. expect( consoleWarnStub.calledOnce ).to.equal( true );
  55. expect( consoleWarnStub.firstCall.args[ 0 ] ).to.match( /^widget-toolbar-no-items:/ );
  56. editorElement.remove();
  57. return editor.destroy();
  58. } );
  59. } );
  60. describe( 'toolbar', () => {
  61. it( 'should use the config.image.toolbar to create items', () => {
  62. expect( toolbar.items ).to.have.length( 1 );
  63. expect( toolbar.items.get( 0 ).label ).to.equal( 'fake button' );
  64. } );
  65. it( 'should set proper CSS classes', () => {
  66. const spy = sinon.spy( balloon, 'add' );
  67. editor.ui.focusTracker.isFocused = true;
  68. setData( model, '[<image src=""></image>]' );
  69. sinon.assert.calledWithMatch( spy, {
  70. view: toolbar,
  71. balloonClassName: 'ck-toolbar-container'
  72. } );
  73. } );
  74. it( 'should set aria-label attribute', () => {
  75. toolbar.render();
  76. expect( toolbar.element.getAttribute( 'aria-label' ) ).to.equal( 'Image toolbar' );
  77. toolbar.destroy();
  78. } );
  79. } );
  80. describe( 'integration with the editor focus', () => {
  81. it( 'should show the toolbar when the editor gains focus and the image is selected', () => {
  82. editor.ui.focusTracker.isFocused = true;
  83. setData( model, '[<image src=""></image>]' );
  84. editor.ui.focusTracker.isFocused = false;
  85. expect( balloon.visibleView ).to.be.null;
  86. editor.ui.focusTracker.isFocused = true;
  87. expect( balloon.visibleView ).to.equal( toolbar );
  88. } );
  89. it( 'should hide the toolbar when the editor loses focus and the image is selected', () => {
  90. editor.ui.focusTracker.isFocused = false;
  91. setData( model, '[<image src=""></image>]' );
  92. editor.ui.focusTracker.isFocused = true;
  93. expect( balloon.visibleView ).to.equal( toolbar );
  94. editor.ui.focusTracker.isFocused = false;
  95. expect( balloon.visibleView ).to.be.null;
  96. } );
  97. } );
  98. describe( 'integration with the editor selection', () => {
  99. beforeEach( () => {
  100. editor.ui.focusTracker.isFocused = true;
  101. } );
  102. it( 'should show the toolbar on ui#update when the image is selected', () => {
  103. setData( model, '<paragraph>[foo]</paragraph><image src=""></image>' );
  104. expect( balloon.visibleView ).to.be.null;
  105. editor.ui.fire( 'update' );
  106. expect( balloon.visibleView ).to.be.null;
  107. model.change( writer => {
  108. // Select the [<image></image>]
  109. writer.setSelection(
  110. writer.createRangeOn( doc.getRoot().getChild( 1 ) )
  111. );
  112. } );
  113. expect( balloon.visibleView ).to.equal( toolbar );
  114. // Make sure successive change does not throw, e.g. attempting
  115. // to insert the toolbar twice.
  116. editor.ui.fire( 'update' );
  117. expect( balloon.visibleView ).to.equal( toolbar );
  118. } );
  119. it( 'should not engage when the toolbar is in the balloon yet invisible', () => {
  120. setData( model, '[<image src=""></image>]' );
  121. expect( balloon.visibleView ).to.equal( toolbar );
  122. const lastView = new View();
  123. lastView.element = document.createElement( 'div' );
  124. balloon.add( {
  125. view: lastView,
  126. position: {
  127. target: document.body
  128. }
  129. } );
  130. expect( balloon.visibleView ).to.equal( lastView );
  131. editor.ui.fire( 'update' );
  132. expect( balloon.visibleView ).to.equal( lastView );
  133. } );
  134. it( 'should hide the toolbar on ui#update if the image is de–selected', () => {
  135. setData( model, '<paragraph>foo</paragraph>[<image src=""></image>]' );
  136. expect( balloon.visibleView ).to.equal( toolbar );
  137. model.change( writer => {
  138. // Select the <paragraph>[...]</paragraph>
  139. writer.setSelection(
  140. writer.createRangeIn( doc.getRoot().getChild( 0 ) )
  141. );
  142. } );
  143. expect( balloon.visibleView ).to.be.null;
  144. // Make sure successive change does not throw, e.g. attempting
  145. // to remove the toolbar twice.
  146. editor.ui.fire( 'update' );
  147. expect( balloon.visibleView ).to.be.null;
  148. } );
  149. } );
  150. // Plugin that adds fake_button to editor's component factory.
  151. class FakeButton extends Plugin {
  152. init() {
  153. this.editor.ui.componentFactory.add( 'fake_button', locale => {
  154. const view = new ButtonView( locale );
  155. view.set( {
  156. label: 'fake button'
  157. } );
  158. return view;
  159. } );
  160. }
  161. }
  162. } );