stickytoolbarview.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document */
  6. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  7. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  8. import StickyToolbarView from '../../../src/toolbar/sticky/stickytoolbarview';
  9. import ToolbarView from '../../../src/toolbar/toolbarview';
  10. import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin';
  11. testUtils.createSinonSandbox();
  12. describe( 'StickyToolbarView', () => {
  13. let view, element, limiterElement, locale, windowStub;
  14. beforeEach( () => {
  15. locale = {};
  16. limiterElement = document.createElement( 'div' );
  17. view = new StickyToolbarView( locale );
  18. element = view.element;
  19. // Dummy values just to let non–geometrical tests pass without reference errors.
  20. view._toolbarRect = { top: 10, right: 20, bottom: 30, left: 40, width: 50, height: 60 };
  21. view._limiterRect = { top: 5, right: 10, bottom: 15, left: 20, width: 25, height: 30 };
  22. windowStub = Object.create( DomEmitterMixin );
  23. Object.assign( windowStub, {
  24. scrollX: 0,
  25. scrollY: 0
  26. } );
  27. testUtils.sinon.stub( global, 'window', windowStub );
  28. document.body.appendChild( element );
  29. } );
  30. describe( 'constructor()', () => {
  31. it( 'inherits from ToolbarView', () => {
  32. expect( view ).to.be.instanceof( ToolbarView );
  33. } );
  34. it( 'sets view attributes', () => {
  35. expect( view.isSticky ).to.be.false;
  36. expect( view.limiterElement ).to.be.null;
  37. expect( view.limiterOffset ).to.equal( 50 );
  38. expect( view._isStickyToTheLimiter ).to.be.false;
  39. expect( view._marginLeft ).to.be.null;
  40. } );
  41. it( 'accepts the locale', () => {
  42. expect( view.locale ).to.equal( locale );
  43. } );
  44. it( 'creates the _elementPlaceholder', () => {
  45. expect( view._elementPlaceholder.classList.contains( 'ck-toolbar__placeholder' ) ).to.be.true;
  46. } );
  47. } );
  48. describe( 'element view bindings', () => {
  49. beforeEach( () => {
  50. view.limiterElement = limiterElement;
  51. } );
  52. it( 'update the class on view#isSticky change', () => {
  53. view.isSticky = false;
  54. expect( element.classList.contains( 'ck-toolbar_sticky' ) ).to.be.false;
  55. view.isSticky = true;
  56. expect( element.classList.contains( 'ck-toolbar_sticky' ) ).to.be.true;
  57. } );
  58. it( 'update the class on view#_isStickyToTheLimiter change', () => {
  59. view._isStickyToTheLimiter = false;
  60. expect( element.classList.contains( 'ck-toolbar_sticky_bottom-limit' ) ).to.be.false;
  61. view._isStickyToTheLimiter = true;
  62. expect( element.classList.contains( 'ck-toolbar_sticky_bottom-limit' ) ).to.be.true;
  63. } );
  64. it( 'update the styles.width on view#isSticky change', () => {
  65. testUtils.sinon.stub( view._elementPlaceholder, 'getBoundingClientRect' ).returns( { width: 100 } );
  66. view.isSticky = false;
  67. expect( element.style.width ).to.equal( '' );
  68. view.isSticky = true;
  69. expect( element.style.width ).to.equal( '100px' );
  70. } );
  71. it( 'update the styles.bottom on view#_isStickyToTheLimiter change', () => {
  72. view._isStickyToTheLimiter = false;
  73. expect( element.style.bottom ).to.equal( '' );
  74. view._isStickyToTheLimiter = true;
  75. expect( element.style.bottom ).to.equal( '50px' );
  76. } );
  77. it( 'update the styles.marginLeft on view#marginLeft change', () => {
  78. view._marginLeft = '30px';
  79. expect( element.style.marginLeft ).to.equal( '30px' );
  80. view._marginLeft = '10px';
  81. expect( element.style.marginLeft ).to.equal( '10px' );
  82. } );
  83. } );
  84. describe( '_elementPlaceholder view bindings', () => {
  85. it( 'update the styles.display on view#isSticky change', () => {
  86. view.isSticky = false;
  87. expect( view._elementPlaceholder.style.display ).to.equal( 'none' );
  88. view.isSticky = true;
  89. expect( view._elementPlaceholder.style.display ).to.equal( 'block' );
  90. } );
  91. it( 'update the styles.height on view#isSticky change', () => {
  92. view._toolbarRect = { height: 50 };
  93. view.isSticky = false;
  94. expect( view._elementPlaceholder.style.height ).to.equal( '' );
  95. view.isSticky = true;
  96. expect( view._elementPlaceholder.style.height ).to.equal( '50px' );
  97. } );
  98. } );
  99. describe( 'init()', () => {
  100. beforeEach( () => {
  101. view.limiterElement = limiterElement;
  102. } );
  103. afterEach( () => {
  104. return view.destroy();
  105. } );
  106. it( 'calls init on parent class', () => {
  107. const spy = testUtils.sinon.spy( ToolbarView.prototype, 'init' );
  108. view.init();
  109. expect( spy.calledOnce ).to.be.true;
  110. } );
  111. it( 'puts the view._elementPlaceholder before view.element', () => {
  112. view.init();
  113. expect( element.previousSibling ).to.equal( view._elementPlaceholder );
  114. } );
  115. it( 'listens to window#scroll event and calls view._checkIfShouldBeSticky', () => {
  116. const spy = testUtils.sinon.spy( view, '_checkIfShouldBeSticky' );
  117. view.init();
  118. global.window.fire( 'scroll' );
  119. expect( spy.calledOnce ).to.be.true;
  120. } );
  121. it( 'listens to view.isActive and calls view._checkIfShouldBeSticky', () => {
  122. const spy = testUtils.sinon.spy( view, '_checkIfShouldBeSticky' );
  123. expect( spy.notCalled ).to.be.true;
  124. view.init();
  125. view.isActive = true;
  126. expect( spy.calledOnce ).to.be.true;
  127. view.isActive = false;
  128. expect( spy.calledTwice ).to.be.true;
  129. } );
  130. } );
  131. describe( 'destroy()', () => {
  132. it( 'should return a promise', () => {
  133. expect( view.destroy() ).to.be.instanceof( Promise );
  134. } );
  135. it( 'can be called multiple times', done => {
  136. expect( () => {
  137. view.destroy().then( () => {
  138. return view.destroy().then( () => {
  139. done();
  140. } );
  141. } );
  142. } ).to.not.throw();
  143. } );
  144. it( 'calls destroy on parent class', () => {
  145. const spy = testUtils.sinon.spy( ToolbarView.prototype, 'destroy' );
  146. return view.destroy().then( () => {
  147. expect( spy.calledOnce ).to.be.true;
  148. } );
  149. } );
  150. it( 'removes view._elementPlaceholder from DOM', () => {
  151. return view.destroy().then( () => {
  152. expect( view._elementPlaceholder.parentNode ).to.be.null;
  153. } );
  154. } );
  155. } );
  156. describe( '_checkIfShouldBeSticky', () => {
  157. beforeEach( () => {
  158. view.limiterElement = limiterElement;
  159. } );
  160. describe( 'view.isSticky', () => {
  161. beforeEach( () => {
  162. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  163. height: 20
  164. } );
  165. } );
  166. it( 'is true if beyond the top of the viewport (toolbar is active)', () => {
  167. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 100 } );
  168. view.isActive = true;
  169. expect( view.isSticky ).to.be.false;
  170. view._checkIfShouldBeSticky();
  171. expect( view.isSticky ).to.be.true;
  172. } );
  173. it( 'is false if beyond the top of the viewport (toolbar is inactive)', () => {
  174. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 100 } );
  175. view.isActive = false;
  176. expect( view.isSticky ).to.be.false;
  177. view._checkIfShouldBeSticky();
  178. expect( view.isSticky ).to.be.false;
  179. } );
  180. it( 'is false if in the viewport (toolbar is active)', () => {
  181. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( { top: 10, height: 100 } );
  182. view.isActive = true;
  183. expect( view.isSticky ).to.be.false;
  184. view._checkIfShouldBeSticky();
  185. expect( view.isSticky ).to.be.false;
  186. } );
  187. it( 'is false if view.limiterElement is smaller than the toolbar and view.limiterOffset (toolbar is active)', () => {
  188. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 60 } );
  189. view.isActive = true;
  190. view.limiterOffset = 50;
  191. expect( view.isSticky ).to.be.false;
  192. view._checkIfShouldBeSticky();
  193. expect( view.isSticky ).to.be.false;
  194. } );
  195. } );
  196. describe( 'view._isStickyToTheLimiter', () => {
  197. it( 'is true if view.isSticky is true and reached the bottom edge of view.limiterElement', () => {
  198. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  199. top: -10,
  200. bottom: 10,
  201. height: 100
  202. } );
  203. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  204. height: 20
  205. } );
  206. view.isActive = true;
  207. expect( view.isSticky ).to.be.false;
  208. expect( view._isStickyToTheLimiter ).to.be.false;
  209. view._checkIfShouldBeSticky();
  210. expect( view.isSticky ).to.be.true;
  211. expect( view._isStickyToTheLimiter ).to.be.true;
  212. } );
  213. it( 'is false if view.isSticky is true and not reached the bottom edge of view.limiterElement', () => {
  214. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  215. top: -10,
  216. bottom: 90,
  217. height: 100
  218. } );
  219. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  220. height: 20
  221. } );
  222. view.isActive = true;
  223. expect( view.isSticky ).to.be.false;
  224. expect( view._isStickyToTheLimiter ).to.be.false;
  225. view._checkIfShouldBeSticky();
  226. expect( view.isSticky ).to.be.true;
  227. expect( view._isStickyToTheLimiter ).to.be.false;
  228. } );
  229. it( 'is false if view.isSticky is false', () => {
  230. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  231. top: 10,
  232. } );
  233. view.isActive = true;
  234. expect( view.isSticky ).to.be.false;
  235. expect( view._isStickyToTheLimiter ).to.be.false;
  236. view._checkIfShouldBeSticky();
  237. expect( view.isSticky ).to.be.false;
  238. expect( view._isStickyToTheLimiter ).to.be.false;
  239. } );
  240. } );
  241. describe( 'view._marginLeft', () => {
  242. it( 'is set if view.isSticky is true view._isStickyToTheLimiter is false', () => {
  243. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  244. top: -10,
  245. bottom: 80,
  246. height: 100
  247. } );
  248. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  249. height: 20
  250. } );
  251. Object.assign( windowStub, {
  252. scrollX: 10,
  253. scrollY: 0
  254. } );
  255. view.isActive = true;
  256. expect( view.isSticky ).to.be.false;
  257. expect( view._isStickyToTheLimiter ).to.be.false;
  258. expect( view._marginLeft ).to.equal( null );
  259. view._checkIfShouldBeSticky();
  260. expect( view.isSticky ).to.be.true;
  261. expect( view._isStickyToTheLimiter ).to.be.false;
  262. expect( view._marginLeft ).to.equal( '-10px' );
  263. } );
  264. it( 'is not set if view._isStickyToTheLimiter is true', () => {
  265. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  266. top: -10,
  267. bottom: 10,
  268. left: 60,
  269. height: 100
  270. } );
  271. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  272. height: 20
  273. } );
  274. testUtils.sinon.stub( document.body, 'getBoundingClientRect' ).returns( {
  275. left: 40
  276. } );
  277. view.isActive = true;
  278. expect( view.isSticky ).to.be.false;
  279. expect( view._isStickyToTheLimiter ).to.be.false;
  280. expect( view._marginLeft ).to.equal( null );
  281. view._checkIfShouldBeSticky();
  282. expect( view.isSticky ).to.be.true;
  283. expect( view._isStickyToTheLimiter ).to.be.true;
  284. expect( view._marginLeft ).to.equal( null );
  285. } );
  286. it( 'is not set if view.isSticky is false', () => {
  287. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  288. top: 10,
  289. } );
  290. view.isActive = true;
  291. expect( view.isSticky ).to.be.false;
  292. expect( view._isStickyToTheLimiter ).to.be.false;
  293. expect( view._marginLeft ).to.equal( null );
  294. view._checkIfShouldBeSticky();
  295. expect( view.isSticky ).to.be.false;
  296. expect( view._isStickyToTheLimiter ).to.be.false;
  297. expect( view._marginLeft ).to.equal( null );
  298. } );
  299. } );
  300. } );
  301. } );