8
0

widgettoolbarrepository.js 25 KB

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