8
0

focuscycler.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  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. import ViewCollection from '../src/viewcollection';
  6. import View from '../src/view';
  7. import FocusCycler from '../src/focuscycler';
  8. import KeystrokeHandler from '@ckeditor/ckeditor5-utils/src/keystrokehandler';
  9. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  10. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  11. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  12. describe( 'FocusCycler', () => {
  13. let focusables, focusTracker, cycler;
  14. testUtils.createSinonSandbox();
  15. beforeEach( () => {
  16. focusables = new ViewCollection();
  17. focusTracker = {
  18. focusedElement: null
  19. };
  20. cycler = new FocusCycler( {
  21. focusables,
  22. focusTracker
  23. } );
  24. testUtils.sinon.stub( global.window, 'getComputedStyle' );
  25. focusables.add( nonFocusable() );
  26. focusables.add( focusable() );
  27. focusables.add( focusable() );
  28. focusables.add( focusable() );
  29. focusables.add( nonFocusable() );
  30. } );
  31. describe( 'constructor()', () => {
  32. it( 'sets class properties', () => {
  33. expect( cycler.focusables ).to.equal( focusables );
  34. expect( cycler.focusTracker ).to.equal( focusTracker );
  35. } );
  36. } );
  37. describe( 'current()', () => {
  38. it( 'returns null when no view is focused', () => {
  39. expect( cycler.current ).to.equal( null );
  40. focusTracker.focusedElement = focusables.get( 2 ).element;
  41. expect( cycler.current ).to.equal( 2 );
  42. focusTracker.focusedElement = null;
  43. expect( cycler.current ).to.equal( null );
  44. } );
  45. } );
  46. describe( 'first()', () => {
  47. it( 'returns first focusable view', () => {
  48. expect( cycler.first ).to.equal( focusables.get( 1 ) );
  49. } );
  50. it( 'returns null when no focusable items', () => {
  51. focusables = new ViewCollection();
  52. cycler = new FocusCycler( { focusables, focusTracker } );
  53. focusables.add( nonFocusable() );
  54. focusables.add( nonFocusable() );
  55. expect( cycler.first ).to.be.null;
  56. } );
  57. it( 'returns null when no items', () => {
  58. focusables = new ViewCollection();
  59. cycler = new FocusCycler( { focusables, focusTracker } );
  60. expect( cycler.first ).to.be.null;
  61. } );
  62. } );
  63. describe( 'last()', () => {
  64. it( 'returns last focusable view', () => {
  65. expect( cycler.last ).to.equal( focusables.get( 3 ) );
  66. } );
  67. it( 'returns null when no focusable items', () => {
  68. focusables = new ViewCollection();
  69. cycler = new FocusCycler( { focusables, focusTracker } );
  70. focusables.add( nonFocusable() );
  71. focusables.add( nonFocusable() );
  72. expect( cycler.last ).to.be.null;
  73. } );
  74. it( 'returns null when no items', () => {
  75. focusables = new ViewCollection();
  76. cycler = new FocusCycler( { focusables, focusTracker } );
  77. expect( cycler.last ).to.be.null;
  78. } );
  79. } );
  80. describe( 'next()', () => {
  81. it( 'cycles to return the next focusable view', () => {
  82. focusTracker.focusedElement = focusables.get( 2 ).element;
  83. expect( cycler.next ).to.equal( focusables.get( 3 ) );
  84. focusTracker.focusedElement = focusables.get( 3 ).element;
  85. expect( cycler.next ).to.equal( focusables.get( 1 ) );
  86. focusTracker.focusedElement = focusables.get( 1 ).element;
  87. expect( cycler.next ).to.equal( focusables.get( 2 ) );
  88. } );
  89. it( 'focuses the first focusable view when no view is focused', () => {
  90. focusTracker.focusedElement = null;
  91. expect( cycler.next ).to.equal( focusables.get( 1 ) );
  92. } );
  93. it( 'returns null when no items', () => {
  94. focusables = new ViewCollection();
  95. cycler = new FocusCycler( { focusables, focusTracker } );
  96. expect( cycler.next ).to.be.null;
  97. } );
  98. it( 'returns null when no focusable items', () => {
  99. focusables = new ViewCollection();
  100. cycler = new FocusCycler( { focusables, focusTracker } );
  101. focusables.add( nonFocusable() );
  102. focusables.add( nonFocusable() );
  103. expect( cycler.next ).to.be.null;
  104. } );
  105. it( 'returns null if the only focusable in focusables', () => {
  106. focusables = new ViewCollection();
  107. cycler = new FocusCycler( { focusables, focusTracker } );
  108. focusables.add( nonFocusable() );
  109. focusables.add( focusable() );
  110. focusables.add( nonFocusable() );
  111. focusTracker.focusedElement = focusables.get( 1 ).element;
  112. expect( cycler.first ).to.equal( focusables.get( 1 ) );
  113. expect( cycler.next ).to.be.null;
  114. } );
  115. } );
  116. describe( 'previous()', () => {
  117. it( 'cycles to return the previous focusable view', () => {
  118. focusTracker.focusedElement = focusables.get( 1 ).element;
  119. expect( cycler.previous ).to.equal( focusables.get( 3 ) );
  120. focusTracker.focusedElement = focusables.get( 2 ).element;
  121. expect( cycler.previous ).to.equal( focusables.get( 1 ) );
  122. focusTracker.focusedElement = focusables.get( 3 ).element;
  123. expect( cycler.previous ).to.equal( focusables.get( 2 ) );
  124. } );
  125. it( 'focuses the last focusable view when no view is focused', () => {
  126. focusTracker.focusedElement = null;
  127. expect( cycler.previous ).to.equal( focusables.get( 3 ) );
  128. } );
  129. it( 'returns null when no items', () => {
  130. focusables = new ViewCollection();
  131. cycler = new FocusCycler( { focusables, focusTracker } );
  132. expect( cycler.previous ).to.be.null;
  133. } );
  134. it( 'returns null when no focusable items', () => {
  135. focusables = new ViewCollection();
  136. cycler = new FocusCycler( { focusables, focusTracker } );
  137. focusables.add( nonFocusable() );
  138. focusables.add( nonFocusable() );
  139. expect( cycler.previous ).to.be.null;
  140. } );
  141. it( 'returns null if the only focusable in focusables', () => {
  142. focusables = new ViewCollection();
  143. cycler = new FocusCycler( { focusables, focusTracker } );
  144. focusables.add( nonFocusable() );
  145. focusables.add( focusable() );
  146. focusables.add( nonFocusable() );
  147. focusTracker.focusedElement = focusables.get( 1 ).element;
  148. expect( cycler.first ).to.equal( focusables.get( 1 ) );
  149. expect( cycler.previous ).to.be.null;
  150. } );
  151. } );
  152. describe( 'focusFirst()', () => {
  153. it( 'focuses first focusable view', () => {
  154. cycler.focusFirst();
  155. sinon.assert.calledOnce( focusables.get( 1 ).focus );
  156. } );
  157. it( 'does not throw when no focusable items', () => {
  158. focusables = new ViewCollection();
  159. cycler = new FocusCycler( { focusables, focusTracker } );
  160. focusables.add( nonFocusable() );
  161. focusables.add( nonFocusable() );
  162. expect( () => {
  163. cycler.focusFirst();
  164. } ).to.not.throw();
  165. } );
  166. it( 'does not throw when no items', () => {
  167. focusables = new ViewCollection();
  168. cycler = new FocusCycler( { focusables, focusTracker } );
  169. expect( () => {
  170. cycler.focusFirst();
  171. } ).to.not.throw();
  172. } );
  173. it( 'ignores invisible items', () => {
  174. const item = focusable();
  175. focusables = new ViewCollection();
  176. focusables.add( nonFocusable() );
  177. focusables.add( focusable( true ) );
  178. focusables.add( item );
  179. cycler = new FocusCycler( { focusables, focusTracker } );
  180. cycler.focusFirst();
  181. sinon.assert.calledOnce( item.focus );
  182. } );
  183. } );
  184. describe( 'focusLast()', () => {
  185. it( 'focuses last focusable view', () => {
  186. cycler.focusLast();
  187. sinon.assert.calledOnce( focusables.get( 3 ).focus );
  188. } );
  189. it( 'does not throw when no focusable items', () => {
  190. focusables = new ViewCollection();
  191. cycler = new FocusCycler( { focusables, focusTracker } );
  192. focusables.add( nonFocusable() );
  193. focusables.add( nonFocusable() );
  194. expect( () => {
  195. cycler.focusLast();
  196. } ).to.not.throw();
  197. } );
  198. it( 'does not throw when no items', () => {
  199. focusables = new ViewCollection();
  200. cycler = new FocusCycler( { focusables, focusTracker } );
  201. expect( () => {
  202. cycler.focusLast();
  203. } ).to.not.throw();
  204. } );
  205. } );
  206. describe( 'focusNext()', () => {
  207. it( 'focuses next focusable view', () => {
  208. focusTracker.focusedElement = focusables.get( 2 ).element;
  209. cycler.focusNext();
  210. sinon.assert.calledOnce( focusables.get( 3 ).focus );
  211. } );
  212. it( 'does not throw when no focusable items', () => {
  213. focusables = new ViewCollection();
  214. cycler = new FocusCycler( { focusables, focusTracker } );
  215. focusables.add( nonFocusable() );
  216. focusables.add( nonFocusable() );
  217. expect( () => {
  218. cycler.focusNext();
  219. } ).to.not.throw();
  220. } );
  221. it( 'does not throw when no items', () => {
  222. focusables = new ViewCollection();
  223. cycler = new FocusCycler( { focusables, focusTracker } );
  224. expect( () => {
  225. cycler.focusNext();
  226. } ).to.not.throw();
  227. } );
  228. } );
  229. describe( 'focusPrevious()', () => {
  230. it( 'focuses previous focusable view', () => {
  231. focusTracker.focusedElement = focusables.get( 1 ).element;
  232. cycler.focusPrevious();
  233. sinon.assert.calledOnce( focusables.get( 3 ).focus );
  234. } );
  235. it( 'does not throw when no focusable items', () => {
  236. focusables = new ViewCollection();
  237. cycler = new FocusCycler( { focusables, focusTracker } );
  238. focusables.add( nonFocusable() );
  239. focusables.add( nonFocusable() );
  240. expect( () => {
  241. cycler.focusPrevious();
  242. } ).to.not.throw();
  243. } );
  244. it( 'does not throw when no items', () => {
  245. focusables = new ViewCollection();
  246. cycler = new FocusCycler( { focusables, focusTracker } );
  247. expect( () => {
  248. cycler.focusPrevious();
  249. } ).to.not.throw();
  250. } );
  251. } );
  252. describe( 'keystrokes', () => {
  253. it( 'creates event listeners', () => {
  254. const keystrokeHandler = new KeystrokeHandler();
  255. cycler = new FocusCycler( {
  256. focusables, focusTracker, keystrokeHandler,
  257. actions: {
  258. focusPrevious: 'arrowup',
  259. focusNext: 'arrowdown'
  260. }
  261. } );
  262. const keyEvtData = {
  263. keyCode: keyCodes.arrowup,
  264. preventDefault: sinon.spy(),
  265. stopPropagation: sinon.spy()
  266. };
  267. const spy1 = sinon.spy( cycler, 'focusPrevious' );
  268. const spy2 = sinon.spy( cycler, 'focusNext' );
  269. keystrokeHandler.press( keyEvtData );
  270. sinon.assert.calledOnce( spy1 );
  271. sinon.assert.calledOnce( keyEvtData.preventDefault );
  272. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  273. sinon.assert.notCalled( spy2 );
  274. keyEvtData.keyCode = keyCodes.arrowdown;
  275. keystrokeHandler.press( keyEvtData );
  276. sinon.assert.calledOnce( spy1 );
  277. sinon.assert.calledTwice( keyEvtData.preventDefault );
  278. sinon.assert.calledTwice( keyEvtData.stopPropagation );
  279. sinon.assert.calledOnce( spy2 );
  280. } );
  281. it( 'supports array keystroke syntax', () => {
  282. const keystrokeHandler = new KeystrokeHandler();
  283. cycler = new FocusCycler( {
  284. focusables, focusTracker, keystrokeHandler,
  285. actions: {
  286. focusPrevious: [ 'arrowup', 'arrowleft' ]
  287. }
  288. } );
  289. const keyEvtData = {
  290. keyCode: keyCodes.arrowleft,
  291. preventDefault: sinon.spy(),
  292. stopPropagation: sinon.spy()
  293. };
  294. const spy = sinon.spy( cycler, 'focusPrevious' );
  295. keystrokeHandler.press( keyEvtData );
  296. sinon.assert.calledOnce( spy );
  297. sinon.assert.calledOnce( keyEvtData.preventDefault );
  298. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  299. } );
  300. } );
  301. } );
  302. function nonFocusable( isHidden ) {
  303. const view = new View();
  304. view.element = Math.random();
  305. global.window.getComputedStyle
  306. .withArgs( view.element )
  307. .returns( {
  308. display: isHidden ? 'none' : 'block'
  309. } );
  310. return view;
  311. }
  312. function focusable( isHidden ) {
  313. const view = nonFocusable( isHidden );
  314. view.focus = sinon.spy();
  315. return view;
  316. }