widgettoolbarrepository.js 11 KB

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