8
0

widgettoolbarrepository.js 11 KB

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