stickytoolbarview.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384
  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( 'calls destroy on parent class', () => {
  136. const spy = testUtils.sinon.spy( ToolbarView.prototype, 'destroy' );
  137. return view.destroy().then( () => {
  138. expect( spy.calledOnce ).to.be.true;
  139. } );
  140. } );
  141. it( 'removes view._elementPlaceholder from DOM', () => {
  142. return view.destroy().then( () => {
  143. expect( view._elementPlaceholder.parentNode ).to.be.null;
  144. } );
  145. } );
  146. } );
  147. describe( '_checkIfShouldBeSticky', () => {
  148. beforeEach( () => {
  149. view.limiterElement = limiterElement;
  150. } );
  151. describe( 'view.isSticky', () => {
  152. beforeEach( () => {
  153. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  154. height: 20
  155. } );
  156. } );
  157. it( 'is true if beyond the top of the viewport (toolbar is active)', () => {
  158. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 100 } );
  159. view.isActive = true;
  160. expect( view.isSticky ).to.be.false;
  161. view._checkIfShouldBeSticky();
  162. expect( view.isSticky ).to.be.true;
  163. } );
  164. it( 'is false if beyond the top of the viewport (toolbar is inactive)', () => {
  165. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 100 } );
  166. view.isActive = false;
  167. expect( view.isSticky ).to.be.false;
  168. view._checkIfShouldBeSticky();
  169. expect( view.isSticky ).to.be.false;
  170. } );
  171. it( 'is false if in the viewport (toolbar is active)', () => {
  172. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( { top: 10, height: 100 } );
  173. view.isActive = true;
  174. expect( view.isSticky ).to.be.false;
  175. view._checkIfShouldBeSticky();
  176. expect( view.isSticky ).to.be.false;
  177. } );
  178. it( 'is false if view.limiterElement is smaller than the toolbar and view.limiterOffset (toolbar is active)', () => {
  179. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 60 } );
  180. view.isActive = true;
  181. view.limiterOffset = 50;
  182. expect( view.isSticky ).to.be.false;
  183. view._checkIfShouldBeSticky();
  184. expect( view.isSticky ).to.be.false;
  185. } );
  186. } );
  187. describe( 'view._isStickyToTheLimiter', () => {
  188. it( 'is true if view.isSticky is true and reached the bottom edge of view.limiterElement', () => {
  189. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  190. top: -10,
  191. bottom: 10,
  192. height: 100
  193. } );
  194. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  195. height: 20
  196. } );
  197. view.isActive = true;
  198. expect( view.isSticky ).to.be.false;
  199. expect( view._isStickyToTheLimiter ).to.be.false;
  200. view._checkIfShouldBeSticky();
  201. expect( view.isSticky ).to.be.true;
  202. expect( view._isStickyToTheLimiter ).to.be.true;
  203. } );
  204. it( 'is false if view.isSticky is true and not reached the bottom edge of view.limiterElement', () => {
  205. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  206. top: -10,
  207. bottom: 90,
  208. height: 100
  209. } );
  210. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  211. height: 20
  212. } );
  213. view.isActive = true;
  214. expect( view.isSticky ).to.be.false;
  215. expect( view._isStickyToTheLimiter ).to.be.false;
  216. view._checkIfShouldBeSticky();
  217. expect( view.isSticky ).to.be.true;
  218. expect( view._isStickyToTheLimiter ).to.be.false;
  219. } );
  220. it( 'is false if view.isSticky is false', () => {
  221. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  222. top: 10,
  223. } );
  224. view.isActive = true;
  225. expect( view.isSticky ).to.be.false;
  226. expect( view._isStickyToTheLimiter ).to.be.false;
  227. view._checkIfShouldBeSticky();
  228. expect( view.isSticky ).to.be.false;
  229. expect( view._isStickyToTheLimiter ).to.be.false;
  230. } );
  231. } );
  232. describe( 'view._marginLeft', () => {
  233. it( 'is set if view.isSticky is true view._isStickyToTheLimiter is false', () => {
  234. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  235. top: -10,
  236. bottom: 80,
  237. height: 100
  238. } );
  239. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  240. height: 20
  241. } );
  242. Object.assign( windowStub, {
  243. scrollX: 10,
  244. scrollY: 0
  245. } );
  246. view.isActive = true;
  247. expect( view.isSticky ).to.be.false;
  248. expect( view._isStickyToTheLimiter ).to.be.false;
  249. expect( view._marginLeft ).to.equal( null );
  250. view._checkIfShouldBeSticky();
  251. expect( view.isSticky ).to.be.true;
  252. expect( view._isStickyToTheLimiter ).to.be.false;
  253. expect( view._marginLeft ).to.equal( '-10px' );
  254. } );
  255. it( 'is not set if view._isStickyToTheLimiter is true', () => {
  256. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  257. top: -10,
  258. bottom: 10,
  259. left: 60,
  260. height: 100
  261. } );
  262. testUtils.sinon.stub( view.element, 'getBoundingClientRect' ).returns( {
  263. height: 20
  264. } );
  265. testUtils.sinon.stub( document.body, 'getBoundingClientRect' ).returns( {
  266. left: 40
  267. } );
  268. view.isActive = true;
  269. expect( view.isSticky ).to.be.false;
  270. expect( view._isStickyToTheLimiter ).to.be.false;
  271. expect( view._marginLeft ).to.equal( null );
  272. view._checkIfShouldBeSticky();
  273. expect( view.isSticky ).to.be.true;
  274. expect( view._isStickyToTheLimiter ).to.be.true;
  275. expect( view._marginLeft ).to.equal( null );
  276. } );
  277. it( 'is not set if view.isSticky is false', () => {
  278. testUtils.sinon.stub( view.limiterElement, 'getBoundingClientRect' ).returns( {
  279. top: 10,
  280. } );
  281. view.isActive = true;
  282. expect( view.isSticky ).to.be.false;
  283. expect( view._isStickyToTheLimiter ).to.be.false;
  284. expect( view._marginLeft ).to.equal( null );
  285. view._checkIfShouldBeSticky();
  286. expect( view.isSticky ).to.be.false;
  287. expect( view._isStickyToTheLimiter ).to.be.false;
  288. expect( view._marginLeft ).to.equal( null );
  289. } );
  290. } );
  291. } );
  292. } );