utils.js 14 KB

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