utils.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  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 Collection from '@ckeditor/ckeditor5-utils/src/collection';
  9. import Model from '../../src/model';
  10. import ButtonView from '../../src/button/buttonview';
  11. import DropdownView from '../../src/dropdown/dropdownview';
  12. import DropdownPanelView from '../../src/dropdown/dropdownpanelview';
  13. import SplitButtonView from '../../src/dropdown/button/splitbuttonview';
  14. import View from '../../src/view';
  15. import ToolbarView from '../../src/toolbar/toolbarview';
  16. import { createDropdown, addToolbarToDropdown, addListToDropdown } from '../../src/dropdown/utils';
  17. import ListItemView from '../../src/list/listitemview';
  18. import ListView from '../../src/list/listview';
  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( 'creates dropdown#buttonView out of passed SplitButtonView', () => {
  43. dropdownView = createDropdown( locale, SplitButtonView );
  44. expect( dropdownView.buttonView ).to.be.instanceOf( SplitButtonView );
  45. } );
  46. it( 'binds button attributes to the model', () => {
  47. const modelDef = {
  48. label: 'foo',
  49. isOn: false,
  50. isEnabled: true,
  51. withText: false,
  52. tooltip: false
  53. };
  54. dropdownView = createDropdown( locale );
  55. dropdownView.set( modelDef );
  56. assertBinding( dropdownView.buttonView,
  57. modelDef,
  58. [
  59. [ dropdownView, { label: 'bar', isEnabled: false, isOn: true, withText: true, tooltip: true } ]
  60. ],
  61. { label: 'bar', isEnabled: false, isOn: true, withText: true, tooltip: true }
  62. );
  63. } );
  64. it( 'binds button#isOn do dropdown #isOpen and model #isOn', () => {
  65. const modelDef = {
  66. label: 'foo',
  67. isOn: false,
  68. isEnabled: true,
  69. withText: false,
  70. tooltip: false
  71. };
  72. dropdownView = createDropdown( locale );
  73. dropdownView.set( modelDef );
  74. dropdownView.isOpen = false;
  75. expect( dropdownView.buttonView.isOn ).to.be.false;
  76. dropdownView.isOn = true;
  77. expect( dropdownView.buttonView.isOn ).to.be.true;
  78. dropdownView.isOpen = true;
  79. expect( dropdownView.buttonView.isOn ).to.be.true;
  80. dropdownView.isOn = false;
  81. expect( dropdownView.buttonView.isOn ).to.be.true;
  82. } );
  83. it( 'binds dropdown#isEnabled to the model', () => {
  84. const modelDef = {
  85. label: 'foo',
  86. isEnabled: true,
  87. withText: false,
  88. tooltip: false
  89. };
  90. dropdownView = createDropdown( locale );
  91. dropdownView.set( modelDef );
  92. assertBinding( dropdownView,
  93. { isEnabled: true },
  94. [
  95. [ dropdownView, { isEnabled: false } ]
  96. ],
  97. { isEnabled: false }
  98. );
  99. } );
  100. describe( '#buttonView', () => {
  101. it( 'accepts locale', () => {
  102. expect( dropdownView.buttonView.locale ).to.equal( locale );
  103. } );
  104. it( 'is a ButtonView instance', () => {
  105. expect( dropdownView.buttonView ).to.be.instanceof( ButtonView );
  106. } );
  107. } );
  108. describe( 'hasDefaultBehavior', () => {
  109. describe( 'closeDropdownOnBlur()', () => {
  110. beforeEach( () => {
  111. dropdownView.render();
  112. document.body.appendChild( dropdownView.element );
  113. } );
  114. afterEach( () => {
  115. dropdownView.element.remove();
  116. } );
  117. it( 'listens to view#isOpen and reacts to DOM events (valid target)', () => {
  118. // Open the dropdown.
  119. dropdownView.isOpen = true;
  120. // Fire event from outside of the dropdown.
  121. document.body.dispatchEvent( new Event( 'mousedown', {
  122. bubbles: true
  123. } ) );
  124. // Closed the dropdown.
  125. expect( dropdownView.isOpen ).to.be.false;
  126. // Fire event from outside of the dropdown.
  127. document.body.dispatchEvent( new Event( 'mousedown', {
  128. bubbles: true
  129. } ) );
  130. // Dropdown is still closed.
  131. expect( dropdownView.isOpen ).to.be.false;
  132. } );
  133. it( 'listens to view#isOpen and reacts to DOM events (invalid target)', () => {
  134. // Open the dropdown.
  135. dropdownView.isOpen = true;
  136. // Event from view.element should be discarded.
  137. dropdownView.element.dispatchEvent( new Event( 'mousedown', {
  138. bubbles: true
  139. } ) );
  140. // Dropdown is still open.
  141. expect( dropdownView.isOpen ).to.be.true;
  142. // Event from within view.element should be discarded.
  143. const child = document.createElement( 'div' );
  144. dropdownView.element.appendChild( child );
  145. child.dispatchEvent( new Event( 'mousedown', {
  146. bubbles: true
  147. } ) );
  148. // Dropdown is still open.
  149. expect( dropdownView.isOpen ).to.be.true;
  150. } );
  151. } );
  152. describe( 'closeDropdownOnExecute()', () => {
  153. beforeEach( () => {
  154. dropdownView.render();
  155. document.body.appendChild( dropdownView.element );
  156. } );
  157. afterEach( () => {
  158. dropdownView.element.remove();
  159. } );
  160. it( 'changes view#isOpen on view#execute', () => {
  161. dropdownView.isOpen = true;
  162. dropdownView.fire( 'execute' );
  163. expect( dropdownView.isOpen ).to.be.false;
  164. dropdownView.fire( 'execute' );
  165. expect( dropdownView.isOpen ).to.be.false;
  166. } );
  167. } );
  168. describe( 'focusDropdownContentsOnArrows()', () => {
  169. let panelChildView;
  170. beforeEach( () => {
  171. panelChildView = new View();
  172. panelChildView.setTemplate( { tag: 'div' } );
  173. panelChildView.focus = () => {};
  174. panelChildView.focusLast = () => {};
  175. dropdownView.panelView.children.add( panelChildView );
  176. dropdownView.render();
  177. document.body.appendChild( dropdownView.element );
  178. } );
  179. afterEach( () => {
  180. dropdownView.element.remove();
  181. } );
  182. it( '"arrowdown" focuses the #innerPanelView if dropdown is open', () => {
  183. const keyEvtData = {
  184. keyCode: keyCodes.arrowdown,
  185. preventDefault: sinon.spy(),
  186. stopPropagation: sinon.spy()
  187. };
  188. const spy = sinon.spy( panelChildView, 'focus' );
  189. dropdownView.isOpen = false;
  190. dropdownView.keystrokes.press( keyEvtData );
  191. sinon.assert.notCalled( spy );
  192. dropdownView.isOpen = true;
  193. dropdownView.keystrokes.press( keyEvtData );
  194. sinon.assert.calledOnce( spy );
  195. } );
  196. it( '"arrowup" focuses the last #item in #innerPanelView if dropdown is open', () => {
  197. const keyEvtData = {
  198. keyCode: keyCodes.arrowup,
  199. preventDefault: sinon.spy(),
  200. stopPropagation: sinon.spy()
  201. };
  202. const spy = sinon.spy( panelChildView, 'focusLast' );
  203. dropdownView.isOpen = false;
  204. dropdownView.keystrokes.press( keyEvtData );
  205. sinon.assert.notCalled( spy );
  206. dropdownView.isOpen = true;
  207. dropdownView.keystrokes.press( keyEvtData );
  208. sinon.assert.calledOnce( spy );
  209. } );
  210. } );
  211. } );
  212. } );
  213. describe( 'addToolbarToDropdown()', () => {
  214. let buttons;
  215. beforeEach( () => {
  216. buttons = [ '<svg>foo</svg>', '<svg>bar</svg>' ].map( icon => {
  217. const button = new ButtonView();
  218. button.icon = icon;
  219. return button;
  220. } );
  221. dropdownView = createDropdown( locale );
  222. dropdownView.set( 'isVertical', true );
  223. addToolbarToDropdown( dropdownView, buttons );
  224. dropdownView.render();
  225. document.body.appendChild( dropdownView.element );
  226. } );
  227. afterEach( () => {
  228. dropdownView.element.remove();
  229. } );
  230. it( 'sets view#locale', () => {
  231. expect( dropdownView.locale ).to.equal( locale );
  232. } );
  233. it( 'sets view class', () => {
  234. expect( dropdownView.element.classList.contains( 'ck-toolbar-dropdown' ) ).to.be.true;
  235. } );
  236. describe( 'view#toolbarView', () => {
  237. it( 'is created', () => {
  238. const panelChildren = dropdownView.panelView.children;
  239. expect( panelChildren ).to.have.length( 1 );
  240. expect( panelChildren.get( 0 ) ).to.equal( dropdownView.toolbarView );
  241. expect( dropdownView.toolbarView ).to.be.instanceof( ToolbarView );
  242. } );
  243. it( 'delegates view.toolbarView.items#execute to the view', done => {
  244. dropdownView.on( 'execute', evt => {
  245. expect( evt.source ).to.equal( dropdownView.toolbarView.items.get( 0 ) );
  246. expect( evt.path ).to.deep.equal( [ dropdownView.toolbarView.items.get( 0 ), dropdownView ] );
  247. done();
  248. } );
  249. dropdownView.toolbarView.items.get( 0 ).fire( 'execute' );
  250. } );
  251. it( 'reacts on model#isVertical', () => {
  252. dropdownView.isVertical = false;
  253. expect( dropdownView.toolbarView.isVertical ).to.be.false;
  254. dropdownView.isVertical = true;
  255. expect( dropdownView.toolbarView.isVertical ).to.be.true;
  256. } );
  257. } );
  258. } );
  259. describe( 'addListToDropdown()', () => {
  260. let items;
  261. beforeEach( () => {
  262. items = new Collection();
  263. dropdownView = createDropdown( locale );
  264. dropdownView.set( {
  265. isEnabled: true,
  266. isOn: false,
  267. label: 'foo'
  268. } );
  269. addListToDropdown( dropdownView, items );
  270. dropdownView.render();
  271. document.body.appendChild( dropdownView.element );
  272. } );
  273. afterEach( () => {
  274. dropdownView.element.remove();
  275. } );
  276. describe( 'view#listView', () => {
  277. it( 'is created', () => {
  278. const panelChildren = dropdownView.panelView.children;
  279. expect( panelChildren ).to.have.length( 1 );
  280. expect( panelChildren.get( 0 ) ).to.equal( dropdownView.listView );
  281. expect( dropdownView.listView ).to.be.instanceof( ListView );
  282. } );
  283. it( 'is bound to model#items', () => {
  284. items.add( new Model( { label: 'a', style: 'b' } ) );
  285. items.add( new Model( { label: 'c', style: 'd' } ) );
  286. expect( dropdownView.listView.items ).to.have.length( 2 );
  287. expect( dropdownView.listView.items.get( 0 ) ).to.be.instanceOf( ListItemView );
  288. expect( dropdownView.listView.items.get( 1 ).label ).to.equal( 'c' );
  289. expect( dropdownView.listView.items.get( 1 ).style ).to.equal( 'd' );
  290. items.remove( 1 );
  291. expect( dropdownView.listView.items ).to.have.length( 1 );
  292. expect( dropdownView.listView.items.get( 0 ).label ).to.equal( 'a' );
  293. expect( dropdownView.listView.items.get( 0 ).style ).to.equal( 'b' );
  294. } );
  295. it( 'binds all attributes in model#items', () => {
  296. const itemModel = new Model( { label: 'a', style: 'b', foo: 'bar', baz: 'qux' } );
  297. items.add( itemModel );
  298. const item = dropdownView.listView.items.get( 0 );
  299. expect( item.foo ).to.equal( 'bar' );
  300. expect( item.baz ).to.equal( 'qux' );
  301. itemModel.baz = 'foo?';
  302. expect( item.baz ).to.equal( 'foo?' );
  303. } );
  304. it( 'delegates view.listView#execute to the view', done => {
  305. items.add( new Model( { label: 'a', style: 'b' } ) );
  306. dropdownView.on( 'execute', evt => {
  307. expect( evt.source ).to.equal( dropdownView.listView.items.get( 0 ) );
  308. expect( evt.path ).to.deep.equal( [ dropdownView.listView.items.get( 0 ), dropdownView ] );
  309. done();
  310. } );
  311. dropdownView.listView.items.get( 0 ).fire( 'execute' );
  312. } );
  313. } );
  314. } );
  315. } );