dropdownview.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  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 Rect from '@ckeditor/ckeditor5-utils/src/dom/rect';
  13. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  14. describe( 'DropdownView', () => {
  15. let view, buttonView, panelView, locale;
  16. testUtils.createSinonSandbox();
  17. beforeEach( () => {
  18. locale = { t() {} };
  19. buttonView = new ButtonView( locale );
  20. panelView = new DropdownPanelView( locale );
  21. view = new DropdownView( locale, buttonView, panelView );
  22. view.render();
  23. // The #panelView positioning depends on the utility that uses DOM Rects.
  24. // To avoid an avalanche of warnings (DOM Rects do not work until
  25. // the element is in DOM), let's allow the dropdown to render in DOM.
  26. global.document.body.appendChild( view.element );
  27. } );
  28. afterEach( () => {
  29. view.element.remove();
  30. } );
  31. describe( 'constructor()', () => {
  32. it( 'sets view#locale', () => {
  33. expect( view.locale ).to.equal( locale );
  34. } );
  35. it( 'sets view#buttonView', () => {
  36. expect( view.buttonView ).to.equal( buttonView );
  37. } );
  38. it( 'sets view#panelView', () => {
  39. expect( view.panelView ).to.equal( panelView );
  40. } );
  41. it( 'sets view#isOpen false', () => {
  42. expect( view.isOpen ).to.be.false;
  43. } );
  44. it( 'sets view#isEnabled true', () => {
  45. expect( view.isEnabled ).to.be.true;
  46. } );
  47. it( 'sets view#panelPosition "auto"', () => {
  48. expect( view.panelPosition ).to.equal( 'auto' );
  49. } );
  50. it( 'creates #focusTracker instance', () => {
  51. expect( view.focusTracker ).to.be.instanceOf( FocusTracker );
  52. } );
  53. it( 'creates #keystrokeHandler instance', () => {
  54. expect( view.keystrokes ).to.be.instanceOf( KeystrokeHandler );
  55. } );
  56. it( 'creates #element from template', () => {
  57. expect( view.element.classList.contains( 'ck' ) ).to.be.true;
  58. expect( view.element.classList.contains( 'ck-dropdown' ) ).to.be.true;
  59. expect( view.element.children ).to.have.length( 2 );
  60. expect( view.element.children[ 0 ] ).to.equal( buttonView.element );
  61. expect( view.element.children[ 1 ] ).to.equal( panelView.element );
  62. } );
  63. it( 'sets view#buttonView class', () => {
  64. expect( view.buttonView.element.classList.contains( 'ck-dropdown__button' ) ).to.be.true;
  65. } );
  66. describe( 'bindings', () => {
  67. describe( 'view#isOpen to view.buttonView#select', () => {
  68. it( 'is activated', () => {
  69. const values = [];
  70. view.on( 'change:isOpen', () => {
  71. values.push( view.isOpen );
  72. } );
  73. view.buttonView.fire( 'open' );
  74. view.buttonView.fire( 'open' );
  75. view.buttonView.fire( 'open' );
  76. expect( values ).to.have.members( [ true, false, true ] );
  77. } );
  78. } );
  79. describe( 'view.panelView#isVisible to view#isOpen', () => {
  80. it( 'is activated', () => {
  81. const values = [];
  82. view.listenTo( view.panelView, 'change:isVisible', () => {
  83. values.push( view.isOpen );
  84. } );
  85. view.isOpen = true;
  86. view.isOpen = false;
  87. view.isOpen = true;
  88. expect( values ).to.have.members( [ true, false, true ] );
  89. } );
  90. } );
  91. describe( 'view.panelView#position to view#panelPosition', () => {
  92. it( 'does not update until the dropdown is opened', () => {
  93. view.isOpen = false;
  94. view.panelPosition = 'nw';
  95. expect( panelView.position ).to.equal( 'se' );
  96. view.isOpen = true;
  97. expect( panelView.position ).to.equal( 'nw' );
  98. } );
  99. describe( 'in "auto" mode', () => {
  100. beforeEach( () => {
  101. // Bloat the panel a little to give the positioning algorithm something to
  102. // work with. If the panel was empty, any smart positioning is pointless.
  103. // Placing an empty element in the viewport isn't that hard, right?
  104. panelView.element.style.width = '200px';
  105. panelView.element.style.height = '200px';
  106. } );
  107. it( 'defaults to "south-east" when there is a plenty of space around', () => {
  108. const windowRect = new Rect( global.window );
  109. // "Put" the dropdown in the middle of the viewport.
  110. stubElementClientRect( view.buttonView.element, {
  111. top: windowRect.height / 2,
  112. left: windowRect.width / 2,
  113. width: 10,
  114. height: 10
  115. } );
  116. view.isOpen = true;
  117. expect( panelView.position ).to.equal( 'se' );
  118. } );
  119. it( 'when the dropdown in the north-west corner of the viewport', () => {
  120. stubElementClientRect( view.buttonView.element, {
  121. top: 0,
  122. left: 0,
  123. width: 100,
  124. height: 10
  125. } );
  126. view.isOpen = true;
  127. expect( panelView.position ).to.equal( 'se' );
  128. } );
  129. it( 'when the dropdown in the north-east corner of the viewport', () => {
  130. const windowRect = new Rect( global.window );
  131. stubElementClientRect( view.buttonView.element, {
  132. top: 0,
  133. left: windowRect.right - 100,
  134. width: 100,
  135. height: 10
  136. } );
  137. view.isOpen = true;
  138. expect( panelView.position ).to.equal( 'sw' );
  139. } );
  140. it( 'when the dropdown in the south-west corner of the viewport', () => {
  141. const windowRect = new Rect( global.window );
  142. stubElementClientRect( view.buttonView.element, {
  143. top: windowRect.bottom - 10,
  144. left: 0,
  145. width: 100,
  146. height: 10
  147. } );
  148. view.isOpen = true;
  149. expect( panelView.position ).to.equal( 'ne' );
  150. } );
  151. it( 'when the dropdown in the south-east corner of the viewport', () => {
  152. const windowRect = new Rect( global.window );
  153. stubElementClientRect( view.buttonView.element, {
  154. top: windowRect.bottom - 10,
  155. left: windowRect.right - 100,
  156. width: 100,
  157. height: 10
  158. } );
  159. view.isOpen = true;
  160. expect( panelView.position ).to.equal( 'nw' );
  161. } );
  162. } );
  163. } );
  164. describe( 'DOM element bindings', () => {
  165. describe( 'class', () => {
  166. it( 'reacts on view#isEnabled', () => {
  167. view.isEnabled = true;
  168. expect( view.element.classList.contains( 'ck-disabled' ) ).to.be.false;
  169. view.isEnabled = false;
  170. expect( view.element.classList.contains( 'ck-disabled' ) ).to.be.true;
  171. } );
  172. it( 'reacts on view#class', () => {
  173. view.class = 'custom-css-class';
  174. expect( view.element.classList.contains( 'custom-css-class' ) ).to.be.true;
  175. } );
  176. } );
  177. } );
  178. } );
  179. } );
  180. describe( 'render()', () => {
  181. it( 'starts listening for #keystrokes coming from #element', () => {
  182. view = new DropdownView( locale,
  183. new ButtonView( locale ),
  184. new DropdownPanelView( locale ) );
  185. const spy = sinon.spy( view.keystrokes, 'listenTo' );
  186. view.render();
  187. sinon.assert.calledOnce( spy );
  188. sinon.assert.calledWithExactly( spy, view.element );
  189. } );
  190. it( 'adds #element to #focusTracker', () => {
  191. view = new DropdownView( locale,
  192. new ButtonView( locale ),
  193. new DropdownPanelView( locale ) );
  194. const spy = sinon.spy( view.focusTracker, 'add' );
  195. view.render();
  196. sinon.assert.calledOnce( spy );
  197. sinon.assert.calledWithExactly( spy, view.element );
  198. } );
  199. describe( 'activates keyboard navigation for the dropdown', () => {
  200. it( 'so "arrowdown" opens the #panelView', () => {
  201. const keyEvtData = {
  202. keyCode: keyCodes.arrowdown,
  203. preventDefault: sinon.spy(),
  204. stopPropagation: sinon.spy()
  205. };
  206. view.buttonView.isEnabled = true;
  207. view.isOpen = true;
  208. view.keystrokes.press( keyEvtData );
  209. sinon.assert.notCalled( keyEvtData.preventDefault );
  210. sinon.assert.notCalled( keyEvtData.stopPropagation );
  211. expect( view.isOpen ).to.be.true;
  212. view.isOpen = false;
  213. view.keystrokes.press( keyEvtData );
  214. sinon.assert.calledOnce( keyEvtData.preventDefault );
  215. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  216. expect( view.isOpen ).to.be.true;
  217. } );
  218. it( 'so "arrowdown" won\'t open the #panelView when #isEnabled is false', () => {
  219. const keyEvtData = {
  220. keyCode: keyCodes.arrowdown,
  221. preventDefault: sinon.spy(),
  222. stopPropagation: sinon.spy()
  223. };
  224. view.buttonView.isEnabled = false;
  225. view.isOpen = false;
  226. view.keystrokes.press( keyEvtData );
  227. sinon.assert.notCalled( keyEvtData.preventDefault );
  228. sinon.assert.notCalled( keyEvtData.stopPropagation );
  229. expect( view.isOpen ).to.be.false;
  230. } );
  231. it( 'so "arrowright" is blocked', () => {
  232. const keyEvtData = {
  233. keyCode: keyCodes.arrowright,
  234. preventDefault: sinon.spy(),
  235. stopPropagation: sinon.spy()
  236. };
  237. view.false = true;
  238. view.keystrokes.press( keyEvtData );
  239. sinon.assert.notCalled( keyEvtData.preventDefault );
  240. sinon.assert.notCalled( keyEvtData.stopPropagation );
  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. expect( view.isOpen ).to.be.true;
  247. } );
  248. it( 'so "arrowleft" closes the #panelView', () => {
  249. const keyEvtData = {
  250. keyCode: keyCodes.arrowleft,
  251. preventDefault: sinon.spy(),
  252. stopPropagation: sinon.spy()
  253. };
  254. const spy = sinon.spy( view.buttonView, 'focus' );
  255. view.isOpen = false;
  256. view.keystrokes.press( keyEvtData );
  257. sinon.assert.notCalled( keyEvtData.preventDefault );
  258. sinon.assert.notCalled( keyEvtData.stopPropagation );
  259. sinon.assert.notCalled( spy );
  260. expect( view.isOpen ).to.be.false;
  261. view.isOpen = true;
  262. view.keystrokes.press( keyEvtData );
  263. sinon.assert.calledOnce( keyEvtData.preventDefault );
  264. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  265. sinon.assert.calledOnce( spy );
  266. expect( view.isOpen ).to.be.false;
  267. } );
  268. it( 'so "esc" closes the #panelView', () => {
  269. const keyEvtData = {
  270. keyCode: keyCodes.esc,
  271. preventDefault: sinon.spy(),
  272. stopPropagation: sinon.spy()
  273. };
  274. const spy = sinon.spy( view.buttonView, 'focus' );
  275. view.isOpen = false;
  276. view.keystrokes.press( keyEvtData );
  277. sinon.assert.notCalled( keyEvtData.preventDefault );
  278. sinon.assert.notCalled( keyEvtData.stopPropagation );
  279. sinon.assert.notCalled( spy );
  280. expect( view.isOpen ).to.be.false;
  281. view.isOpen = true;
  282. view.keystrokes.press( keyEvtData );
  283. sinon.assert.calledOnce( keyEvtData.preventDefault );
  284. sinon.assert.calledOnce( keyEvtData.stopPropagation );
  285. sinon.assert.calledOnce( spy );
  286. expect( view.isOpen ).to.be.false;
  287. } );
  288. } );
  289. } );
  290. describe( 'focus()', () => {
  291. it( 'focuses the #buttonView in DOM', () => {
  292. const spy = sinon.spy( view.buttonView, 'focus' );
  293. view.focus();
  294. sinon.assert.calledOnce( spy );
  295. } );
  296. } );
  297. } );
  298. function stubElementClientRect( element, data ) {
  299. const clientRect = Object.assign( {}, data );
  300. clientRect.right = clientRect.left + clientRect.width;
  301. clientRect.bottom = clientRect.top + clientRect.height;
  302. testUtils.sinon.stub( element, 'getBoundingClientRect' ).returns( clientRect );
  303. }