8
0

utils.js 11 KB

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