utils.js 14 KB

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