toolbarview.js 27 KB

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