widgettoolbarrepository.js 18 KB

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