widgettoolbarrepository.js 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* global document, console */
  6. import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  7. import BalloonEditor from '@ckeditor/ckeditor5-editor-balloon/src/ballooneditor';
  8. import BalloonPanelView from '@ckeditor/ckeditor5-ui/src/panel/balloon/balloonpanelview';
  9. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  10. import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
  11. import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
  12. import BlockQuote from '@ckeditor/ckeditor5-block-quote/src/blockquote';
  13. import Widget from '../src/widget';
  14. import WidgetToolbarRepository from '../src/widgettoolbarrepository';
  15. import {
  16. isWidget,
  17. toWidget,
  18. centeredBalloonPositionForLongWidgets
  19. } from '../src/utils';
  20. import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
  21. import View from '@ckeditor/ckeditor5-ui/src/view';
  22. import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  23. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  24. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  25. describe( 'WidgetToolbarRepository', () => {
  26. let editor, model, balloon, widgetToolbarRepository, editorElement;
  27. testUtils.createSinonSandbox();
  28. beforeEach( () => {
  29. editorElement = document.createElement( 'div' );
  30. document.body.appendChild( editorElement );
  31. return ClassicTestEditor
  32. .create( editorElement, {
  33. plugins: [ Paragraph, FakeButton, WidgetToolbarRepository, FakeWidget, FakeChildWidget, BlockQuote ],
  34. fake: {
  35. toolbar: [ 'fake_button' ]
  36. }
  37. } )
  38. .then( newEditor => {
  39. editor = newEditor;
  40. model = newEditor.model;
  41. widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
  42. balloon = editor.plugins.get( 'ContextualBalloon' );
  43. } );
  44. } );
  45. afterEach( () => {
  46. editorElement.remove();
  47. return editor.destroy();
  48. } );
  49. it( 'should be loaded', () => {
  50. expect( editor.plugins.get( WidgetToolbarRepository ) ).to.be.instanceOf( WidgetToolbarRepository );
  51. } );
  52. it( 'should work if balloon toolbar is not available', () => {
  53. editorElement.remove();
  54. editor.destroy();
  55. editorElement = document.createElement( 'div' );
  56. document.body.appendChild( editorElement );
  57. expect( editor.plugins.has( 'BalloonToolbar' ) ).to.be.false;
  58. expect( editor.plugins.has( WidgetToolbarRepository ) ).to.be.true;
  59. } );
  60. describe( 'register()', () => {
  61. it( 'should create a widget toolbar and add it to the collection', () => {
  62. widgetToolbarRepository.register( 'fake', {
  63. items: editor.config.get( 'fake.toolbar' ),
  64. getRelatedElement: () => null
  65. } );
  66. expect( widgetToolbarRepository._toolbarDefinitions.size ).to.equal( 1 );
  67. expect( widgetToolbarRepository._toolbarDefinitions.get( 'fake' ) ).to.be.an( 'object' );
  68. } );
  69. it( 'should throw when adding two times widget with the same id', () => {
  70. widgetToolbarRepository.register( 'fake', {
  71. items: editor.config.get( 'fake.toolbar' ),
  72. getRelatedElement: () => null
  73. } );
  74. expectToThrowCKEditorError( () => {
  75. widgetToolbarRepository.register( 'fake', {
  76. items: editor.config.get( 'fake.toolbar' ),
  77. getRelatedElement: () => null
  78. } );
  79. }, /^widget-toolbar-duplicated/, editor );
  80. } );
  81. it( 'should use a pre–defined aria-label for the toolbar', () => {
  82. widgetToolbarRepository.register( 'fake', {
  83. items: editor.config.get( 'fake.toolbar' ),
  84. getRelatedElement: () => null
  85. } );
  86. const toolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  87. toolbarView.render();
  88. expect( toolbarView.element.getAttribute( 'aria-label' ) ).to.equal( 'Widget toolbar' );
  89. toolbarView.destroy();
  90. } );
  91. it( 'should use a custom aria-label when provided', () => {
  92. widgetToolbarRepository.register( 'fake', {
  93. items: editor.config.get( 'fake.toolbar' ),
  94. getRelatedElement: () => null,
  95. ariaLabel: 'Custom label'
  96. } );
  97. const toolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  98. toolbarView.render();
  99. expect( toolbarView.element.getAttribute( 'aria-label' ) ).to.equal( 'Custom label' );
  100. toolbarView.destroy();
  101. } );
  102. it( 'should not register a toolbar when passed an empty collection of the items', () => {
  103. const consoleWarnStub = sinon.stub( console, 'warn' );
  104. widgetToolbarRepository.register( 'fake', {
  105. items: [],
  106. getRelatedElement: () => null
  107. } );
  108. expect( widgetToolbarRepository._toolbarDefinitions.get( 'fake' ) ).to.be.undefined;
  109. expect( consoleWarnStub.calledOnce ).to.equal( true );
  110. expect( consoleWarnStub.firstCall.args[ 0 ] ).to.match( /^widget-toolbar-no-items:/ );
  111. } );
  112. } );
  113. describe( 'integration tests', () => {
  114. beforeEach( () => {
  115. editor.ui.focusTracker.isFocused = true;
  116. } );
  117. it( 'toolbar should be visible when the `getRelatedElement` callback returns a selected widget element', () => {
  118. widgetToolbarRepository.register( 'fake', {
  119. items: editor.config.get( 'fake.toolbar' ),
  120. getRelatedElement: getSelectedFakeWidget
  121. } );
  122. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  123. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  124. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  125. } );
  126. it( 'toolbar should be hidden when the plugin gets disabled', () => {
  127. widgetToolbarRepository.register( 'fake', {
  128. items: editor.config.get( 'fake.toolbar' ),
  129. getRelatedElement: getSelectedFakeWidget
  130. } );
  131. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  132. widgetToolbarRepository.isEnabled = false;
  133. expect( balloon.visibleView ).to.be.null;
  134. } );
  135. it( 'toolbar should be hidden when the plugin was disabled prior changing selection', () => {
  136. widgetToolbarRepository.register( 'fake', {
  137. items: editor.config.get( 'fake.toolbar' ),
  138. getRelatedElement: getSelectedFakeWidget
  139. } );
  140. widgetToolbarRepository.isEnabled = false;
  141. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  142. expect( balloon.visibleView ).to.be.null;
  143. } );
  144. it( 'toolbar should be hidden when the `getRelatedElement` callback returns null', () => {
  145. widgetToolbarRepository.register( 'fake', {
  146. items: editor.config.get( 'fake.toolbar' ),
  147. getRelatedElement: getSelectedFakeWidget
  148. } );
  149. setData( model, '[<paragraph>foo</paragraph>]<fake-widget></fake-widget>' );
  150. expect( balloon.visibleView ).to.equal( null );
  151. } );
  152. it( 'toolbar should be hidden when the `getRelatedElement` callback returns null #2', () => {
  153. widgetToolbarRepository.register( 'fake', {
  154. items: editor.config.get( 'fake.toolbar' ),
  155. getRelatedElement: getSelectedFakeWidget
  156. } );
  157. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  158. model.change( writer => {
  159. // Select the <paragraph>foo</paragraph>.
  160. writer.setSelection( model.document.getRoot().getChild( 0 ), 'in' );
  161. } );
  162. expect( balloon.visibleView ).to.equal( null );
  163. } );
  164. it( 'toolbar should be removed from not visible balloon stack when the `getRelatedElement` callback returns null', () => {
  165. balloon.add( {
  166. view: new View(),
  167. stackId: 'secondary',
  168. position: {
  169. target: {}
  170. }
  171. } );
  172. widgetToolbarRepository.register( 'fake', {
  173. items: editor.config.get( 'fake.toolbar' ),
  174. getRelatedElement: getSelectedFakeWidget
  175. } );
  176. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  177. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  178. expect( balloon.hasView( fakeWidgetToolbarView ) );
  179. expect( balloon.visibleView ).to.not.equal( fakeWidgetToolbarView );
  180. model.change( writer => {
  181. // Select the <paragraph>foo</paragraph>.
  182. writer.setSelection( model.document.getRoot().getChild( 0 ), 'in' );
  183. } );
  184. expect( balloon.hasView( fakeWidgetToolbarView ) ).to.equal( false );
  185. } );
  186. it( 'toolbar should be hidden when the editor ui lost focus', () => {
  187. widgetToolbarRepository.register( 'fake', {
  188. items: editor.config.get( 'fake.toolbar' ),
  189. getRelatedElement: getSelectedFakeWidget
  190. } );
  191. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  192. editor.ui.focusTracker.isFocused = false;
  193. expect( balloon.visibleView ).to.equal( null );
  194. } );
  195. it( 'toolbar should do nothing with toolbar when the editor ui lost focus but toolbar is not a visible view', () => {
  196. balloon.add( {
  197. view: new View(),
  198. stackId: 'secondary',
  199. position: {
  200. target: {}
  201. }
  202. } );
  203. widgetToolbarRepository.register( 'fake', {
  204. items: editor.config.get( 'fake.toolbar' ),
  205. getRelatedElement: getSelectedFakeWidget
  206. } );
  207. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  208. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  209. editor.ui.focusTracker.isFocused = false;
  210. expect( balloon.hasView( fakeWidgetToolbarView ) ).to.equal( true );
  211. } );
  212. it( 'toolbar should update its position when other widget is selected', () => {
  213. widgetToolbarRepository.register( 'fake', {
  214. items: editor.config.get( 'fake.toolbar' ),
  215. getRelatedElement: getSelectedFakeWidget
  216. } );
  217. setData( model, '[<fake-widget></fake-widget>]<fake-widget></fake-widget>' );
  218. model.change( writer => {
  219. // Select the second widget.
  220. writer.setSelection( model.document.getRoot().getChild( 1 ), 'on' );
  221. } );
  222. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  223. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  224. } );
  225. it( 'it should be possible to create a widget toolbar for content inside the widget', () => {
  226. widgetToolbarRepository.register( 'fake', {
  227. items: editor.config.get( 'fake.toolbar' ),
  228. getRelatedElement: getSelectedFakeWidgetContent
  229. } );
  230. setData( model, '<fake-widget>[foo]</fake-widget>' );
  231. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  232. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  233. } );
  234. it( 'toolbar should not engage when is in the balloon yet invisible', () => {
  235. widgetToolbarRepository.register( 'fake', {
  236. items: editor.config.get( 'fake.toolbar' ),
  237. getRelatedElement: getSelectedFakeWidget
  238. } );
  239. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  240. setData( model, '[<fake-widget></fake-widget>]' );
  241. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  242. const lastView = new View();
  243. lastView.element = document.createElement( 'div' );
  244. balloon.add( {
  245. view: lastView,
  246. position: {
  247. target: document.body
  248. }
  249. } );
  250. expect( balloon.visibleView ).to.equal( lastView );
  251. editor.ui.fire( 'update' );
  252. expect( balloon.visibleView ).to.equal( lastView );
  253. } );
  254. // #60
  255. it( 'should show up only for the related element which is deepest in the view document', () => {
  256. // The point of this widget is to provide a getRelatedElement function that
  257. // returns a super–shallow related element which is ignored but satisfies code coverage.
  258. widgetToolbarRepository.register( 'dummy', {
  259. items: editor.config.get( 'fake.toolbar' ),
  260. getRelatedElement: () => editor.editing.view.document.getRoot()
  261. } );
  262. widgetToolbarRepository.register( 'fake', {
  263. items: editor.config.get( 'fake.toolbar' ),
  264. getRelatedElement: getSelectedFakeWidget
  265. } );
  266. widgetToolbarRepository.register( 'fake-child', {
  267. items: editor.config.get( 'fake.toolbar' ),
  268. getRelatedElement: getSelectedFakeChildWidget
  269. } );
  270. setData( model,
  271. '<paragraph>foo</paragraph>' +
  272. '<fake-widget>' +
  273. '<paragraph>foo</paragraph>' +
  274. '[<fake-child-widget></fake-child-widget>]' +
  275. '</fake-widget>' );
  276. const fakeChildWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake-child' ).view;
  277. expect( balloon.visibleView ).to.equal( fakeChildWidgetToolbarView );
  278. } );
  279. // #60
  280. it( 'should attach to the new related view element upon selecting another widget', () => {
  281. const view = editor.editing.view;
  282. widgetToolbarRepository.register( 'fake', {
  283. items: editor.config.get( 'fake.toolbar' ),
  284. getRelatedElement: getSelectedFakeWidget
  285. } );
  286. widgetToolbarRepository.register( 'fake-child', {
  287. items: editor.config.get( 'fake.toolbar' ),
  288. getRelatedElement: getSelectedFakeChildWidget
  289. } );
  290. setData( model,
  291. '<paragraph>foo</paragraph>' +
  292. '[<fake-widget>' +
  293. '<paragraph>foo</paragraph>' +
  294. '<fake-child-widget></fake-child-widget>' +
  295. '</fake-widget>]' );
  296. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  297. const fakeChildWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake-child' ).view;
  298. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  299. const fakeChildViewElement = view.document.getRoot().getChild( 1 ).getChild( 1 );
  300. const updatePositionSpy = sinon.spy( balloon, 'add' );
  301. view.change( writer => {
  302. // [<fake-child-widget></fake-child-widget>]
  303. writer.setSelection( fakeChildViewElement, 'on' );
  304. } );
  305. expect( balloon.visibleView ).to.equal( fakeChildWidgetToolbarView );
  306. expect( updatePositionSpy.firstCall.args[ 0 ].position.target ).to.equal(
  307. view.domConverter.viewToDom( fakeChildViewElement ) );
  308. } );
  309. it( 'should not update balloon position when toolbar is in not visible stack', () => {
  310. const customView = new View();
  311. sinon.spy( balloon.view, 'pin' );
  312. widgetToolbarRepository.register( 'fake', {
  313. items: editor.config.get( 'fake.toolbar' ),
  314. getRelatedElement: getSelectedFakeWidget
  315. } );
  316. setData( model,
  317. '<paragraph>foo</paragraph>' +
  318. '[<fake-widget></fake-widget>]'
  319. );
  320. balloon.add( {
  321. stackId: 'custom',
  322. view: customView,
  323. position: { target: {} }
  324. } );
  325. balloon.showStack( 'custom' );
  326. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  327. expect( balloon.visibleView ).to.equal( customView );
  328. expect( balloon.hasView( fakeWidgetToolbarView ) ).to.equal( true );
  329. const spy = testUtils.sinon.spy( balloon, 'updatePosition' );
  330. editor.ui.fire( 'update' );
  331. sinon.assert.notCalled( spy );
  332. } );
  333. it( 'should update balloon position when stack with toolbar is switched in rotator to visible', () => {
  334. const view = editor.editing.view;
  335. const customView = new View();
  336. sinon.spy( balloon.view, 'pin' );
  337. widgetToolbarRepository.register( 'fake', {
  338. items: editor.config.get( 'fake.toolbar' ),
  339. getRelatedElement: getSelectedFakeWidget
  340. } );
  341. setData( model,
  342. '<paragraph>foo</paragraph>' +
  343. '[<fake-widget></fake-widget>]'
  344. );
  345. const fakeViewElement = view.document.getRoot().getChild( 1 );
  346. const fakeDomElement = editor.editing.view.domConverter.mapViewToDom( fakeViewElement );
  347. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  348. expect( balloon.view.pin.lastCall.args[ 0 ].target ).to.equal( fakeDomElement );
  349. balloon.add( {
  350. stackId: 'custom',
  351. view: customView,
  352. position: { target: {} }
  353. } );
  354. balloon.showStack( 'custom' );
  355. expect( balloon.visibleView ).to.equal( customView );
  356. expect( balloon.hasView( fakeWidgetToolbarView ) ).to.equal( true );
  357. editor.execute( 'blockQuote' );
  358. balloon.showStack( 'main' );
  359. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  360. expect( balloon.hasView( customView ) ).to.equal( true );
  361. expect( balloon.view.pin.lastCall.args[ 0 ].target ).to.not.equal( fakeDomElement );
  362. const newFakeViewElement = view.document.getRoot().getChild( 1 ).getChild( 0 );
  363. const newFakeDomElement = editor.editing.view.domConverter.mapViewToDom( newFakeViewElement );
  364. expect( balloon.view.pin.lastCall.args[ 0 ].target ).to.equal( newFakeDomElement );
  365. } );
  366. it( 'toolbar should use one of pre-defined positions when attaching to a widget', () => {
  367. const editingView = editor.editing.view;
  368. const balloonAddSpy = sinon.spy( balloon, 'add' );
  369. const defaultPositions = BalloonPanelView.defaultPositions;
  370. widgetToolbarRepository.register( 'fake', {
  371. items: editor.config.get( 'fake.toolbar' ),
  372. getRelatedElement: getSelectedFakeWidget
  373. } );
  374. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  375. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  376. const widgetViewElement = editingView.document.getRoot().getChild( 1 );
  377. sinon.assert.calledOnce( balloonAddSpy );
  378. sinon.assert.calledWithExactly( balloonAddSpy, {
  379. view: fakeWidgetToolbarView,
  380. position: {
  381. target: editingView.domConverter.mapViewToDom( widgetViewElement ),
  382. positions: [
  383. defaultPositions.northArrowSouth,
  384. defaultPositions.northArrowSouthWest,
  385. defaultPositions.northArrowSouthEast,
  386. defaultPositions.southArrowNorth,
  387. defaultPositions.southArrowNorthWest,
  388. defaultPositions.southArrowNorthEast,
  389. centeredBalloonPositionForLongWidgets
  390. ]
  391. },
  392. balloonClassName: 'ck-toolbar-container'
  393. } );
  394. } );
  395. } );
  396. } );
  397. describe( 'WidgetToolbarRepository - integration with the BalloonToolbar', () => {
  398. let clock, editor, model, balloon, balloonToolbar, widgetToolbarRepository, editorElement;
  399. testUtils.createSinonSandbox();
  400. beforeEach( () => {
  401. editorElement = document.createElement( 'div' );
  402. document.body.appendChild( editorElement );
  403. clock = testUtils.sinon.useFakeTimers();
  404. return BalloonEditor
  405. .create( editorElement, {
  406. plugins: [ Paragraph, FakeButton, WidgetToolbarRepository, FakeWidget, Bold ],
  407. balloonToolbar: [ 'bold' ],
  408. fake: {
  409. toolbar: [ 'fake_button' ]
  410. }
  411. } )
  412. .then( newEditor => {
  413. editor = newEditor;
  414. model = newEditor.model;
  415. widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
  416. balloon = editor.plugins.get( 'ContextualBalloon' );
  417. balloonToolbar = editor.plugins.get( 'BalloonToolbar' );
  418. editor.ui.focusTracker.isFocused = true;
  419. } );
  420. } );
  421. afterEach( () => {
  422. editorElement.remove();
  423. return editor.destroy();
  424. } );
  425. it( 'balloon toolbar should be hidden when the widget is selected', () => {
  426. widgetToolbarRepository.register( 'fake', {
  427. items: editor.config.get( 'fake.toolbar' ),
  428. getRelatedElement: getSelectedFakeWidget
  429. } );
  430. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  431. editor.editing.view.document.isFocused = true;
  432. setData( model, '[<fake-widget></fake-widget>]<paragraph>foo</paragraph>' );
  433. clock.tick( 200 );
  434. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  435. } );
  436. it( 'balloon toolbar should be visible when the widget is not selected', () => {
  437. widgetToolbarRepository.register( 'fake', {
  438. items: editor.config.get( 'fake.toolbar' ),
  439. getRelatedElement: getSelectedFakeWidget
  440. } );
  441. editor.editing.view.document.isFocused = true;
  442. setData( model, '<fake-widget></fake-widget><paragraph>[foo]</paragraph>' );
  443. clock.tick( 200 );
  444. expect( balloon.visibleView ).to.equal( balloonToolbar.toolbarView );
  445. } );
  446. describe( 'disableable', () => {
  447. describe( 'isEnabled', () => {
  448. it( 'is enabled by default', () => {
  449. expect( widgetToolbarRepository.isEnabled ).to.be.true;
  450. } );
  451. it( 'fires change event', () => {
  452. const spy = sinon.spy();
  453. widgetToolbarRepository.on( 'change:isEnabled', spy );
  454. widgetToolbarRepository.isEnabled = false;
  455. expect( spy.calledOnce ).to.be.true;
  456. } );
  457. } );
  458. describe( 'forceDisabled() / clearForceDisabled()', () => {
  459. it( 'forceDisabled() should disable the plugin', () => {
  460. widgetToolbarRepository.forceDisabled( 'foo' );
  461. widgetToolbarRepository.isEnabled = true;
  462. expect( widgetToolbarRepository.isEnabled ).to.be.false;
  463. } );
  464. it( 'clearForceDisabled() should enable the plugin', () => {
  465. widgetToolbarRepository.forceDisabled( 'foo' );
  466. widgetToolbarRepository.clearForceDisabled( 'foo' );
  467. expect( widgetToolbarRepository.isEnabled ).to.be.true;
  468. } );
  469. it( 'clearForceDisabled() used with wrong identifier should not enable the plugin', () => {
  470. widgetToolbarRepository.forceDisabled( 'foo' );
  471. widgetToolbarRepository.clearForceDisabled( 'bar' );
  472. widgetToolbarRepository.isEnabled = true;
  473. expect( widgetToolbarRepository.isEnabled ).to.be.false;
  474. } );
  475. it( 'using forceDisabled() twice with the same identifier should not have any effect', () => {
  476. widgetToolbarRepository.forceDisabled( 'foo' );
  477. widgetToolbarRepository.forceDisabled( 'foo' );
  478. widgetToolbarRepository.clearForceDisabled( 'foo' );
  479. expect( widgetToolbarRepository.isEnabled ).to.be.true;
  480. } );
  481. it( 'plugin is enabled only after all disables were cleared', () => {
  482. widgetToolbarRepository.forceDisabled( 'foo' );
  483. widgetToolbarRepository.forceDisabled( 'bar' );
  484. widgetToolbarRepository.clearForceDisabled( 'foo' );
  485. widgetToolbarRepository.isEnabled = true;
  486. expect( widgetToolbarRepository.isEnabled ).to.be.false;
  487. widgetToolbarRepository.clearForceDisabled( 'bar' );
  488. expect( widgetToolbarRepository.isEnabled ).to.be.true;
  489. } );
  490. it( 'plugin should remain disabled if isEnabled has a callback disabling it', () => {
  491. widgetToolbarRepository.on( 'set:isEnabled', evt => {
  492. evt.return = false;
  493. evt.stop();
  494. } );
  495. widgetToolbarRepository.forceDisabled( 'foo' );
  496. widgetToolbarRepository.clearForceDisabled( 'foo' );
  497. widgetToolbarRepository.isEnabled = true;
  498. expect( widgetToolbarRepository.isEnabled ).to.be.false;
  499. } );
  500. } );
  501. } );
  502. } );
  503. function getSelectedFakeWidget( selection ) {
  504. const viewElement = selection.getSelectedElement();
  505. if ( viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( 'fakeWidget' ) ) {
  506. return viewElement;
  507. }
  508. return null;
  509. }
  510. function getSelectedFakeChildWidget( selection ) {
  511. const viewElement = selection.getSelectedElement();
  512. if ( viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( 'fakeChildWidget' ) ) {
  513. return viewElement;
  514. }
  515. return null;
  516. }
  517. function getSelectedFakeWidgetContent( selection ) {
  518. const pos = selection.getFirstPosition();
  519. let node = pos.parent;
  520. while ( node ) {
  521. if ( node.is( 'element' ) && isWidget( node ) && node.getCustomProperty( 'fakeWidget' ) ) {
  522. return node;
  523. }
  524. node = node.parent;
  525. }
  526. return null;
  527. }
  528. // Plugin that adds fake_button to editor's component factory.
  529. class FakeButton extends Plugin {
  530. init() {
  531. this.editor.ui.componentFactory.add( 'fake_button', locale => {
  532. const view = new ButtonView( locale );
  533. view.set( {
  534. label: 'fake button'
  535. } );
  536. return view;
  537. } );
  538. }
  539. }
  540. // Simple widget plugin
  541. // It registers `<fake-widget>` block in model and represents `div` in the view.
  542. // It allows having text inside self.
  543. class FakeWidget extends Plugin {
  544. static get requires() {
  545. return [ Widget ];
  546. }
  547. init() {
  548. const editor = this.editor;
  549. const schema = editor.model.schema;
  550. schema.register( 'fake-widget', {
  551. isObject: true,
  552. isBlock: true,
  553. allowWhere: '$block'
  554. } );
  555. schema.extend( '$text', { allowIn: 'fake-widget' } );
  556. schema.extend( 'paragraph', { allowIn: 'fake-widget' } );
  557. const conversion = editor.conversion;
  558. conversion.for( 'dataDowncast' ).elementToElement( {
  559. model: 'fake-widget',
  560. view: ( modelElement, viewWriter ) => {
  561. return viewWriter.createContainerElement( 'div' );
  562. }
  563. } );
  564. conversion.for( 'editingDowncast' ).elementToElement( {
  565. model: 'fake-widget',
  566. view: ( modelElement, viewWriter ) => {
  567. const fakeWidget = viewWriter.createContainerElement( 'div' );
  568. viewWriter.setCustomProperty( 'fakeWidget', true, fakeWidget );
  569. return toWidget( fakeWidget, viewWriter, { label: 'fake-widget' } );
  570. }
  571. } );
  572. conversion.for( 'upcast' ).elementToElement( {
  573. view: {
  574. name: 'div'
  575. },
  576. model: ( view, modelWriter ) => {
  577. return modelWriter.createElement( 'fake-widget' );
  578. }
  579. } );
  580. }
  581. }
  582. // A simple child widget plugin
  583. // It registers `<fake-child-widget>` block in model and represents `div` in the view.
  584. // It allows having text inside self.
  585. class FakeChildWidget extends Plugin {
  586. static get requires() {
  587. return [ Widget ];
  588. }
  589. init() {
  590. const editor = this.editor;
  591. const schema = editor.model.schema;
  592. schema.register( 'fake-child-widget', {
  593. isObject: true,
  594. isBlock: true,
  595. allowWhere: '$block',
  596. allowIn: 'fake-widget'
  597. } );
  598. schema.extend( '$text', { allowIn: 'fake-child-widget' } );
  599. schema.extend( 'paragraph', { allowIn: 'fake-child-widget' } );
  600. const conversion = editor.conversion;
  601. conversion.for( 'dataDowncast' ).elementToElement( {
  602. model: 'fake-child-widget',
  603. view: ( modelElement, viewWriter ) => {
  604. return viewWriter.createContainerElement( 'div' );
  605. }
  606. } );
  607. conversion.for( 'editingDowncast' ).elementToElement( {
  608. model: 'fake-child-widget',
  609. view: ( modelElement, viewWriter ) => {
  610. const fakeWidget = viewWriter.createContainerElement( 'div' );
  611. viewWriter.setCustomProperty( 'fakeChildWidget', true, fakeWidget );
  612. return toWidget( fakeWidget, viewWriter, { label: 'fake-child-widget' } );
  613. }
  614. } );
  615. conversion.for( 'upcast' ).elementToElement( {
  616. view: {
  617. name: 'div'
  618. },
  619. model: ( view, modelWriter ) => {
  620. return modelWriter.createElement( 'fake-child-widget' );
  621. }
  622. } );
  623. }
  624. }