toolbarview.js 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* global document, Event, console */
  6. import ToolbarView from '../../src/toolbar/toolbarview';
  7. import ToolbarSeparatorView from '../../src/toolbar/toolbarseparatorview';
  8. import KeystrokeHandler from '@ckeditor/ckeditor5-utils/src/keystrokehandler';
  9. import ComponentFactory from '../../src/componentfactory';
  10. import FocusTracker from '@ckeditor/ckeditor5-utils/src/focustracker';
  11. import FocusCycler from '../../src/focuscycler';
  12. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  13. import ViewCollection from '../../src/viewcollection';
  14. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  15. import View from '../../src/view';
  16. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  17. import { add as addTranslations, _clear as clearTranslations } from '@ckeditor/ckeditor5-utils/src/translation-service';
  18. import Rect from '@ckeditor/ckeditor5-utils/src/dom/rect';
  19. import Locale from '@ckeditor/ckeditor5-utils/src/locale';
  20. describe( 'ToolbarView', () => {
  21. let locale, view;
  22. testUtils.createSinonSandbox();
  23. before( () => {
  24. addTranslations( 'pl', {
  25. 'Editor toolbar': 'Pasek narzędzi edytora'
  26. } );
  27. addTranslations( 'en', {
  28. 'Editor toolbar': 'Editor toolbar'
  29. } );
  30. } );
  31. after( () => {
  32. clearTranslations();
  33. } );
  34. beforeEach( () => {
  35. locale = new Locale();
  36. view = new ToolbarView( locale );
  37. view.render();
  38. } );
  39. afterEach( () => {
  40. sinon.restore();
  41. view.destroy();
  42. } );
  43. describe( 'constructor()', () => {
  44. it( 'should set view#locale', () => {
  45. expect( view.locale ).to.equal( locale );
  46. } );
  47. describe( '#options', () => {
  48. it( 'should be an empty object if none were passed', () => {
  49. expect( view.options ).to.deep.equal( {} );
  50. } );
  51. it( 'should be an empty object if none were passed', () => {
  52. const options = {
  53. foo: 'bar'
  54. };
  55. const toolbar = new ToolbarView( locale, options );
  56. expect( toolbar.options ).to.equal( options );
  57. toolbar.destroy();
  58. } );
  59. } );
  60. it( 'should create view#items collection', () => {
  61. expect( view.items ).to.be.instanceOf( ViewCollection );
  62. } );
  63. it( 'creates #focusTracker instance', () => {
  64. expect( view.focusTracker ).to.be.instanceOf( FocusTracker );
  65. } );
  66. it( 'creates #keystrokes instance', () => {
  67. expect( view.keystrokes ).to.be.instanceOf( KeystrokeHandler );
  68. } );
  69. it( 'should create view#itemsView', () => {
  70. expect( view.itemsView ).to.be.instanceOf( View );
  71. } );
  72. it( 'should create view#children collection', () => {
  73. expect( view.children ).to.be.instanceOf( ViewCollection );
  74. } );
  75. it( 'creates #_focusCycler instance', () => {
  76. expect( view._focusCycler ).to.be.instanceOf( FocusCycler );
  77. } );
  78. it( 'creates #_behavior', () => {
  79. expect( view._behavior ).to.be.an( 'object' );
  80. } );
  81. } );
  82. describe( 'template', () => {
  83. it( 'should create element from template', () => {
  84. expect( view.element.classList.contains( 'ck' ) ).to.true;
  85. expect( view.element.classList.contains( 'ck-toolbar' ) ).to.true;
  86. } );
  87. it( 'should create #itemsView from template', () => {
  88. expect( view.element.firstChild ).to.equal( view.itemsView.element );
  89. expect( view.itemsView.element.classList.contains( 'ck' ) ).to.true;
  90. expect( view.itemsView.element.classList.contains( 'ck-toolbar__items' ) ).to.true;
  91. } );
  92. describe( 'attributes', () => {
  93. it( 'should be defined', () => {
  94. expect( view.element.getAttribute( 'role' ) ).to.equal( 'toolbar' );
  95. expect( view.element.getAttribute( 'aria-label' ) ).to.equal( 'Editor toolbar' );
  96. } );
  97. it( 'should allow a custom aria-label', () => {
  98. const view = new ToolbarView( locale );
  99. view.ariaLabel = 'Custom label';
  100. view.render();
  101. expect( view.element.getAttribute( 'aria-label' ) ).to.equal( 'Custom label' );
  102. view.destroy();
  103. } );
  104. it( 'should allow the aria-label to be translated', () => {
  105. const view = new ToolbarView( new Locale( { uiLanguage: 'pl' } ) );
  106. view.render();
  107. expect( view.element.getAttribute( 'aria-label' ) ).to.equal( 'Pasek narzędzi edytora' );
  108. view.destroy();
  109. } );
  110. } );
  111. describe( 'event listeners', () => {
  112. it( 'prevent default on #mousedown', () => {
  113. const evt = new Event( 'mousedown', { bubbles: true } );
  114. const spy = sinon.spy( evt, 'preventDefault' );
  115. view.element.dispatchEvent( evt );
  116. sinon.assert.calledOnce( spy );
  117. } );
  118. } );
  119. } );
  120. describe( 'element bindings', () => {
  121. describe( 'class', () => {
  122. it( 'reacts on view#class', () => {
  123. view.class = 'foo';
  124. expect( view.element.classList.contains( 'foo' ) ).to.be.true;
  125. view.class = 'bar';
  126. expect( view.element.classList.contains( 'bar' ) ).to.be.true;
  127. view.class = false;
  128. expect( view.element.classList.contains( 'foo' ) ).to.be.false;
  129. expect( view.element.classList.contains( 'bar' ) ).to.be.false;
  130. } );
  131. } );
  132. } );
  133. describe( 'render()', () => {
  134. it( 'registers #items in #focusTracker', () => {
  135. const view = new ToolbarView( locale );
  136. const spyAdd = sinon.spy( view.focusTracker, 'add' );
  137. const spyRemove = sinon.spy( view.focusTracker, 'remove' );
  138. view.items.add( focusable() );
  139. view.items.add( focusable() );
  140. sinon.assert.notCalled( spyAdd );
  141. view.render();
  142. sinon.assert.calledTwice( spyAdd );
  143. view.items.remove( 1 );
  144. sinon.assert.calledOnce( spyRemove );
  145. view.destroy();
  146. } );
  147. it( 'starts listening for #keystrokes coming from #element', () => {
  148. const view = new ToolbarView( new Locale() );
  149. const spy = sinon.spy( view.keystrokes, 'listenTo' );
  150. view.render();
  151. sinon.assert.calledOnce( spy );
  152. sinon.assert.calledWithExactly( spy, view.element );
  153. view.destroy();
  154. } );
  155. describe( 'activates keyboard navigation for the toolbar', () => {
  156. it( 'so "arrowup" focuses previous focusable item', () => {
  157. const keyEvtData = getArrowKeyData( 'arrowup' );
  158. // No children to focus.
  159. view.keystrokes.press( keyEvtData );
  160. sinon.assert.calledOnce( keyEvtData.preventDefault );
  161. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  162. view.items.add( nonFocusable() );
  163. view.items.add( nonFocusable() );
  164. // No focusable children.
  165. view.keystrokes.press( keyEvtData );
  166. sinon.assert.calledTwice( keyEvtData.preventDefault );
  167. sinon.assert.calledTwice( keyEvtData.stopPropagation );
  168. view.items.add( focusable() );
  169. view.items.add( nonFocusable() );
  170. view.items.add( focusable() );
  171. // Mock the last item is focused.
  172. view.focusTracker.isFocused = true;
  173. view.focusTracker.focusedElement = view.items.get( 4 ).element;
  174. view.keystrokes.press( keyEvtData );
  175. sinon.assert.calledThrice( keyEvtData.preventDefault );
  176. sinon.assert.calledThrice( keyEvtData.stopPropagation );
  177. sinon.assert.calledOnce( view.items.get( 2 ).focus );
  178. } );
  179. it( 'so "arrowleft" focuses previous focusable item', () => {
  180. const keyEvtData = getArrowKeyData( 'arrowleft' );
  181. view.items.add( focusable() );
  182. view.items.add( nonFocusable() );
  183. view.items.add( focusable() );
  184. // Mock the last item is focused.
  185. view.focusTracker.isFocused = true;
  186. view.focusTracker.focusedElement = view.items.get( 2 ).element;
  187. view.keystrokes.press( keyEvtData );
  188. sinon.assert.calledOnce( view.items.get( 0 ).focus );
  189. } );
  190. it( 'so "arrowdown" focuses next focusable item', () => {
  191. const keyEvtData = getArrowKeyData( 'arrowdown' );
  192. // No children to focus.
  193. view.keystrokes.press( keyEvtData );
  194. sinon.assert.calledOnce( keyEvtData.preventDefault );
  195. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  196. view.items.add( nonFocusable() );
  197. view.items.add( nonFocusable() );
  198. // No focusable children.
  199. view.keystrokes.press( keyEvtData );
  200. sinon.assert.calledTwice( keyEvtData.preventDefault );
  201. sinon.assert.calledTwice( keyEvtData.stopPropagation );
  202. view.items.add( focusable() );
  203. view.items.add( nonFocusable() );
  204. view.items.add( focusable() );
  205. // Mock the last item is focused.
  206. view.focusTracker.isFocused = true;
  207. view.focusTracker.focusedElement = view.items.get( 4 ).element;
  208. view.keystrokes.press( keyEvtData );
  209. sinon.assert.calledThrice( keyEvtData.preventDefault );
  210. sinon.assert.calledThrice( keyEvtData.stopPropagation );
  211. sinon.assert.calledOnce( view.items.get( 2 ).focus );
  212. } );
  213. it( 'so "arrowright" focuses next focusable item', () => {
  214. const keyEvtData = getArrowKeyData( 'arrowright' );
  215. view.items.add( focusable() );
  216. view.items.add( nonFocusable() );
  217. view.items.add( focusable() );
  218. // Mock the last item is focused.
  219. view.focusTracker.isFocused = true;
  220. view.focusTracker.focusedElement = view.items.get( 0 ).element;
  221. view.keystrokes.press( keyEvtData );
  222. sinon.assert.calledOnce( view.items.get( 2 ).focus );
  223. } );
  224. } );
  225. it( 'calls _behavior#render()', () => {
  226. const view = new ToolbarView( locale );
  227. sinon.spy( view._behavior, 'render' );
  228. view.render();
  229. sinon.assert.calledOnce( view._behavior.render );
  230. sinon.assert.calledWithExactly( view._behavior.render, view );
  231. view.destroy();
  232. } );
  233. } );
  234. describe( 'destroy()', () => {
  235. it( 'destroys the feature', () => {
  236. sinon.spy( view._behavior, 'destroy' );
  237. view.destroy();
  238. sinon.assert.calledOnce( view._behavior.destroy );
  239. } );
  240. it( 'calls _behavior#destroy()', () => {
  241. sinon.spy( view._behavior, 'destroy' );
  242. view.destroy();
  243. sinon.assert.calledOnce( view._behavior.destroy );
  244. } );
  245. } );
  246. describe( 'focus()', () => {
  247. it( 'focuses the first focusable of #items in DOM', () => {
  248. // No children to focus.
  249. view.focus();
  250. // The second child is focusable.
  251. view.items.add( nonFocusable() );
  252. view.items.add( focusable() );
  253. view.items.add( nonFocusable() );
  254. view.focus();
  255. sinon.assert.calledOnce( view.items.get( 1 ).focus );
  256. } );
  257. } );
  258. describe( 'focusLast()', () => {
  259. it( 'focuses the last focusable of #items in DOM', () => {
  260. // No children to focus.
  261. view.focusLast();
  262. // The second child is focusable.
  263. view.items.add( nonFocusable() );
  264. view.items.add( focusable() );
  265. view.items.add( focusable() );
  266. view.items.add( focusable() );
  267. view.items.add( nonFocusable() );
  268. view.focusLast();
  269. sinon.assert.calledOnce( view.items.get( 3 ).focus );
  270. } );
  271. } );
  272. describe( 'fillFromConfig()', () => {
  273. let factory;
  274. beforeEach( () => {
  275. factory = new ComponentFactory( {} );
  276. factory.add( 'foo', namedFactory( 'foo' ) );
  277. factory.add( 'bar', namedFactory( 'bar' ) );
  278. } );
  279. it( 'expands the config into collection', () => {
  280. view.fillFromConfig( [ 'foo', 'bar', '|', 'foo' ], factory );
  281. const items = view.items;
  282. expect( items ).to.have.length( 4 );
  283. expect( items.get( 0 ).name ).to.equal( 'foo' );
  284. expect( items.get( 1 ).name ).to.equal( 'bar' );
  285. expect( items.get( 2 ) ).to.be.instanceOf( ToolbarSeparatorView );
  286. expect( items.get( 3 ).name ).to.equal( 'foo' );
  287. } );
  288. it( 'warns if there is no such component in the factory', () => {
  289. const items = view.items;
  290. const consoleWarnStub = sinon.stub( console, 'warn' );
  291. view.fillFromConfig( [ 'foo', 'bar', 'baz' ], factory );
  292. expect( items ).to.have.length( 2 );
  293. expect( items.get( 0 ).name ).to.equal( 'foo' );
  294. expect( items.get( 1 ).name ).to.equal( 'bar' );
  295. sinon.assert.calledOnce( consoleWarnStub );
  296. sinon.assert.calledWithExactly( consoleWarnStub,
  297. sinon.match( /^toolbarview-item-unavailable/ ),
  298. { name: 'baz' }
  299. );
  300. } );
  301. } );
  302. describe( 'toolbar with static items', () => {
  303. describe( 'constructor()', () => {
  304. it( 'should set view#isVertical', () => {
  305. expect( view.isVertical ).to.be.false;
  306. } );
  307. it( 'binds itemsView#children to #items', () => {
  308. const itemA = focusable();
  309. const itemB = focusable();
  310. const itemC = focusable();
  311. view.items.add( itemA );
  312. view.items.add( itemB );
  313. view.items.add( itemC );
  314. expect( view.itemsView.children.map( i => i ) ).to.have.ordered.members( [ itemA, itemB, itemC ] );
  315. } );
  316. it( 'binds #focusables to #items', () => {
  317. const itemA = focusable();
  318. const itemB = focusable();
  319. const itemC = focusable();
  320. view.items.add( itemA );
  321. view.items.add( itemB );
  322. view.items.add( itemC );
  323. expect( view.focusables.map( i => i ) ).to.have.ordered.members( [ itemA, itemB, itemC ] );
  324. } );
  325. } );
  326. describe( 'element bindings', () => {
  327. describe( 'class', () => {
  328. it( 'reacts on view#isVertical', () => {
  329. view.isVertical = false;
  330. expect( view.element.classList.contains( 'ck-toolbar_vertical' ) ).to.be.false;
  331. view.isVertical = true;
  332. expect( view.element.classList.contains( 'ck-toolbar_vertical' ) ).to.be.true;
  333. } );
  334. } );
  335. } );
  336. } );
  337. describe( 'toolbar with a dynamic item grouping', () => {
  338. let locale, view, groupedItems, ungroupedItems, groupedItemsDropdown;
  339. beforeEach( () => {
  340. locale = new Locale();
  341. view = new ToolbarView( locale, {
  342. shouldGroupWhenFull: true
  343. } );
  344. view.render();
  345. view.element.style.width = '200px';
  346. document.body.appendChild( view.element );
  347. groupedItems = view._behavior.groupedItems;
  348. ungroupedItems = view._behavior.ungroupedItems;
  349. groupedItemsDropdown = view._behavior.groupedItemsDropdown;
  350. } );
  351. afterEach( () => {
  352. sinon.restore();
  353. view.element.remove();
  354. view.destroy();
  355. } );
  356. describe( 'constructor()', () => {
  357. it( 'extends the template with the CSS class', () => {
  358. expect( view.element.classList.contains( 'ck-toolbar_grouping' ) ).to.be.true;
  359. } );
  360. it( 'updates the UI as new #items are added', () => {
  361. sinon.spy( view._behavior, '_updateGrouping' );
  362. const itemA = focusable();
  363. const itemB = focusable();
  364. const itemC = focusable();
  365. const itemD = focusable();
  366. view.element.style.width = '200px';
  367. view.items.add( itemA );
  368. view.items.add( itemB );
  369. sinon.assert.calledTwice( view._behavior._updateGrouping );
  370. expect( ungroupedItems ).to.have.length( 2 );
  371. expect( groupedItems ).to.have.length( 0 );
  372. view.items.add( itemC );
  373. // The dropdown took some extra space.
  374. expect( ungroupedItems ).to.have.length( 1 );
  375. expect( groupedItems ).to.have.length( 2 );
  376. view.items.add( itemD, 2 );
  377. expect( ungroupedItems ).to.have.length( 1 );
  378. expect( groupedItems ).to.have.length( 3 );
  379. expect( ungroupedItems.map( i => i ) ).to.have.ordered.members( [ itemA ] );
  380. expect( groupedItems.map( i => i ) ).to.have.ordered.members( [ itemB, itemD, itemC ] );
  381. } );
  382. it( 'updates the UI as #items are removed', () => {
  383. const itemA = focusable();
  384. const itemB = focusable();
  385. const itemC = focusable();
  386. const itemD = focusable();
  387. view.element.style.width = '200px';
  388. view.items.add( itemA );
  389. view.items.add( itemB );
  390. view.items.add( itemC );
  391. view.items.add( itemD );
  392. sinon.spy( view._behavior, '_updateGrouping' );
  393. view.items.remove( 2 );
  394. expect( ungroupedItems.map( i => i ) ).to.have.ordered.members( [ itemA ] );
  395. expect( groupedItems.map( i => i ) ).to.have.ordered.members( [ itemB, itemD ] );
  396. sinon.assert.calledOnce( view._behavior._updateGrouping );
  397. view.items.remove( 0 );
  398. sinon.assert.calledTwice( view._behavior._updateGrouping );
  399. expect( ungroupedItems.map( i => i ) ).to.have.ordered.members( [ itemB, itemD ] );
  400. } );
  401. } );
  402. it( 'groups items that overflow into the dropdown', () => {
  403. const itemA = focusable();
  404. const itemB = focusable();
  405. const itemC = focusable();
  406. const itemD = focusable();
  407. view.items.add( itemA );
  408. view.items.add( itemB );
  409. view.items.add( itemC );
  410. view.items.add( itemD );
  411. expect( ungroupedItems.map( i => i ) ).to.have.ordered.members( [ itemA ] );
  412. expect( groupedItems.map( i => i ) ).to.have.ordered.members( [ itemB, itemC, itemD ] );
  413. expect( view.children ).to.have.length( 3 );
  414. expect( view.children.get( 0 ) ).to.equal( view.itemsView );
  415. expect( view.children.get( 1 ) ).to.be.instanceOf( ToolbarSeparatorView );
  416. expect( view.children.get( 2 ) ).to.equal( groupedItemsDropdown );
  417. } );
  418. it( 'ungroups items if there is enough space to display them (all)', () => {
  419. const itemA = focusable();
  420. const itemB = focusable();
  421. const itemC = focusable();
  422. const itemD = focusable();
  423. view.items.add( itemA );
  424. view.items.add( itemB );
  425. view.items.add( itemC );
  426. view.items.add( itemD );
  427. expect( ungroupedItems.map( i => i ) ).to.have.ordered.members( [ itemA ] );
  428. expect( groupedItems.map( i => i ) ).to.have.ordered.members( [ itemB, itemC, itemD ] );
  429. view.element.style.width = '350px';
  430. // Some grouped items cannot be ungrouped because there is not enough space and they will
  431. // land back in #_behavior.groupedItems after an attempt was made.
  432. view._behavior._updateGrouping();
  433. expect( ungroupedItems.map( i => i ) ).to.have.ordered.members( [ itemA, itemB, itemC ] );
  434. expect( groupedItems.map( i => i ) ).to.have.ordered.members( [ itemD ] );
  435. } );
  436. it( 'ungroups items if there is enough space to display them (some)', () => {
  437. const itemA = focusable();
  438. const itemB = focusable();
  439. const itemC = focusable();
  440. view.items.add( itemA );
  441. view.items.add( itemB );
  442. view.items.add( itemC );
  443. expect( ungroupedItems.map( i => i ) ).to.have.ordered.members( [ itemA ] );
  444. expect( groupedItems.map( i => i ) ).to.have.ordered.members( [ itemB, itemC ] );
  445. view.element.style.width = '350px';
  446. // All grouped items will be ungrouped because they fit just alright in the main space.
  447. view._behavior._updateGrouping();
  448. expect( ungroupedItems.map( i => i ) ).to.have.ordered.members( [ itemA, itemB, itemC ] );
  449. expect( groupedItems ).to.have.length( 0 );
  450. expect( view.children ).to.have.length( 1 );
  451. expect( view.children.get( 0 ) ).to.equal( view.itemsView );
  452. } );
  453. describe( 'render()', () => {
  454. let view, resizeObserverInstance, groupedItems, ungroupedItems;
  455. beforeEach( () => {
  456. function FakeResizeObserver( callback ) {
  457. this._callback = callback;
  458. }
  459. FakeResizeObserver.prototype.observe = sinon.spy();
  460. FakeResizeObserver.prototype.disconnect = sinon.spy();
  461. testUtils.sinon.stub( global.window, 'ResizeObserver' ).value( FakeResizeObserver );
  462. view = new ToolbarView( locale, {
  463. shouldGroupWhenFull: true
  464. } );
  465. view.render();
  466. resizeObserverInstance = view._behavior.resizeObserver;
  467. groupedItems = view._behavior.groupedItems;
  468. ungroupedItems = view._behavior.ungroupedItems;
  469. document.body.appendChild( view.element );
  470. } );
  471. afterEach( () => {
  472. view.element.remove();
  473. view.destroy();
  474. } );
  475. it( 'starts observing toolbar resize immediatelly after render', () => {
  476. sinon.assert.calledOnce( resizeObserverInstance.observe );
  477. sinon.assert.calledWithExactly( resizeObserverInstance.observe, view.element );
  478. } );
  479. it( 'updates the UI when the toolbar is being resized (expanding)', () => {
  480. view.element.style.width = '200px';
  481. view.items.add( focusable() );
  482. view.items.add( focusable() );
  483. view.items.add( focusable() );
  484. view.items.add( focusable() );
  485. view.items.add( focusable() );
  486. resizeObserverInstance._callback( [ { contentRect: new Rect( view.element ) } ] );
  487. expect( ungroupedItems ).to.have.length( 1 );
  488. expect( groupedItems ).to.have.length( 4 );
  489. view.element.style.width = '500px';
  490. resizeObserverInstance._callback( [ { contentRect: new Rect( view.element ) } ] );
  491. expect( ungroupedItems ).to.have.length( 5 );
  492. expect( groupedItems ).to.have.length( 0 );
  493. } );
  494. it( 'updates the UI when the toolbar is being resized (narrowing)', () => {
  495. view.element.style.width = '500px';
  496. view.items.add( focusable() );
  497. view.items.add( focusable() );
  498. view.items.add( focusable() );
  499. view.items.add( focusable() );
  500. view.items.add( focusable() );
  501. resizeObserverInstance._callback( [ { contentRect: new Rect( view.element ) } ] );
  502. expect( ungroupedItems ).to.have.length( 5 );
  503. expect( groupedItems ).to.have.length( 0 );
  504. view.element.style.width = '200px';
  505. resizeObserverInstance._callback( [ { contentRect: new Rect( view.element ) } ] );
  506. expect( ungroupedItems ).to.have.length( 1 );
  507. expect( groupedItems ).to.have.length( 4 );
  508. } );
  509. it( 'does not react to changes in height', () => {
  510. view.element.style.width = '500px';
  511. view.element.style.height = '200px';
  512. view.items.add( focusable() );
  513. view.items.add( focusable() );
  514. view.items.add( focusable() );
  515. view.items.add( focusable() );
  516. view.items.add( focusable() );
  517. sinon.spy( view._behavior, '_updateGrouping' );
  518. view.element.style.width = '500px';
  519. resizeObserverInstance._callback( [ { contentRect: new Rect( view.element ) } ] );
  520. sinon.assert.calledOnce( view._behavior._updateGrouping );
  521. view.element.style.height = '500px';
  522. resizeObserverInstance._callback( [ { contentRect: new Rect( view.element ) } ] );
  523. sinon.assert.calledOnce( view._behavior._updateGrouping );
  524. } );
  525. it( 'updates the state of grouped items upon resize', () => {
  526. testUtils.sinon.spy( view._behavior, '_updateGrouping' );
  527. sinon.assert.notCalled( view._behavior._updateGrouping );
  528. resizeObserverInstance._callback( [ { contentRect: new Rect( view.element ) } ] );
  529. sinon.assert.calledOnce( view._behavior._updateGrouping );
  530. } );
  531. } );
  532. describe( 'destroy()', () => {
  533. it( 'destroys the #groupedItemsDropdown', () => {
  534. view.element.style.width = '200px';
  535. const itemA = focusable();
  536. const itemB = focusable();
  537. const itemC = focusable();
  538. const itemD = focusable();
  539. view.items.add( itemA );
  540. view.items.add( itemB );
  541. view.items.add( itemC );
  542. view.items.add( itemD );
  543. sinon.spy( groupedItemsDropdown, 'destroy' );
  544. view.element.style.width = '500px';
  545. // The dropdown hides; it does not belong to any collection but it still exist.
  546. view._behavior._updateGrouping();
  547. view.destroy();
  548. sinon.assert.calledOnce( groupedItemsDropdown.destroy );
  549. } );
  550. it( 'disconnects the #resizeObserver', () => {
  551. view.element.style.width = '200px';
  552. const itemA = focusable();
  553. const itemB = focusable();
  554. const itemC = focusable();
  555. const itemD = focusable();
  556. view.items.add( itemA );
  557. view.items.add( itemB );
  558. view.items.add( itemC );
  559. view.items.add( itemD );
  560. sinon.spy( view._behavior.resizeObserver, 'disconnect' );
  561. view.destroy();
  562. sinon.assert.calledOnce( view._behavior.resizeObserver.disconnect );
  563. } );
  564. } );
  565. describe( 'dropdown with grouped items', () => {
  566. it( 'has proper DOM structure', () => {
  567. view.items.add( focusable() );
  568. view.items.add( focusable() );
  569. view.items.add( focusable() );
  570. view.items.add( focusable() );
  571. expect( view.children.has( groupedItemsDropdown ) ).to.be.true;
  572. expect( groupedItemsDropdown.element.classList.contains( 'ck-toolbar__grouped-dropdown' ) );
  573. expect( groupedItemsDropdown.buttonView.label ).to.equal( 'Show more items' );
  574. } );
  575. it( 'shares its toolbarView#items with grouped items', () => {
  576. view.items.add( focusable() );
  577. view.items.add( focusable() );
  578. view.items.add( focusable() );
  579. view.items.add( focusable() );
  580. expect( groupedItemsDropdown.toolbarView.items.map( i => i ) )
  581. .to.have.ordered.members( groupedItems.map( i => i ) );
  582. } );
  583. // https://github.com/ckeditor/ckeditor5/issues/5608
  584. it( 'has the proper position depending on the UI language direction (LTR UI)', () => {
  585. const locale = new Locale( { uiLanguage: 'en' } );
  586. const view = new ToolbarView( locale, { shouldGroupWhenFull: true } );
  587. view.render();
  588. expect( view._behavior.groupedItemsDropdown.panelPosition ).to.equal( 'sw' );
  589. view.destroy();
  590. } );
  591. // https://github.com/ckeditor/ckeditor5/issues/5608
  592. it( 'has the proper position depending on the UI language direction (RTL UI)', () => {
  593. const locale = new Locale( { uiLanguage: 'ar' } );
  594. const view = new ToolbarView( locale, { shouldGroupWhenFull: true } );
  595. view.render();
  596. expect( view._behavior.groupedItemsDropdown.panelPosition ).to.equal( 'se' );
  597. view.destroy();
  598. } );
  599. } );
  600. describe( 'item overflow checking logic', () => {
  601. it( 'considers the right padding of the toolbar (LTR UI)', () => {
  602. view.class = 'ck-reset_all';
  603. view.element.style.width = '210px';
  604. view.element.style.paddingLeft = '0px';
  605. view.element.style.paddingRight = '20px';
  606. view.items.add( focusable() );
  607. view.items.add( focusable() );
  608. expect( view._behavior.groupedItems ).to.have.length( 1 );
  609. } );
  610. it( 'considers the left padding of the toolbar (RTL UI)', () => {
  611. const locale = new Locale( { uiLanguage: 'ar' } );
  612. const view = new ToolbarView( locale, {
  613. shouldGroupWhenFull: true
  614. } );
  615. view.extendTemplate( {
  616. attributes: {
  617. dir: locale.uiLanguageDirection
  618. }
  619. } );
  620. view.render();
  621. document.body.appendChild( view.element );
  622. view.class = 'ck-reset_all';
  623. view.element.style.width = '210px';
  624. view.element.style.paddingLeft = '20px';
  625. view.element.style.paddingRight = '0px';
  626. view.items.add( focusable() );
  627. view.items.add( focusable() );
  628. expect( view._behavior.groupedItems ).to.have.length( 1 );
  629. view.destroy();
  630. view.element.remove();
  631. } );
  632. } );
  633. describe( 'focus management', () => {
  634. it( '#focus() focuses the dropdown when it is the only focusable', () => {
  635. sinon.spy( groupedItemsDropdown, 'focus' );
  636. view.element.style.width = '10px';
  637. const itemA = focusable();
  638. const itemB = focusable();
  639. view.items.add( itemA );
  640. view.items.add( itemB );
  641. expect( view.focusables.map( i => i ) ).to.have.ordered.members( [ groupedItemsDropdown ] );
  642. view.focus();
  643. sinon.assert.calledOnce( groupedItemsDropdown.focus );
  644. } );
  645. it( '#focusLast() focuses the dropdown when present', () => {
  646. sinon.spy( groupedItemsDropdown, 'focus' );
  647. view.element.style.width = '200px';
  648. const itemA = focusable();
  649. const itemB = focusable();
  650. const itemC = focusable();
  651. view.items.add( itemA );
  652. view.items.add( itemB );
  653. view.items.add( itemC );
  654. expect( view.focusables.map( i => i ) ).to.have.ordered.members( [ itemA, groupedItemsDropdown ] );
  655. view.focusLast();
  656. sinon.assert.calledOnce( groupedItemsDropdown.focus );
  657. view.element.remove();
  658. } );
  659. } );
  660. } );
  661. } );
  662. function focusable() {
  663. const view = nonFocusable();
  664. view.label = 'focusable';
  665. view.focus = sinon.stub().callsFake( () => {
  666. view.element.focus();
  667. } );
  668. view.extendTemplate( {
  669. attributes: {
  670. tabindex: -1
  671. }
  672. } );
  673. return view;
  674. }
  675. function nonFocusable() {
  676. const view = new View();
  677. view.set( 'label', 'non-focusable' );
  678. const bind = view.bindTemplate;
  679. view.setTemplate( {
  680. tag: 'div',
  681. attributes: {
  682. style: {
  683. padding: '0',
  684. margin: '0',
  685. width: '100px',
  686. height: '100px',
  687. background: 'rgba(255,0,0,.3)'
  688. }
  689. },
  690. children: [
  691. {
  692. text: bind.to( 'label' )
  693. }
  694. ]
  695. } );
  696. return view;
  697. }
  698. function namedFactory( name ) {
  699. return locale => {
  700. const view = new View( locale );
  701. view.name = name;
  702. view.element = document.createElement( 'a' );
  703. return view;
  704. };
  705. }
  706. function getArrowKeyData( arrow ) {
  707. return {
  708. keyCode: keyCodes[ arrow ],
  709. preventDefault: sinon.spy(),
  710. stopPropagation: sinon.spy()
  711. };
  712. }