widgettoolbarrepository.js 10 KB

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