widgettoolbarrepository.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487
  1. /**
  2. * @license Copyright (c) 2003-2019, 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, FakeChildWidget ],
  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. getRelatedElement: () => null,
  59. } );
  60. expect( widgetToolbarRepository._toolbarDefinitions.size ).to.equal( 1 );
  61. expect( widgetToolbarRepository._toolbarDefinitions.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. getRelatedElement: () => null
  67. } );
  68. expect( () => {
  69. widgetToolbarRepository.register( 'fake', {
  70. items: editor.config.get( 'fake.toolbar' ),
  71. getRelatedElement: () => null
  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 `getRelatedElement` callback returns a selected widget element', () => {
  81. widgetToolbarRepository.register( 'fake', {
  82. items: editor.config.get( 'fake.toolbar' ),
  83. getRelatedElement: getSelectedFakeWidget
  84. } );
  85. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  86. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  87. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  88. } );
  89. it( 'toolbar should be hidden when the `getRelatedElement` callback returns null', () => {
  90. widgetToolbarRepository.register( 'fake', {
  91. items: editor.config.get( 'fake.toolbar' ),
  92. getRelatedElement: getSelectedFakeWidget
  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 `getRelatedElement` callback returns null #2', () => {
  98. widgetToolbarRepository.register( 'fake', {
  99. items: editor.config.get( 'fake.toolbar' ),
  100. getRelatedElement: getSelectedFakeWidget
  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. getRelatedElement: getSelectedFakeWidget
  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._toolbarDefinitions.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. getRelatedElement: getSelectedFakeWidgetContent
  126. } );
  127. setData( model, '<fake-widget>[foo]</fake-widget>' );
  128. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.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. getRelatedElement: getSelectedFakeWidget
  135. } );
  136. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.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. // #60
  152. it( 'should show up only for the related element which is deepest in the view document', () => {
  153. // The point of this widget is to provide a getRelatedElement function that
  154. // returns a super–shallow related element which is ignored but satisfies code coverage.
  155. widgetToolbarRepository.register( 'dummy', {
  156. items: editor.config.get( 'fake.toolbar' ),
  157. getRelatedElement: () => editor.editing.view.document.getRoot()
  158. } );
  159. widgetToolbarRepository.register( 'fake', {
  160. items: editor.config.get( 'fake.toolbar' ),
  161. getRelatedElement: getSelectedFakeWidget
  162. } );
  163. widgetToolbarRepository.register( 'fake-child', {
  164. items: editor.config.get( 'fake.toolbar' ),
  165. getRelatedElement: getSelectedFakeChildWidget
  166. } );
  167. setData( model,
  168. '<paragraph>foo</paragraph>' +
  169. '<fake-widget>' +
  170. '<paragraph>foo</paragraph>' +
  171. '[<fake-child-widget></fake-child-widget>]' +
  172. '</fake-widget>' );
  173. const fakeChildWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake-child' ).view;
  174. expect( balloon.visibleView ).to.equal( fakeChildWidgetToolbarView );
  175. } );
  176. // #60
  177. it( 'should attach to the new related view element upon selecting another widget', () => {
  178. const view = editor.editing.view;
  179. widgetToolbarRepository.register( 'fake', {
  180. items: editor.config.get( 'fake.toolbar' ),
  181. getRelatedElement: getSelectedFakeWidget
  182. } );
  183. widgetToolbarRepository.register( 'fake-child', {
  184. items: editor.config.get( 'fake.toolbar' ),
  185. getRelatedElement: getSelectedFakeChildWidget
  186. } );
  187. setData( model,
  188. '<paragraph>foo</paragraph>' +
  189. '[<fake-widget>' +
  190. '<paragraph>foo</paragraph>' +
  191. '<fake-child-widget></fake-child-widget>' +
  192. '</fake-widget>]' );
  193. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  194. const fakeChildWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake-child' ).view;
  195. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  196. const fakeChildViewElement = view.document.getRoot().getChild( 1 ).getChild( 1 );
  197. const updatePositionSpy = sinon.spy( balloon, 'add' );
  198. view.change( writer => {
  199. // [<fake-child-widget></fake-child-widget>]
  200. writer.setSelection( fakeChildViewElement, 'on' );
  201. } );
  202. expect( balloon.visibleView ).to.equal( fakeChildWidgetToolbarView );
  203. expect( updatePositionSpy.firstCall.args[ 0 ].position.target ).to.equal(
  204. view.domConverter.viewToDom( fakeChildViewElement ) );
  205. } );
  206. } );
  207. } );
  208. describe( 'WidgetToolbarRepository - integration with the BalloonToolbar', () => {
  209. let clock, editor, model, balloon, balloonToolbar, widgetToolbarRepository, editorElement;
  210. testUtils.createSinonSandbox();
  211. beforeEach( () => {
  212. editorElement = document.createElement( 'div' );
  213. document.body.appendChild( editorElement );
  214. clock = testUtils.sinon.useFakeTimers();
  215. return BalloonEditor
  216. .create( editorElement, {
  217. plugins: [ Paragraph, FakeButton, WidgetToolbarRepository, FakeWidget, Bold ],
  218. balloonToolbar: [ 'bold' ],
  219. fake: {
  220. toolbar: [ 'fake_button' ]
  221. }
  222. } )
  223. .then( newEditor => {
  224. editor = newEditor;
  225. model = newEditor.model;
  226. widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
  227. balloon = editor.plugins.get( 'ContextualBalloon' );
  228. balloonToolbar = editor.plugins.get( 'BalloonToolbar' );
  229. } );
  230. } );
  231. afterEach( () => {
  232. editorElement.remove();
  233. return editor.destroy();
  234. } );
  235. it( 'balloon toolbar should be hidden when the widget is selected', () => {
  236. widgetToolbarRepository.register( 'fake', {
  237. items: editor.config.get( 'fake.toolbar' ),
  238. getRelatedElement: getSelectedFakeWidget,
  239. } );
  240. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  241. setData( model, '[<fake-widget></fake-widget>]<paragraph>foo</paragraph>' );
  242. editor.ui.focusTracker.isFocused = true;
  243. clock.tick( 200 );
  244. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  245. } );
  246. it( 'balloon toolbar should be visible when the widget is not selected', () => {
  247. widgetToolbarRepository.register( 'fake', {
  248. items: editor.config.get( 'fake.toolbar' ),
  249. getRelatedElement: getSelectedFakeWidget
  250. } );
  251. setData( model, '<fake-widget></fake-widget><paragraph>[foo]</paragraph>' );
  252. editor.editing.view.document.isFocused = true;
  253. clock.tick( 200 );
  254. expect( balloon.visibleView ).to.equal( balloonToolbar.toolbarView );
  255. } );
  256. } );
  257. function getSelectedFakeWidget( selection ) {
  258. const viewElement = selection.getSelectedElement();
  259. if ( viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( 'fakeWidget' ) ) {
  260. return viewElement;
  261. }
  262. return null;
  263. }
  264. function getSelectedFakeChildWidget( selection ) {
  265. const viewElement = selection.getSelectedElement();
  266. if ( viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( 'fakeChildWidget' ) ) {
  267. return viewElement;
  268. }
  269. return null;
  270. }
  271. function getSelectedFakeWidgetContent( selection ) {
  272. const pos = selection.getFirstPosition();
  273. let node = pos.parent;
  274. while ( node ) {
  275. if ( node.is( 'element' ) && isWidget( node ) && node.getCustomProperty( 'fakeWidget' ) ) {
  276. return node;
  277. }
  278. node = node.parent;
  279. }
  280. return null;
  281. }
  282. // Plugin that adds fake_button to editor's component factory.
  283. class FakeButton extends Plugin {
  284. init() {
  285. this.editor.ui.componentFactory.add( 'fake_button', locale => {
  286. const view = new ButtonView( locale );
  287. view.set( {
  288. label: 'fake button'
  289. } );
  290. return view;
  291. } );
  292. }
  293. }
  294. // Simple widget plugin
  295. // It registers `<fake-widget>` block in model and represents `div` in the view.
  296. // It allows having text inside self.
  297. class FakeWidget extends Plugin {
  298. static get requires() {
  299. return [ Widget ];
  300. }
  301. init() {
  302. const editor = this.editor;
  303. const schema = editor.model.schema;
  304. schema.register( 'fake-widget', {
  305. isObject: true,
  306. isBlock: true,
  307. allowWhere: '$block'
  308. } );
  309. schema.extend( '$text', { allowIn: 'fake-widget' } );
  310. schema.extend( 'paragraph', { allowIn: 'fake-widget' } );
  311. const conversion = editor.conversion;
  312. conversion.for( 'dataDowncast' ).elementToElement( {
  313. model: 'fake-widget',
  314. view: ( modelElement, viewWriter ) => {
  315. return viewWriter.createContainerElement( 'div' );
  316. }
  317. } );
  318. conversion.for( 'editingDowncast' ).elementToElement( {
  319. model: 'fake-widget',
  320. view: ( modelElement, viewWriter ) => {
  321. const fakeWidget = viewWriter.createContainerElement( 'div' );
  322. viewWriter.setCustomProperty( 'fakeWidget', true, fakeWidget );
  323. return toWidget( fakeWidget, viewWriter, { label: 'fake-widget' } );
  324. }
  325. } );
  326. conversion.for( 'upcast' ).elementToElement( {
  327. view: {
  328. name: 'div'
  329. },
  330. model: ( view, modelWriter ) => {
  331. return modelWriter.createElement( 'fake-widget' );
  332. }
  333. } );
  334. }
  335. }
  336. // A simple child widget plugin
  337. // It registers `<fake-child-widget>` block in model and represents `div` in the view.
  338. // It allows having text inside self.
  339. class FakeChildWidget extends Plugin {
  340. static get requires() {
  341. return [ Widget ];
  342. }
  343. init() {
  344. const editor = this.editor;
  345. const schema = editor.model.schema;
  346. schema.register( 'fake-child-widget', {
  347. isObject: true,
  348. isBlock: true,
  349. allowWhere: '$block',
  350. allowIn: 'fake-widget'
  351. } );
  352. schema.extend( '$text', { allowIn: 'fake-child-widget' } );
  353. schema.extend( 'paragraph', { allowIn: 'fake-child-widget' } );
  354. const conversion = editor.conversion;
  355. conversion.for( 'dataDowncast' ).elementToElement( {
  356. model: 'fake-child-widget',
  357. view: ( modelElement, viewWriter ) => {
  358. return viewWriter.createContainerElement( 'div' );
  359. }
  360. } );
  361. conversion.for( 'editingDowncast' ).elementToElement( {
  362. model: 'fake-child-widget',
  363. view: ( modelElement, viewWriter ) => {
  364. const fakeWidget = viewWriter.createContainerElement( 'div' );
  365. viewWriter.setCustomProperty( 'fakeChildWidget', true, fakeWidget );
  366. return toWidget( fakeWidget, viewWriter, { label: 'fake-child-widget' } );
  367. }
  368. } );
  369. conversion.for( 'upcast' ).elementToElement( {
  370. view: {
  371. name: 'div'
  372. },
  373. model: ( view, modelWriter ) => {
  374. return modelWriter.createElement( 'fake-child-widget' );
  375. }
  376. } );
  377. }
  378. }