widgettoolbarrepository.js 23 KB

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