dropdownview.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409
  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 DropdownView from '../../src/dropdown/dropdownview';
  6. import KeystrokeHandler from '@ckeditor/ckeditor5-utils/src/keystrokehandler';
  7. import FocusTracker from '@ckeditor/ckeditor5-utils/src/focustracker';
  8. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  9. import ButtonView from '../../src/button/buttonview';
  10. import DropdownPanelView from '../../src/dropdown/dropdownpanelview';
  11. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  12. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  13. describe( 'DropdownView', () => {
  14. let view, buttonView, panelView, locale;
  15. testUtils.createSinonSandbox();
  16. beforeEach( () => {
  17. locale = {
  18. uiLanguageDirection: 'ltr',
  19. t() {}
  20. };
  21. buttonView = new ButtonView( locale );
  22. panelView = new DropdownPanelView( locale );
  23. view = new DropdownView( locale, buttonView, panelView );
  24. view.render();
  25. // The #panelView positioning depends on the utility that uses DOM Rects.
  26. // To avoid an avalanche of warnings (DOM Rects do not work until
  27. // the element is in DOM), let's allow the dropdown to render in DOM.
  28. global.document.body.appendChild( view.element );
  29. } );
  30. afterEach( () => {
  31. view.element.remove();
  32. } );
  33. describe( 'constructor()', () => {
  34. it( 'sets view#locale', () => {
  35. expect( view.locale ).to.equal( locale );
  36. } );
  37. it( 'sets view#buttonView', () => {
  38. expect( view.buttonView ).to.equal( buttonView );
  39. } );
  40. it( 'sets view#panelView', () => {
  41. expect( view.panelView ).to.equal( panelView );
  42. } );
  43. it( 'sets view#isOpen false', () => {
  44. expect( view.isOpen ).to.be.false;
  45. } );
  46. it( 'sets view#isEnabled true', () => {
  47. expect( view.isEnabled ).to.be.true;
  48. } );
  49. it( 'sets view#class', () => {
  50. expect( view.class ).to.be.undefined;
  51. } );
  52. it( 'sets view#id', () => {
  53. expect( view.id ).to.be.undefined;
  54. } );
  55. it( 'sets view#panelPosition "auto"', () => {
  56. expect( view.panelPosition ).to.equal( 'auto' );
  57. } );
  58. it( 'creates #focusTracker instance', () => {
  59. expect( view.focusTracker ).to.be.instanceOf( FocusTracker );
  60. } );
  61. it( 'creates #keystrokeHandler instance', () => {
  62. expect( view.keystrokes ).to.be.instanceOf( KeystrokeHandler );
  63. } );
  64. it( 'creates #element from template', () => {
  65. expect( view.element.classList.contains( 'ck' ) ).to.be.true;
  66. expect( view.element.classList.contains( 'ck-dropdown' ) ).to.be.true;
  67. expect( view.element.children ).to.have.length( 2 );
  68. expect( view.element.children[ 0 ] ).to.equal( buttonView.element );
  69. expect( view.element.children[ 1 ] ).to.equal( panelView.element );
  70. } );
  71. it( 'sets view#buttonView class', () => {
  72. expect( view.buttonView.element.classList.contains( 'ck-dropdown__button' ) ).to.be.true;
  73. } );
  74. describe( 'bindings', () => {
  75. describe( 'view#isOpen to view.buttonView#select', () => {
  76. it( 'is activated', () => {
  77. const values = [];
  78. view.on( 'change:isOpen', () => {
  79. values.push( view.isOpen );
  80. } );
  81. view.buttonView.fire( 'open' );
  82. view.buttonView.fire( 'open' );
  83. view.buttonView.fire( 'open' );
  84. expect( values ).to.have.members( [ true, false, true ] );
  85. } );
  86. } );
  87. describe( 'view.panelView#isVisible to view#isOpen', () => {
  88. it( 'is activated', () => {
  89. const values = [];
  90. view.listenTo( view.panelView, 'change:isVisible', () => {
  91. values.push( view.isOpen );
  92. } );
  93. view.isOpen = true;
  94. view.isOpen = false;
  95. view.isOpen = true;
  96. expect( values ).to.have.members( [ true, false, true ] );
  97. } );
  98. } );
  99. describe( 'view.panelView#position to view#panelPosition', () => {
  100. it( 'does not update until the dropdown is open', () => {
  101. view.isOpen = false;
  102. view.panelPosition = 'nw';
  103. expect( panelView.position ).to.equal( 'se' );
  104. view.isOpen = true;
  105. expect( panelView.position ).to.equal( 'nw' );
  106. } );
  107. describe( 'in "auto" mode', () => {
  108. it( 'uses _getOptimalPosition() and a dedicated set of positions (LTR)', () => {
  109. const spy = testUtils.sinon.spy( DropdownView, '_getOptimalPosition' );
  110. const { southEast, southWest, northEast, northWest } = DropdownView.defaultPanelPositions;
  111. view.isOpen = true;
  112. sinon.assert.calledWithExactly( spy, sinon.match( {
  113. element: panelView.element,
  114. target: buttonView.element,
  115. positions: [
  116. southEast, southWest, northEast, northWest
  117. ],
  118. fitInViewport: true
  119. } ) );
  120. } );
  121. it( 'uses _getOptimalPosition() and a dedicated set of positions (RTL)', () => {
  122. const spy = testUtils.sinon.spy( DropdownView, '_getOptimalPosition' );
  123. const { southEast, southWest, northEast, northWest } = DropdownView.defaultPanelPositions;
  124. view.locale.uiLanguageDirection = 'rtl';
  125. view.isOpen = true;
  126. sinon.assert.calledWithExactly( spy, sinon.match( {
  127. element: panelView.element,
  128. target: buttonView.element,
  129. positions: [
  130. southWest, southEast, northWest, northEast
  131. ],
  132. fitInViewport: true
  133. } ) );
  134. } );
  135. } );
  136. } );
  137. describe( 'DOM element bindings', () => {
  138. describe( 'class', () => {
  139. it( 'reacts on view#isEnabled', () => {
  140. view.isEnabled = true;
  141. expect( view.element.classList.contains( 'ck-disabled' ) ).to.be.false;
  142. view.isEnabled = false;
  143. expect( view.element.classList.contains( 'ck-disabled' ) ).to.be.true;
  144. } );
  145. it( 'reacts on view#class', () => {
  146. view.class = 'custom-css-class';
  147. expect( view.element.classList.contains( 'custom-css-class' ) ).to.be.true;
  148. } );
  149. } );
  150. describe( 'id', () => {
  151. it( 'reacts on view#id', () => {
  152. view.id = 'foo';
  153. expect( view.element.id ).to.equal( 'foo' );
  154. } );
  155. } );
  156. } );
  157. } );
  158. } );
  159. describe( 'render()', () => {
  160. it( 'starts listening for #keystrokes coming from #element', () => {
  161. const view = new DropdownView( locale,
  162. new ButtonView( locale ),
  163. new DropdownPanelView( locale ) );
  164. const spy = sinon.spy( view.keystrokes, 'listenTo' );
  165. view.render();
  166. sinon.assert.calledOnce( spy );
  167. sinon.assert.calledWithExactly( spy, view.element );
  168. view.element.remove();
  169. } );
  170. it( 'adds #element to #focusTracker', () => {
  171. const view = new DropdownView( locale,
  172. new ButtonView( locale ),
  173. new DropdownPanelView( locale ) );
  174. const spy = sinon.spy( view.focusTracker, 'add' );
  175. view.render();
  176. sinon.assert.calledOnce( spy );
  177. sinon.assert.calledWithExactly( spy, view.element );
  178. view.element.remove();
  179. } );
  180. describe( 'activates keyboard navigation for the dropdown', () => {
  181. it( 'so "arrowdown" opens the #panelView', () => {
  182. const keyEvtData = {
  183. keyCode: keyCodes.arrowdown,
  184. preventDefault: sinon.spy(),
  185. stopPropagation: sinon.spy()
  186. };
  187. view.buttonView.isEnabled = true;
  188. view.isOpen = true;
  189. view.keystrokes.press( keyEvtData );
  190. sinon.assert.notCalled( keyEvtData.preventDefault );
  191. sinon.assert.notCalled( keyEvtData.stopPropagation );
  192. expect( view.isOpen ).to.be.true;
  193. view.isOpen = false;
  194. view.keystrokes.press( keyEvtData );
  195. sinon.assert.calledOnce( keyEvtData.preventDefault );
  196. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  197. expect( view.isOpen ).to.be.true;
  198. } );
  199. it( 'so "arrowdown" won\'t open the #panelView when #isEnabled is false', () => {
  200. const keyEvtData = {
  201. keyCode: keyCodes.arrowdown,
  202. preventDefault: sinon.spy(),
  203. stopPropagation: sinon.spy()
  204. };
  205. view.buttonView.isEnabled = false;
  206. view.isOpen = false;
  207. view.keystrokes.press( keyEvtData );
  208. sinon.assert.notCalled( keyEvtData.preventDefault );
  209. sinon.assert.notCalled( keyEvtData.stopPropagation );
  210. expect( view.isOpen ).to.be.false;
  211. } );
  212. it( 'so "arrowright" is blocked', () => {
  213. const keyEvtData = {
  214. keyCode: keyCodes.arrowright,
  215. preventDefault: sinon.spy(),
  216. stopPropagation: sinon.spy()
  217. };
  218. view.false = true;
  219. view.keystrokes.press( keyEvtData );
  220. sinon.assert.notCalled( keyEvtData.preventDefault );
  221. sinon.assert.notCalled( keyEvtData.stopPropagation );
  222. expect( view.isOpen ).to.be.false;
  223. view.isOpen = true;
  224. view.keystrokes.press( keyEvtData );
  225. sinon.assert.calledOnce( keyEvtData.preventDefault );
  226. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  227. expect( view.isOpen ).to.be.true;
  228. } );
  229. it( 'so "arrowleft" closes the #panelView', () => {
  230. const keyEvtData = {
  231. keyCode: keyCodes.arrowleft,
  232. preventDefault: sinon.spy(),
  233. stopPropagation: sinon.spy()
  234. };
  235. const spy = sinon.spy( view.buttonView, 'focus' );
  236. view.isOpen = false;
  237. view.keystrokes.press( keyEvtData );
  238. sinon.assert.notCalled( keyEvtData.preventDefault );
  239. sinon.assert.notCalled( keyEvtData.stopPropagation );
  240. sinon.assert.notCalled( spy );
  241. expect( view.isOpen ).to.be.false;
  242. view.isOpen = true;
  243. view.keystrokes.press( keyEvtData );
  244. sinon.assert.calledOnce( keyEvtData.preventDefault );
  245. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  246. sinon.assert.calledOnce( spy );
  247. expect( view.isOpen ).to.be.false;
  248. } );
  249. it( 'so "esc" closes the #panelView', () => {
  250. const keyEvtData = {
  251. keyCode: keyCodes.esc,
  252. preventDefault: sinon.spy(),
  253. stopPropagation: sinon.spy()
  254. };
  255. const spy = sinon.spy( view.buttonView, 'focus' );
  256. view.isOpen = false;
  257. view.keystrokes.press( keyEvtData );
  258. sinon.assert.notCalled( keyEvtData.preventDefault );
  259. sinon.assert.notCalled( keyEvtData.stopPropagation );
  260. sinon.assert.notCalled( spy );
  261. expect( view.isOpen ).to.be.false;
  262. view.isOpen = true;
  263. view.keystrokes.press( keyEvtData );
  264. sinon.assert.calledOnce( keyEvtData.preventDefault );
  265. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  266. sinon.assert.calledOnce( spy );
  267. expect( view.isOpen ).to.be.false;
  268. } );
  269. } );
  270. } );
  271. describe( 'focus()', () => {
  272. it( 'focuses the #buttonView in DOM', () => {
  273. const spy = sinon.spy( view.buttonView, 'focus' );
  274. view.focus();
  275. sinon.assert.calledOnce( spy );
  276. } );
  277. } );
  278. describe( 'DropdownView.defaultPanelPositions', () => {
  279. let positions, buttonRect, panelRect;
  280. beforeEach( () => {
  281. positions = DropdownView.defaultPanelPositions;
  282. buttonRect = {
  283. top: 100,
  284. bottom: 200,
  285. left: 100,
  286. right: 200,
  287. width: 100,
  288. height: 100
  289. };
  290. panelRect = {
  291. top: 0,
  292. bottom: 0,
  293. left: 0,
  294. right: 0,
  295. width: 50,
  296. height: 50
  297. };
  298. } );
  299. it( 'should have a proper length', () => {
  300. expect( Object.keys( positions ) ).to.have.length( 4 );
  301. } );
  302. it( 'should define the "southEast" position', () => {
  303. expect( positions.southEast( buttonRect, panelRect ) ).to.deep.equal( {
  304. top: 200,
  305. left: 100,
  306. name: 'se'
  307. } );
  308. } );
  309. it( 'should define the "southWest" position', () => {
  310. expect( positions.southWest( buttonRect, panelRect ) ).to.deep.equal( {
  311. top: 200,
  312. left: 150,
  313. name: 'sw'
  314. } );
  315. } );
  316. it( 'should define the "northEast" position', () => {
  317. expect( positions.northEast( buttonRect, panelRect ) ).to.deep.equal( {
  318. top: 50,
  319. left: 100,
  320. name: 'ne'
  321. } );
  322. } );
  323. it( 'should define the "northWest" position', () => {
  324. expect( positions.northWest( buttonRect, panelRect ) ).to.deep.equal( {
  325. top: 150,
  326. left: 150,
  327. name: 'nw'
  328. } );
  329. } );
  330. } );
  331. } );