widgettoolbarrepository.js 11 KB

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