utils.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document Event */
  6. import utilsTestUtils from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  7. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  8. import Model from '../../src/model';
  9. import ButtonView from '../../src/button/buttonview';
  10. import DropdownView from '../../src/dropdown/dropdownview';
  11. import DropdownPanelView from '../../src/dropdown/dropdownpanelview';
  12. import SplitButtonView from '../../src/button/splitbuttonview';
  13. import View from '../../src/view';
  14. import ToolbarView from '../../src/toolbar/toolbarview';
  15. import { createDropdown, createSplitButtonDropdown, addToolbarToDropdown, addListViewToDropdown } from '../../src/dropdown/utils';
  16. import ListItemView from '../../src/list/listitemview';
  17. import ListView from '../../src/list/listview';
  18. import Collection from '../../../ckeditor5-utils/src/collection';
  19. const assertBinding = utilsTestUtils.assertBinding;
  20. describe( 'utils', () => {
  21. let locale, dropdownView;
  22. beforeEach( () => {
  23. locale = { t() {} };
  24. } );
  25. describe( 'createDropdown()', () => {
  26. let model;
  27. beforeEach( () => {
  28. model = new Model();
  29. dropdownView = createDropdown( model, locale );
  30. } );
  31. it( 'accepts locale', () => {
  32. expect( dropdownView.locale ).to.equal( locale );
  33. expect( dropdownView.panelView.locale ).to.equal( locale );
  34. } );
  35. it( 'returns view', () => {
  36. expect( dropdownView ).to.be.instanceOf( DropdownView );
  37. } );
  38. it( 'creates dropdown#panelView out of DropdownPanelView', () => {
  39. expect( dropdownView.panelView ).to.be.instanceOf( DropdownPanelView );
  40. } );
  41. it( 'creates dropdown#buttonView out of ButtonView', () => {
  42. expect( dropdownView.buttonView ).to.be.instanceOf( ButtonView );
  43. } );
  44. it( 'binds button attributes to the model', () => {
  45. const modelDef = {
  46. label: 'foo',
  47. isOn: false,
  48. isEnabled: true,
  49. withText: false,
  50. tooltip: false
  51. };
  52. model = new Model( modelDef );
  53. dropdownView = createDropdown( model, locale );
  54. assertBinding( dropdownView.buttonView,
  55. modelDef,
  56. [
  57. [ model, { label: 'bar', isEnabled: false, isOn: true, withText: true, tooltip: true } ]
  58. ],
  59. { label: 'bar', isEnabled: false, isOn: true, withText: true, tooltip: true }
  60. );
  61. } );
  62. it( 'binds button#isOn do dropdown #isOpen and model #isOn', () => {
  63. const modelDef = {
  64. label: 'foo',
  65. isOn: false,
  66. isEnabled: true,
  67. withText: false,
  68. tooltip: false
  69. };
  70. model = new Model( modelDef );
  71. dropdownView = createDropdown( model, locale );
  72. dropdownView.isOpen = false;
  73. expect( dropdownView.buttonView.isOn ).to.be.false;
  74. model.isOn = true;
  75. expect( dropdownView.buttonView.isOn ).to.be.true;
  76. dropdownView.isOpen = true;
  77. expect( dropdownView.buttonView.isOn ).to.be.true;
  78. model.isOn = false;
  79. expect( dropdownView.buttonView.isOn ).to.be.true;
  80. } );
  81. it( 'binds dropdown#isEnabled to the model', () => {
  82. const modelDef = {
  83. label: 'foo',
  84. isEnabled: true,
  85. withText: false,
  86. tooltip: false
  87. };
  88. model = new Model( modelDef );
  89. dropdownView = createDropdown( model, locale );
  90. assertBinding( dropdownView,
  91. { isEnabled: true },
  92. [
  93. [ model, { isEnabled: false } ]
  94. ],
  95. { isEnabled: false }
  96. );
  97. } );
  98. describe( '#buttonView', () => {
  99. it( 'accepts locale', () => {
  100. expect( dropdownView.buttonView.locale ).to.equal( locale );
  101. } );
  102. it( 'is a ButtonView instance', () => {
  103. expect( dropdownView.buttonView ).to.be.instanceof( ButtonView );
  104. } );
  105. it( 'delegates "execute" to "select" event', () => {
  106. const spy = sinon.spy();
  107. dropdownView.buttonView.on( 'select', spy );
  108. dropdownView.buttonView.fire( 'execute' );
  109. sinon.assert.calledOnce( spy );
  110. } );
  111. } );
  112. addDefaultBehaviorTests();
  113. } );
  114. describe( 'createSplitButtonDropdown()', () => {
  115. let model;
  116. beforeEach( () => {
  117. model = new Model();
  118. dropdownView = createSplitButtonDropdown( model, locale );
  119. } );
  120. it( 'accepts locale', () => {
  121. expect( dropdownView.locale ).to.equal( locale );
  122. expect( dropdownView.panelView.locale ).to.equal( locale );
  123. } );
  124. it( 'returns view', () => {
  125. expect( dropdownView ).to.be.instanceOf( DropdownView );
  126. } );
  127. it( 'creates dropdown#panelView out of DropdownPanelView', () => {
  128. expect( dropdownView.panelView ).to.be.instanceOf( DropdownPanelView );
  129. } );
  130. it( 'creates dropdown#buttonView out of SplitButtonView', () => {
  131. expect( dropdownView.buttonView ).to.be.instanceOf( SplitButtonView );
  132. } );
  133. it( 'binds button attributes to the model', () => {
  134. const modelDef = {
  135. label: 'foo',
  136. isOn: false,
  137. isEnabled: true,
  138. withText: false,
  139. tooltip: false
  140. };
  141. model = new Model( modelDef );
  142. dropdownView = createDropdown( model, locale );
  143. assertBinding( dropdownView.buttonView,
  144. modelDef,
  145. [
  146. [ model, { label: 'bar', isEnabled: false, isOn: true, withText: true, tooltip: true } ]
  147. ],
  148. { label: 'bar', isEnabled: false, isOn: true, withText: true, tooltip: true }
  149. );
  150. } );
  151. it( 'binds button#isOn do dropdown #isOpen and model #isOn', () => {
  152. const modelDef = {
  153. label: 'foo',
  154. isOn: false,
  155. isEnabled: true,
  156. withText: false,
  157. tooltip: false
  158. };
  159. model = new Model( modelDef );
  160. dropdownView = createDropdown( model, locale );
  161. dropdownView.isOpen = false;
  162. expect( dropdownView.buttonView.isOn ).to.be.false;
  163. model.isOn = true;
  164. expect( dropdownView.buttonView.isOn ).to.be.true;
  165. dropdownView.isOpen = true;
  166. expect( dropdownView.buttonView.isOn ).to.be.true;
  167. model.isOn = false;
  168. expect( dropdownView.buttonView.isOn ).to.be.true;
  169. } );
  170. it( 'binds dropdown#isEnabled to the model', () => {
  171. const modelDef = {
  172. label: 'foo',
  173. isEnabled: true,
  174. withText: false,
  175. tooltip: false
  176. };
  177. model = new Model( modelDef );
  178. dropdownView = createDropdown( model, locale );
  179. assertBinding( dropdownView,
  180. { isEnabled: true },
  181. [
  182. [ model, { isEnabled: false } ]
  183. ],
  184. { isEnabled: false }
  185. );
  186. } );
  187. describe( '#buttonView', () => {
  188. it( 'accepts locale', () => {
  189. expect( dropdownView.buttonView.locale ).to.equal( locale );
  190. } );
  191. it( 'returns SplitButtonView instance', () => {
  192. expect( dropdownView.buttonView ).to.be.instanceof( SplitButtonView );
  193. } );
  194. } );
  195. addDefaultBehaviorTests();
  196. } );
  197. describe( 'addToolbarToDropdown()', () => {
  198. let model, buttons;
  199. beforeEach( () => {
  200. buttons = [ '<svg>foo</svg>', '<svg>bar</svg>' ].map( icon => {
  201. const button = new ButtonView();
  202. button.icon = icon;
  203. return button;
  204. } );
  205. model = new Model( { isVertical: true } );
  206. dropdownView = createDropdown( model, locale );
  207. addToolbarToDropdown( dropdownView, buttons, model );
  208. dropdownView.render();
  209. document.body.appendChild( dropdownView.element );
  210. } );
  211. afterEach( () => {
  212. dropdownView.element.remove();
  213. } );
  214. it( 'sets view#locale', () => {
  215. expect( dropdownView.locale ).to.equal( locale );
  216. } );
  217. it( 'sets view class', () => {
  218. expect( dropdownView.element.classList.contains( 'ck-toolbar-dropdown' ) ).to.be.true;
  219. } );
  220. describe( 'view#toolbarView', () => {
  221. it( 'is created', () => {
  222. const panelChildren = dropdownView.panelView.children;
  223. expect( panelChildren ).to.have.length( 1 );
  224. expect( panelChildren.get( 0 ) ).to.equal( dropdownView.toolbarView );
  225. expect( dropdownView.toolbarView ).to.be.instanceof( ToolbarView );
  226. } );
  227. it( 'delegates view.toolbarView.items#execute to the view', done => {
  228. dropdownView.on( 'execute', evt => {
  229. expect( evt.source ).to.equal( dropdownView.toolbarView.items.get( 0 ) );
  230. expect( evt.path ).to.deep.equal( [ dropdownView.toolbarView.items.get( 0 ), dropdownView ] );
  231. done();
  232. } );
  233. dropdownView.toolbarView.items.get( 0 ).fire( 'execute' );
  234. } );
  235. it( 'reacts on model#isVertical', () => {
  236. model.isVertical = false;
  237. expect( dropdownView.toolbarView.isVertical ).to.be.false;
  238. model.isVertical = true;
  239. expect( dropdownView.toolbarView.isVertical ).to.be.true;
  240. } );
  241. } );
  242. } );
  243. describe( 'addListViewToDropdown()', () => {
  244. let dropdownView, model, locale, items;
  245. beforeEach( () => {
  246. locale = { t() {} };
  247. items = new Collection();
  248. model = new Model( {
  249. isEnabled: true,
  250. isOn: false,
  251. label: 'foo'
  252. } );
  253. dropdownView = createDropdown( model, locale );
  254. addListViewToDropdown( dropdownView, items, model, locale );
  255. dropdownView.render();
  256. document.body.appendChild( dropdownView.element );
  257. } );
  258. afterEach( () => {
  259. dropdownView.element.remove();
  260. } );
  261. describe( 'view#listView', () => {
  262. it( 'is created', () => {
  263. const panelChildren = dropdownView.panelView.children;
  264. expect( panelChildren ).to.have.length( 1 );
  265. expect( panelChildren.get( 0 ) ).to.equal( dropdownView.listView );
  266. expect( dropdownView.listView ).to.be.instanceof( ListView );
  267. } );
  268. it( 'is bound to model#items', () => {
  269. items.add( new Model( { label: 'a', style: 'b' } ) );
  270. items.add( new Model( { label: 'c', style: 'd' } ) );
  271. expect( dropdownView.listView.items ).to.have.length( 2 );
  272. expect( dropdownView.listView.items.get( 0 ) ).to.be.instanceOf( ListItemView );
  273. expect( dropdownView.listView.items.get( 1 ).label ).to.equal( 'c' );
  274. expect( dropdownView.listView.items.get( 1 ).style ).to.equal( 'd' );
  275. items.remove( 1 );
  276. expect( dropdownView.listView.items ).to.have.length( 1 );
  277. expect( dropdownView.listView.items.get( 0 ).label ).to.equal( 'a' );
  278. expect( dropdownView.listView.items.get( 0 ).style ).to.equal( 'b' );
  279. } );
  280. it( 'binds all attributes in model#items', () => {
  281. const itemModel = new Model( { label: 'a', style: 'b', foo: 'bar', baz: 'qux' } );
  282. items.add( itemModel );
  283. const item = dropdownView.listView.items.get( 0 );
  284. expect( item.foo ).to.equal( 'bar' );
  285. expect( item.baz ).to.equal( 'qux' );
  286. itemModel.baz = 'foo?';
  287. expect( item.baz ).to.equal( 'foo?' );
  288. } );
  289. it( 'delegates view.listView#execute to the view', done => {
  290. items.add( new Model( { label: 'a', style: 'b' } ) );
  291. dropdownView.on( 'execute', evt => {
  292. expect( evt.source ).to.equal( dropdownView.listView.items.get( 0 ) );
  293. expect( evt.path ).to.deep.equal( [ dropdownView.listView.items.get( 0 ), dropdownView ] );
  294. done();
  295. } );
  296. dropdownView.listView.items.get( 0 ).fire( 'execute' );
  297. } );
  298. } );
  299. } );
  300. function addDefaultBehaviorTests() {
  301. describe( 'hasDefaultBehavior', () => {
  302. describe( 'closeDropdownOnBlur()', () => {
  303. beforeEach( () => {
  304. dropdownView.render();
  305. document.body.appendChild( dropdownView.element );
  306. } );
  307. afterEach( () => {
  308. dropdownView.element.remove();
  309. } );
  310. it( 'listens to view#isOpen and reacts to DOM events (valid target)', () => {
  311. // Open the dropdown.
  312. dropdownView.isOpen = true;
  313. // Fire event from outside of the dropdown.
  314. document.body.dispatchEvent( new Event( 'mousedown', {
  315. bubbles: true
  316. } ) );
  317. // Closed the dropdown.
  318. expect( dropdownView.isOpen ).to.be.false;
  319. // Fire event from outside of the dropdown.
  320. document.body.dispatchEvent( new Event( 'mousedown', {
  321. bubbles: true
  322. } ) );
  323. // Dropdown is still closed.
  324. expect( dropdownView.isOpen ).to.be.false;
  325. } );
  326. it( 'listens to view#isOpen and reacts to DOM events (invalid target)', () => {
  327. // Open the dropdown.
  328. dropdownView.isOpen = true;
  329. // Event from view.element should be discarded.
  330. dropdownView.element.dispatchEvent( new Event( 'mousedown', {
  331. bubbles: true
  332. } ) );
  333. // Dropdown is still open.
  334. expect( dropdownView.isOpen ).to.be.true;
  335. // Event from within view.element should be discarded.
  336. const child = document.createElement( 'div' );
  337. dropdownView.element.appendChild( child );
  338. child.dispatchEvent( new Event( 'mousedown', {
  339. bubbles: true
  340. } ) );
  341. // Dropdown is still open.
  342. expect( dropdownView.isOpen ).to.be.true;
  343. } );
  344. } );
  345. describe( 'closeDropdownOnExecute()', () => {
  346. beforeEach( () => {
  347. dropdownView.render();
  348. document.body.appendChild( dropdownView.element );
  349. } );
  350. afterEach( () => {
  351. dropdownView.element.remove();
  352. } );
  353. it( 'changes view#isOpen on view#execute', () => {
  354. dropdownView.isOpen = true;
  355. dropdownView.fire( 'execute' );
  356. expect( dropdownView.isOpen ).to.be.false;
  357. dropdownView.fire( 'execute' );
  358. expect( dropdownView.isOpen ).to.be.false;
  359. } );
  360. } );
  361. describe( 'focusDropdownContentsOnArrows()', () => {
  362. let panelChildView;
  363. beforeEach( () => {
  364. panelChildView = new View();
  365. panelChildView.setTemplate( { tag: 'div' } );
  366. panelChildView.focus = () => {};
  367. panelChildView.focusLast = () => {};
  368. // TODO: describe this as #contentView instead of #listView and #toolbarView
  369. dropdownView.panelView.children.add( panelChildView );
  370. dropdownView.render();
  371. document.body.appendChild( dropdownView.element );
  372. } );
  373. afterEach( () => {
  374. dropdownView.element.remove();
  375. } );
  376. it( '"arrowdown" focuses the #innerPanelView if dropdown is open', () => {
  377. const keyEvtData = {
  378. keyCode: keyCodes.arrowdown,
  379. preventDefault: sinon.spy(),
  380. stopPropagation: sinon.spy()
  381. };
  382. const spy = sinon.spy( panelChildView, 'focus' );
  383. dropdownView.isOpen = false;
  384. dropdownView.keystrokes.press( keyEvtData );
  385. sinon.assert.notCalled( spy );
  386. dropdownView.isOpen = true;
  387. dropdownView.keystrokes.press( keyEvtData );
  388. sinon.assert.calledOnce( spy );
  389. } );
  390. it( '"arrowup" focuses the last #item in #innerPanelView if dropdown is open', () => {
  391. const keyEvtData = {
  392. keyCode: keyCodes.arrowup,
  393. preventDefault: sinon.spy(),
  394. stopPropagation: sinon.spy()
  395. };
  396. const spy = sinon.spy( panelChildView, 'focusLast' );
  397. dropdownView.isOpen = false;
  398. dropdownView.keystrokes.press( keyEvtData );
  399. sinon.assert.notCalled( spy );
  400. dropdownView.isOpen = true;
  401. dropdownView.keystrokes.press( keyEvtData );
  402. sinon.assert.calledOnce( spy );
  403. } );
  404. } );
  405. } );
  406. }
  407. } );