widgettoolbarrepository.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  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 ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  7. import BalloonEditor from '@ckeditor/ckeditor5-editor-balloon/src/ballooneditor';
  8. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  9. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  10. import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
  11. import Widget from '../src/widget';
  12. import WidgetToolbarRepository from '../src/widgettoolbarrepository';
  13. import { isWidget, toWidget } from '../src/utils';
  14. import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
  15. import View from '@ckeditor/ckeditor5-ui/src/view';
  16. import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  17. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  18. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  19. describe( 'WidgetToolbarRepository', () => {
  20. let editor, model, balloon, widgetToolbarRepository, editorElement;
  21. testUtils.createSinonSandbox();
  22. beforeEach( () => {
  23. editorElement = document.createElement( 'div' );
  24. document.body.appendChild( editorElement );
  25. return ClassicTestEditor
  26. .create( editorElement, {
  27. plugins: [ Paragraph, FakeButton, WidgetToolbarRepository, FakeWidget ],
  28. fake: {
  29. toolbar: [ 'fake_button' ]
  30. }
  31. } )
  32. .then( newEditor => {
  33. editor = newEditor;
  34. model = newEditor.model;
  35. widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
  36. balloon = editor.plugins.get( 'ContextualBalloon' );
  37. } );
  38. } );
  39. afterEach( () => {
  40. editorElement.remove();
  41. return editor.destroy();
  42. } );
  43. it( 'should be loaded', () => {
  44. expect( editor.plugins.get( WidgetToolbarRepository ) ).to.be.instanceOf( WidgetToolbarRepository );
  45. } );
  46. it( 'should work if balloon toolbar is not available', () => {
  47. editorElement.remove();
  48. editor.destroy();
  49. editorElement = document.createElement( 'div' );
  50. document.body.appendChild( editorElement );
  51. expect( editor.plugins.has( 'BalloonToolbar' ) ).to.be.false;
  52. expect( editor.plugins.has( WidgetToolbarRepository ) ).to.be.true;
  53. } );
  54. describe( 'register()', () => {
  55. it( 'should create a widget toolbar and add it to the collection', () => {
  56. widgetToolbarRepository.register( 'fake', {
  57. items: editor.config.get( 'fake.toolbar' ),
  58. visibleWhen: () => false,
  59. } );
  60. expect( widgetToolbarRepository._toolbars.size ).to.equal( 1 );
  61. expect( widgetToolbarRepository._toolbars.get( 'fake' ) ).to.be.an( 'object' );
  62. } );
  63. it( 'should throw when adding two times widget with the same id', () => {
  64. widgetToolbarRepository.register( 'fake', {
  65. items: editor.config.get( 'fake.toolbar' ),
  66. visibleWhen: () => false
  67. } );
  68. expect( () => {
  69. widgetToolbarRepository.register( 'fake', {
  70. items: editor.config.get( 'fake.toolbar' ),
  71. visibleWhen: () => false
  72. } );
  73. } ).to.throw( CKEditorError, /^widget-toolbar-duplicated/ );
  74. } );
  75. } );
  76. describe( 'integration tests', () => {
  77. beforeEach( () => {
  78. editor.ui.focusTracker.isFocused = true;
  79. } );
  80. it( 'toolbar should be visible when the `visibleWhen` callback returns true', () => {
  81. widgetToolbarRepository.register( 'fake', {
  82. items: editor.config.get( 'fake.toolbar' ),
  83. visibleWhen: isFakeWidgetSelected
  84. } );
  85. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  86. const fakeWidgetToolbarView = widgetToolbarRepository._toolbars.get( 'fake' ).view;
  87. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  88. } );
  89. it( 'toolbar should be hidden when the `visibleWhen` callback returns false', () => {
  90. widgetToolbarRepository.register( 'fake', {
  91. items: editor.config.get( 'fake.toolbar' ),
  92. visibleWhen: isFakeWidgetSelected
  93. } );
  94. setData( model, '[<paragraph>foo</paragraph>]<fake-widget></fake-widget>' );
  95. expect( balloon.visibleView ).to.equal( null );
  96. } );
  97. it( 'toolbar should be hidden when the `visibleWhen` callback returns false #2', () => {
  98. widgetToolbarRepository.register( 'fake', {
  99. items: editor.config.get( 'fake.toolbar' ),
  100. visibleWhen: isFakeWidgetSelected
  101. } );
  102. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  103. model.change( writer => {
  104. // Select the <paragraph>foo</paragraph>.
  105. writer.setSelection( model.document.getRoot().getChild( 0 ), 'in' );
  106. } );
  107. expect( balloon.visibleView ).to.equal( null );
  108. } );
  109. it( 'toolbar should update its position when other widget is selected', () => {
  110. widgetToolbarRepository.register( 'fake', {
  111. items: editor.config.get( 'fake.toolbar' ),
  112. visibleWhen: isFakeWidgetSelected
  113. } );
  114. setData( model, '[<fake-widget></fake-widget>]<fake-widget></fake-widget>' );
  115. model.change( writer => {
  116. // Select the second widget.
  117. writer.setSelection( model.document.getRoot().getChild( 1 ), 'on' );
  118. } );
  119. const fakeWidgetToolbarView = widgetToolbarRepository._toolbars.get( 'fake' ).view;
  120. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  121. } );
  122. it( 'it should be possible to create a widget toolbar for content inside the widget', () => {
  123. widgetToolbarRepository.register( 'fake', {
  124. items: editor.config.get( 'fake.toolbar' ),
  125. visibleWhen: isFakeWidgetContentSelected
  126. } );
  127. setData( model, '<fake-widget>[foo]</fake-widget>' );
  128. const fakeWidgetToolbarView = widgetToolbarRepository._toolbars.get( 'fake' ).view;
  129. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  130. } );
  131. it( 'toolbar should not engage when is in the balloon yet invisible', () => {
  132. widgetToolbarRepository.register( 'fake', {
  133. items: editor.config.get( 'fake.toolbar' ),
  134. visibleWhen: isFakeWidgetSelected
  135. } );
  136. const fakeWidgetToolbarView = widgetToolbarRepository._toolbars.get( 'fake' ).view;
  137. setData( model, '[<fake-widget></fake-widget>]' );
  138. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  139. const lastView = new View();
  140. lastView.element = document.createElement( 'div' );
  141. balloon.add( {
  142. view: lastView,
  143. position: {
  144. target: document.body
  145. }
  146. } );
  147. expect( balloon.visibleView ).to.equal( lastView );
  148. editor.ui.fire( 'update' );
  149. expect( balloon.visibleView ).to.equal( lastView );
  150. } );
  151. } );
  152. } );
  153. describe( 'WidgetToolbarRepository - integration with the BalloonToolbar', () => {
  154. let clock, editor, model, balloon, balloonToolbar, widgetToolbarRepository, editorElement;
  155. testUtils.createSinonSandbox();
  156. beforeEach( () => {
  157. editorElement = document.createElement( 'div' );
  158. document.body.appendChild( editorElement );
  159. clock = testUtils.sinon.useFakeTimers();
  160. return BalloonEditor
  161. .create( editorElement, {
  162. plugins: [ Paragraph, FakeButton, WidgetToolbarRepository, FakeWidget, Bold ],
  163. balloonToolbar: [ 'bold' ],
  164. fake: {
  165. toolbar: [ 'fake_button' ]
  166. }
  167. } )
  168. .then( newEditor => {
  169. editor = newEditor;
  170. model = newEditor.model;
  171. widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
  172. balloon = editor.plugins.get( 'ContextualBalloon' );
  173. balloonToolbar = editor.plugins.get( 'BalloonToolbar' );
  174. editor.editing.view.document.isFocused = true;
  175. } );
  176. } );
  177. afterEach( () => {
  178. editorElement.remove();
  179. return editor.destroy();
  180. } );
  181. it( 'balloon toolbar should be hidden when the widget is selected', () => {
  182. widgetToolbarRepository.register( 'fake', {
  183. items: editor.config.get( 'fake.toolbar' ),
  184. visibleWhen: isFakeWidgetSelected,
  185. } );
  186. const fakeWidgetToolbarView = widgetToolbarRepository._toolbars.get( 'fake' ).view;
  187. setData( model, '[<fake-widget></fake-widget>]<paragraph>foo</paragraph>' );
  188. editor.ui.focusTracker.isFocused = true;
  189. clock.tick( 200 );
  190. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  191. } );
  192. it( 'balloon toolbar should be visible when the widget is not selected', () => {
  193. widgetToolbarRepository.register( 'fake', {
  194. items: editor.config.get( 'fake.toolbar' ),
  195. visibleWhen: isFakeWidgetSelected
  196. } );
  197. setData( model, '<fake-widget></fake-widget><paragraph>[foo]</paragraph>' );
  198. editor.ui.focusTracker.isFocused = true;
  199. clock.tick( 200 );
  200. expect( balloon.visibleView ).to.equal( balloonToolbar.toolbarView );
  201. } );
  202. } );
  203. const fakeWidgetSymbol = Symbol( 'fakeWidget' );
  204. function isFakeWidgetSelected( selection ) {
  205. const viewElement = selection.getSelectedElement();
  206. return !!viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( fakeWidgetSymbol );
  207. }
  208. function isFakeWidgetContentSelected( selection ) {
  209. const pos = selection.getFirstPosition();
  210. let node = pos.parent;
  211. while ( node ) {
  212. if ( node.is( 'element' ) && isWidget( node ) && node.getCustomProperty( fakeWidgetSymbol ) ) {
  213. return true;
  214. }
  215. node = node.parent;
  216. }
  217. return false;
  218. }
  219. // Plugin that adds fake_button to editor's component factory.
  220. class FakeButton extends Plugin {
  221. init() {
  222. this.editor.ui.componentFactory.add( 'fake_button', locale => {
  223. const view = new ButtonView( locale );
  224. view.set( {
  225. label: 'fake button'
  226. } );
  227. return view;
  228. } );
  229. }
  230. }
  231. // Simple widget plugin
  232. // It registers `<fake-widget>` block in model and represents `div` in the view.
  233. // It allows having text inside self.
  234. class FakeWidget extends Plugin {
  235. static get requires() {
  236. return [ Widget ];
  237. }
  238. init() {
  239. const editor = this.editor;
  240. const schema = editor.model.schema;
  241. schema.register( 'fake-widget', {
  242. isObject: true,
  243. isBlock: true,
  244. allowWhere: '$block',
  245. } );
  246. schema.extend( '$text', { allowIn: 'fake-widget' } );
  247. const conversion = editor.conversion;
  248. conversion.for( 'dataDowncast' ).elementToElement( {
  249. model: 'fake-widget',
  250. view: ( modelElement, viewWriter ) => {
  251. return viewWriter.createContainerElement( 'div' );
  252. }
  253. } );
  254. conversion.for( 'editingDowncast' ).elementToElement( {
  255. model: 'fake-widget',
  256. view: ( modelElement, viewWriter ) => {
  257. const fakeWidget = viewWriter.createContainerElement( 'div' );
  258. viewWriter.setCustomProperty( fakeWidgetSymbol, true, fakeWidget );
  259. return toWidget( fakeWidget, viewWriter, { label: 'fake-widget' } );
  260. }
  261. } );
  262. conversion.for( 'upcast' ).elementToElement( {
  263. view: {
  264. name: 'div'
  265. },
  266. model: ( view, modelWriter ) => {
  267. return modelWriter.createElement( 'fake-widget' );
  268. }
  269. } );
  270. }
  271. }