widgettoolbarrepository.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553
  1. /**
  2. * @license Copyright (c) 2003-2019, 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 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 { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  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. expectToThrowCKEditorError( () => {
  69. widgetToolbarRepository.register( 'fake', {
  70. items: editor.config.get( 'fake.toolbar' ),
  71. getRelatedElement: () => null
  72. } );
  73. }, /^widget-toolbar-duplicated/, editor );
  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 be removed from not visible balloon stack when the `getRelatedElement` callback returns null', () => {
  110. balloon.add( {
  111. view: new View(),
  112. stackId: 'secondary',
  113. position: {
  114. target: {}
  115. }
  116. } );
  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. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  123. expect( balloon.hasView( fakeWidgetToolbarView ) );
  124. expect( balloon.visibleView ).to.not.equal( fakeWidgetToolbarView );
  125. model.change( writer => {
  126. // Select the <paragraph>foo</paragraph>.
  127. writer.setSelection( model.document.getRoot().getChild( 0 ), 'in' );
  128. } );
  129. expect( balloon.hasView( fakeWidgetToolbarView ) ).to.equal( false );
  130. } );
  131. it( 'toolbar should be hidden when the editor ui lost focus', () => {
  132. widgetToolbarRepository.register( 'fake', {
  133. items: editor.config.get( 'fake.toolbar' ),
  134. getRelatedElement: getSelectedFakeWidget
  135. } );
  136. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  137. editor.ui.focusTracker.isFocused = false;
  138. expect( balloon.visibleView ).to.equal( null );
  139. } );
  140. it( 'toolbar should do nothing with toolbar when the editor ui lost focus but toolbar is not a visible view', () => {
  141. balloon.add( {
  142. view: new View(),
  143. stackId: 'secondary',
  144. position: {
  145. target: {}
  146. }
  147. } );
  148. widgetToolbarRepository.register( 'fake', {
  149. items: editor.config.get( 'fake.toolbar' ),
  150. getRelatedElement: getSelectedFakeWidget
  151. } );
  152. setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
  153. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  154. editor.ui.focusTracker.isFocused = false;
  155. expect( balloon.hasView( fakeWidgetToolbarView ) ).to.equal( true );
  156. } );
  157. it( 'toolbar should update its position when other widget is selected', () => {
  158. widgetToolbarRepository.register( 'fake', {
  159. items: editor.config.get( 'fake.toolbar' ),
  160. getRelatedElement: getSelectedFakeWidget
  161. } );
  162. setData( model, '[<fake-widget></fake-widget>]<fake-widget></fake-widget>' );
  163. model.change( writer => {
  164. // Select the second widget.
  165. writer.setSelection( model.document.getRoot().getChild( 1 ), 'on' );
  166. } );
  167. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  168. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  169. } );
  170. it( 'it should be possible to create a widget toolbar for content inside the widget', () => {
  171. widgetToolbarRepository.register( 'fake', {
  172. items: editor.config.get( 'fake.toolbar' ),
  173. getRelatedElement: getSelectedFakeWidgetContent
  174. } );
  175. setData( model, '<fake-widget>[foo]</fake-widget>' );
  176. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  177. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  178. } );
  179. it( 'toolbar should not engage when is in the balloon yet invisible', () => {
  180. widgetToolbarRepository.register( 'fake', {
  181. items: editor.config.get( 'fake.toolbar' ),
  182. getRelatedElement: getSelectedFakeWidget
  183. } );
  184. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  185. setData( model, '[<fake-widget></fake-widget>]' );
  186. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  187. const lastView = new View();
  188. lastView.element = document.createElement( 'div' );
  189. balloon.add( {
  190. view: lastView,
  191. position: {
  192. target: document.body
  193. }
  194. } );
  195. expect( balloon.visibleView ).to.equal( lastView );
  196. editor.ui.fire( 'update' );
  197. expect( balloon.visibleView ).to.equal( lastView );
  198. } );
  199. // #60
  200. it( 'should show up only for the related element which is deepest in the view document', () => {
  201. // The point of this widget is to provide a getRelatedElement function that
  202. // returns a super–shallow related element which is ignored but satisfies code coverage.
  203. widgetToolbarRepository.register( 'dummy', {
  204. items: editor.config.get( 'fake.toolbar' ),
  205. getRelatedElement: () => editor.editing.view.document.getRoot()
  206. } );
  207. widgetToolbarRepository.register( 'fake', {
  208. items: editor.config.get( 'fake.toolbar' ),
  209. getRelatedElement: getSelectedFakeWidget
  210. } );
  211. widgetToolbarRepository.register( 'fake-child', {
  212. items: editor.config.get( 'fake.toolbar' ),
  213. getRelatedElement: getSelectedFakeChildWidget
  214. } );
  215. setData( model,
  216. '<paragraph>foo</paragraph>' +
  217. '<fake-widget>' +
  218. '<paragraph>foo</paragraph>' +
  219. '[<fake-child-widget></fake-child-widget>]' +
  220. '</fake-widget>' );
  221. const fakeChildWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake-child' ).view;
  222. expect( balloon.visibleView ).to.equal( fakeChildWidgetToolbarView );
  223. } );
  224. // #60
  225. it( 'should attach to the new related view element upon selecting another widget', () => {
  226. const view = editor.editing.view;
  227. widgetToolbarRepository.register( 'fake', {
  228. items: editor.config.get( 'fake.toolbar' ),
  229. getRelatedElement: getSelectedFakeWidget
  230. } );
  231. widgetToolbarRepository.register( 'fake-child', {
  232. items: editor.config.get( 'fake.toolbar' ),
  233. getRelatedElement: getSelectedFakeChildWidget
  234. } );
  235. setData( model,
  236. '<paragraph>foo</paragraph>' +
  237. '[<fake-widget>' +
  238. '<paragraph>foo</paragraph>' +
  239. '<fake-child-widget></fake-child-widget>' +
  240. '</fake-widget>]' );
  241. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  242. const fakeChildWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake-child' ).view;
  243. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  244. const fakeChildViewElement = view.document.getRoot().getChild( 1 ).getChild( 1 );
  245. const updatePositionSpy = sinon.spy( balloon, 'add' );
  246. view.change( writer => {
  247. // [<fake-child-widget></fake-child-widget>]
  248. writer.setSelection( fakeChildViewElement, 'on' );
  249. } );
  250. expect( balloon.visibleView ).to.equal( fakeChildWidgetToolbarView );
  251. expect( updatePositionSpy.firstCall.args[ 0 ].position.target ).to.equal(
  252. view.domConverter.viewToDom( fakeChildViewElement ) );
  253. } );
  254. } );
  255. } );
  256. describe( 'WidgetToolbarRepository - integration with the BalloonToolbar', () => {
  257. let clock, editor, model, balloon, balloonToolbar, widgetToolbarRepository, editorElement;
  258. testUtils.createSinonSandbox();
  259. beforeEach( () => {
  260. editorElement = document.createElement( 'div' );
  261. document.body.appendChild( editorElement );
  262. clock = testUtils.sinon.useFakeTimers();
  263. return BalloonEditor
  264. .create( editorElement, {
  265. plugins: [ Paragraph, FakeButton, WidgetToolbarRepository, FakeWidget, Bold ],
  266. balloonToolbar: [ 'bold' ],
  267. fake: {
  268. toolbar: [ 'fake_button' ]
  269. }
  270. } )
  271. .then( newEditor => {
  272. editor = newEditor;
  273. model = newEditor.model;
  274. widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
  275. balloon = editor.plugins.get( 'ContextualBalloon' );
  276. balloonToolbar = editor.plugins.get( 'BalloonToolbar' );
  277. editor.ui.focusTracker.isFocused = true;
  278. } );
  279. } );
  280. afterEach( () => {
  281. editorElement.remove();
  282. return editor.destroy();
  283. } );
  284. it( 'balloon toolbar should be hidden when the widget is selected', () => {
  285. widgetToolbarRepository.register( 'fake', {
  286. items: editor.config.get( 'fake.toolbar' ),
  287. getRelatedElement: getSelectedFakeWidget,
  288. } );
  289. const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
  290. editor.editing.view.document.isFocused = true;
  291. setData( model, '[<fake-widget></fake-widget>]<paragraph>foo</paragraph>' );
  292. clock.tick( 200 );
  293. expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
  294. } );
  295. it( 'balloon toolbar should be visible when the widget is not selected', () => {
  296. widgetToolbarRepository.register( 'fake', {
  297. items: editor.config.get( 'fake.toolbar' ),
  298. getRelatedElement: getSelectedFakeWidget
  299. } );
  300. editor.editing.view.document.isFocused = true;
  301. setData( model, '<fake-widget></fake-widget><paragraph>[foo]</paragraph>' );
  302. clock.tick( 200 );
  303. expect( balloon.visibleView ).to.equal( balloonToolbar.toolbarView );
  304. } );
  305. } );
  306. function getSelectedFakeWidget( selection ) {
  307. const viewElement = selection.getSelectedElement();
  308. if ( viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( 'fakeWidget' ) ) {
  309. return viewElement;
  310. }
  311. return null;
  312. }
  313. function getSelectedFakeChildWidget( selection ) {
  314. const viewElement = selection.getSelectedElement();
  315. if ( viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( 'fakeChildWidget' ) ) {
  316. return viewElement;
  317. }
  318. return null;
  319. }
  320. function getSelectedFakeWidgetContent( selection ) {
  321. const pos = selection.getFirstPosition();
  322. let node = pos.parent;
  323. while ( node ) {
  324. if ( node.is( 'element' ) && isWidget( node ) && node.getCustomProperty( 'fakeWidget' ) ) {
  325. return node;
  326. }
  327. node = node.parent;
  328. }
  329. return null;
  330. }
  331. // Plugin that adds fake_button to editor's component factory.
  332. class FakeButton extends Plugin {
  333. init() {
  334. this.editor.ui.componentFactory.add( 'fake_button', locale => {
  335. const view = new ButtonView( locale );
  336. view.set( {
  337. label: 'fake button'
  338. } );
  339. return view;
  340. } );
  341. }
  342. }
  343. // Simple widget plugin
  344. // It registers `<fake-widget>` block in model and represents `div` in the view.
  345. // It allows having text inside self.
  346. class FakeWidget extends Plugin {
  347. static get requires() {
  348. return [ Widget ];
  349. }
  350. init() {
  351. const editor = this.editor;
  352. const schema = editor.model.schema;
  353. schema.register( 'fake-widget', {
  354. isObject: true,
  355. isBlock: true,
  356. allowWhere: '$block'
  357. } );
  358. schema.extend( '$text', { allowIn: 'fake-widget' } );
  359. schema.extend( 'paragraph', { allowIn: 'fake-widget' } );
  360. const conversion = editor.conversion;
  361. conversion.for( 'dataDowncast' ).elementToElement( {
  362. model: 'fake-widget',
  363. view: ( modelElement, viewWriter ) => {
  364. return viewWriter.createContainerElement( 'div' );
  365. }
  366. } );
  367. conversion.for( 'editingDowncast' ).elementToElement( {
  368. model: 'fake-widget',
  369. view: ( modelElement, viewWriter ) => {
  370. const fakeWidget = viewWriter.createContainerElement( 'div' );
  371. viewWriter.setCustomProperty( 'fakeWidget', true, fakeWidget );
  372. return toWidget( fakeWidget, viewWriter, { label: 'fake-widget' } );
  373. }
  374. } );
  375. conversion.for( 'upcast' ).elementToElement( {
  376. view: {
  377. name: 'div'
  378. },
  379. model: ( view, modelWriter ) => {
  380. return modelWriter.createElement( 'fake-widget' );
  381. }
  382. } );
  383. }
  384. }
  385. // A simple child widget plugin
  386. // It registers `<fake-child-widget>` block in model and represents `div` in the view.
  387. // It allows having text inside self.
  388. class FakeChildWidget extends Plugin {
  389. static get requires() {
  390. return [ Widget ];
  391. }
  392. init() {
  393. const editor = this.editor;
  394. const schema = editor.model.schema;
  395. schema.register( 'fake-child-widget', {
  396. isObject: true,
  397. isBlock: true,
  398. allowWhere: '$block',
  399. allowIn: 'fake-widget'
  400. } );
  401. schema.extend( '$text', { allowIn: 'fake-child-widget' } );
  402. schema.extend( 'paragraph', { allowIn: 'fake-child-widget' } );
  403. const conversion = editor.conversion;
  404. conversion.for( 'dataDowncast' ).elementToElement( {
  405. model: 'fake-child-widget',
  406. view: ( modelElement, viewWriter ) => {
  407. return viewWriter.createContainerElement( 'div' );
  408. }
  409. } );
  410. conversion.for( 'editingDowncast' ).elementToElement( {
  411. model: 'fake-child-widget',
  412. view: ( modelElement, viewWriter ) => {
  413. const fakeWidget = viewWriter.createContainerElement( 'div' );
  414. viewWriter.setCustomProperty( 'fakeChildWidget', true, fakeWidget );
  415. return toWidget( fakeWidget, viewWriter, { label: 'fake-child-widget' } );
  416. }
  417. } );
  418. conversion.for( 'upcast' ).elementToElement( {
  419. view: {
  420. name: 'div'
  421. },
  422. model: ( view, modelWriter ) => {
  423. return modelWriter.createElement( 'fake-child-widget' );
  424. }
  425. } );
  426. }
  427. }