stickypanelview.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492
  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 StickyPanelView from '../../../src/panel/sticky/stickypanelview';
  8. import View from '../../../src/view';
  9. import LabelView from '../../../src/label/labelview';
  10. import ViewCollection from '../../../src/viewcollection';
  11. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  12. import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin';
  13. testUtils.createSinonSandbox();
  14. describe( 'StickyPanelView', () => {
  15. let view, element, contentElement, placeholderElement, limiterElement, locale, windowStub;
  16. beforeEach( () => {
  17. locale = {};
  18. limiterElement = document.createElement( 'div' );
  19. view = new StickyPanelView( locale );
  20. view.render();
  21. element = view.element;
  22. contentElement = view.element.lastChild;
  23. placeholderElement = view.element.firstChild;
  24. // Dummy values just to let non–geometrical tests pass without reference errors.
  25. view._toolbarRect = { top: 10, right: 20, bottom: 30, left: 40, width: 50, height: 60 };
  26. view._limiterRect = { top: 5, right: 10, bottom: 15, left: 20, width: 25, height: 30 };
  27. windowStub = Object.create( DomEmitterMixin );
  28. Object.assign( windowStub, {
  29. scrollX: 0,
  30. scrollY: 0
  31. } );
  32. testUtils.sinon.stub( global, 'window' ).value( windowStub );
  33. document.body.appendChild( element );
  34. } );
  35. afterEach( () => {
  36. element.remove();
  37. } );
  38. describe( 'constructor()', () => {
  39. it( 'inherits from View', () => {
  40. expect( view ).to.be.instanceof( View );
  41. } );
  42. it( 'should create element from template', () => {
  43. expect( element.tagName ).to.equal( 'DIV' );
  44. expect( element.classList.contains( 'ck-sticky-panel' ) ).to.true;
  45. expect( placeholderElement.tagName ).to.equal( 'DIV' );
  46. expect( placeholderElement.classList.contains( 'ck-sticky-panel__placeholder' ) ).to.true;
  47. expect( contentElement.tagName ).to.equal( 'DIV' );
  48. expect( contentElement.classList.contains( 'ck-sticky-panel__content' ) ).to.true;
  49. } );
  50. it( 'sets view attributes', () => {
  51. expect( view.isSticky ).to.be.false;
  52. expect( view.limiterElement ).to.be.null;
  53. expect( view.limiterBottomOffset ).to.equal( 50 );
  54. expect( view.viewportTopOffset ).to.equal( 0 );
  55. expect( view._isStickyToTheLimiter ).to.be.false;
  56. expect( view._hasViewportTopOffset ).to.be.false;
  57. expect( view._marginLeft ).to.be.null;
  58. } );
  59. it( 'accepts the locale', () => {
  60. expect( view.locale ).to.equal( locale );
  61. } );
  62. it( 'creates view#content collection', () => {
  63. expect( view.content ).to.be.instanceOf( ViewCollection );
  64. } );
  65. } );
  66. describe( 'element view bindings', () => {
  67. beforeEach( () => {
  68. view.limiterElement = limiterElement;
  69. } );
  70. it( 'update the class on view#isSticky change', () => {
  71. view.isSticky = false;
  72. expect( contentElement.classList.contains( 'ck-sticky-panel__content_sticky' ) ).to.be.false;
  73. view.isSticky = true;
  74. expect( contentElement.classList.contains( 'ck-sticky-panel__content_sticky' ) ).to.be.true;
  75. } );
  76. it( 'update the class on view#_isStickyToTheLimiter change', () => {
  77. view._isStickyToTheLimiter = false;
  78. expect( contentElement.classList.contains( 'ck-sticky-panel__content_sticky_bottom-limit' ) ).to.be.false;
  79. view._isStickyToTheLimiter = true;
  80. expect( contentElement.classList.contains( 'ck-sticky-panel__content_sticky_bottom-limit' ) ).to.be.true;
  81. } );
  82. it( 'update the styles.top on view#_hasViewportTopOffset change', () => {
  83. view.viewportTopOffset = 100;
  84. view._hasViewportTopOffset = false;
  85. expect( contentElement.style.top ).to.equal( '' );
  86. view._hasViewportTopOffset = true;
  87. expect( contentElement.style.top ).to.equal( '100px' );
  88. } );
  89. it( 'update the styles.width on view#isSticky change', () => {
  90. testUtils.sinon.stub( view._contentPanelPlaceholder, 'getBoundingClientRect' ).returns( { width: 100 } );
  91. view.isSticky = false;
  92. expect( contentElement.style.width ).to.equal( '' );
  93. view.isSticky = true;
  94. expect( contentElement.style.width ).to.equal( '100px' );
  95. } );
  96. it( 'update the styles.bottom on view#_isStickyToTheLimiter change', () => {
  97. view._isStickyToTheLimiter = false;
  98. expect( contentElement.style.bottom ).to.equal( '' );
  99. view._isStickyToTheLimiter = true;
  100. expect( contentElement.style.bottom ).to.equal( '50px' );
  101. } );
  102. it( 'update the styles.marginLeft on view#marginLeft change', () => {
  103. view._marginLeft = '30px';
  104. expect( contentElement.style.marginLeft ).to.equal( '30px' );
  105. view._marginLeft = '10px';
  106. expect( contentElement.style.marginLeft ).to.equal( '10px' );
  107. } );
  108. } );
  109. describe( '_contentPanelPlaceholder view bindings', () => {
  110. beforeEach( () => {
  111. view.limiterElement = limiterElement;
  112. } );
  113. it( 'update the styles.display on view#isSticky change', () => {
  114. view.isSticky = false;
  115. expect( placeholderElement.style.display ).to.equal( 'none' );
  116. view.isSticky = true;
  117. expect( placeholderElement.style.display ).to.equal( 'block' );
  118. } );
  119. it( 'update the styles.height on view#isSticky change', () => {
  120. view._panelRect = { height: 50 };
  121. view.isSticky = false;
  122. expect( placeholderElement.style.height ).to.equal( '' );
  123. view.isSticky = true;
  124. expect( placeholderElement.style.height ).to.equal( '50px' );
  125. } );
  126. } );
  127. describe( 'children', () => {
  128. it( 'should react on view#content', () => {
  129. expect( contentElement.childNodes.length ).to.equal( 0 );
  130. const label = new LabelView( { t() {} } );
  131. view.content.add( label );
  132. expect( contentElement.childNodes.length ).to.equal( 1 );
  133. } );
  134. } );
  135. describe( 'render()', () => {
  136. let view;
  137. beforeEach( () => {
  138. view = new StickyPanelView();
  139. view.limiterElement = limiterElement;
  140. } );
  141. afterEach( () => {
  142. return view.destroy();
  143. } );
  144. it( 'calls render on parent class', () => {
  145. const spy = testUtils.sinon.spy( View.prototype, 'render' );
  146. view.render();
  147. expect( spy.calledOnce ).to.be.true;
  148. } );
  149. it( 'checks if the panel should be sticky', () => {
  150. const spy = testUtils.sinon.spy( view, '_checkIfShouldBeSticky' );
  151. expect( spy.notCalled ).to.be.true;
  152. view.render();
  153. expect( spy.calledOnce ).to.be.true;
  154. } );
  155. it( 'listens to window#scroll event and calls view._checkIfShouldBeSticky', () => {
  156. const spy = testUtils.sinon.spy( view, '_checkIfShouldBeSticky' );
  157. expect( spy.notCalled ).to.be.true;
  158. view.render();
  159. global.window.fire( 'scroll' );
  160. expect( spy.calledTwice ).to.be.true;
  161. } );
  162. it( 'listens to view.isActive and calls view._checkIfShouldBeSticky', () => {
  163. const spy = testUtils.sinon.spy( view, '_checkIfShouldBeSticky' );
  164. expect( spy.notCalled ).to.be.true;
  165. view.render();
  166. view.isActive = true;
  167. expect( spy.calledTwice ).to.be.true;
  168. view.isActive = false;
  169. expect( spy.calledThrice ).to.be.true;
  170. } );
  171. } );
  172. describe( 'destroy()', () => {
  173. it( 'can be called multiple times', () => {
  174. expect( () => {
  175. view.destroy();
  176. view.destroy();
  177. } ).to.not.throw();
  178. } );
  179. it( 'calls destroy on parent class', () => {
  180. const spy = testUtils.sinon.spy( View.prototype, 'destroy' );
  181. view.destroy();
  182. expect( spy.calledOnce ).to.be.true;
  183. } );
  184. } );
  185. describe( '_checkIfShouldBeSticky', () => {
  186. beforeEach( () => {
  187. view.limiterElement = limiterElement;
  188. } );
  189. describe( 'view.isSticky', () => {
  190. beforeEach( () => {
  191. testUtils.sinon.stub( contentElement, 'getBoundingClientRect' ).returns( {
  192. height: 20
  193. } );
  194. } );
  195. it( 'is true if beyond the top of the viewport (panel is active)', () => {
  196. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 100 } );
  197. expect( view.isSticky ).to.be.false;
  198. view.isActive = true;
  199. expect( view.isSticky ).to.be.true;
  200. } );
  201. it( 'is false if beyond the top of the viewport (panel is inactive)', () => {
  202. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 100 } );
  203. expect( view.isSticky ).to.be.false;
  204. view.isActive = false;
  205. expect( view.isSticky ).to.be.false;
  206. } );
  207. it( 'is false if in the viewport (panel is active)', () => {
  208. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( { top: 10, height: 100 } );
  209. expect( view.isSticky ).to.be.false;
  210. view.isActive = true;
  211. expect( view.isSticky ).to.be.false;
  212. } );
  213. it( 'is false if view.limiterElement is smaller than the panel and view.limiterBottomOffset (panel is active)', () => {
  214. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( { top: -10, height: 60 } );
  215. view.limiterBottomOffset = 50;
  216. expect( view.isSticky ).to.be.false;
  217. view.isActive = true;
  218. expect( view.isSticky ).to.be.false;
  219. } );
  220. } );
  221. describe( 'view._isStickyToTheLimiter', () => {
  222. it( 'is true if view.isSticky is true and reached the bottom edge of view.limiterElement', () => {
  223. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  224. top: -10,
  225. bottom: 10,
  226. height: 100
  227. } );
  228. testUtils.sinon.stub( contentElement, 'getBoundingClientRect' ).returns( {
  229. height: 20
  230. } );
  231. expect( view.isSticky ).to.be.false;
  232. expect( view._isStickyToTheLimiter ).to.be.false;
  233. view.isActive = true;
  234. expect( view.isSticky ).to.be.true;
  235. expect( view._isStickyToTheLimiter ).to.be.true;
  236. } );
  237. it( 'is false if view.isSticky is true and not reached the bottom edge of view.limiterElement', () => {
  238. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  239. top: -10,
  240. bottom: 90,
  241. height: 100
  242. } );
  243. testUtils.sinon.stub( contentElement, 'getBoundingClientRect' ).returns( {
  244. height: 20
  245. } );
  246. expect( view.isSticky ).to.be.false;
  247. expect( view._isStickyToTheLimiter ).to.be.false;
  248. view.isActive = true;
  249. expect( view.isSticky ).to.be.true;
  250. expect( view._isStickyToTheLimiter ).to.be.false;
  251. } );
  252. it( 'is false if view.isSticky is false', () => {
  253. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  254. top: 10,
  255. } );
  256. expect( view.isSticky ).to.be.false;
  257. expect( view._isStickyToTheLimiter ).to.be.false;
  258. view.isActive = true;
  259. expect( view.isSticky ).to.be.false;
  260. expect( view._isStickyToTheLimiter ).to.be.false;
  261. } );
  262. } );
  263. describe( 'view._hasViewportTopOffset', () => {
  264. it( 'is true if view._isStickyToTheLimiter is false and view.viewportTopOffset has been specified', () => {
  265. view.viewportTopOffset = 100;
  266. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  267. top: 90,
  268. bottom: 190,
  269. height: 100
  270. } );
  271. testUtils.sinon.stub( contentElement, 'getBoundingClientRect' ).returns( {
  272. height: 20
  273. } );
  274. view.isActive = true;
  275. expect( view.isSticky ).to.be.true;
  276. expect( view._isStickyToTheLimiter ).to.be.false;
  277. expect( view._hasViewportTopOffset ).to.be.true;
  278. } );
  279. it( 'is false if view._isStickyToTheLimiter is true and view.viewportTopOffset has been specified', () => {
  280. view.viewportTopOffset = 100;
  281. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  282. top: 10,
  283. bottom: 110,
  284. height: 100
  285. } );
  286. testUtils.sinon.stub( contentElement, 'getBoundingClientRect' ).returns( {
  287. height: 20
  288. } );
  289. view.isActive = true;
  290. expect( view.isSticky ).to.be.true;
  291. expect( view._isStickyToTheLimiter ).to.be.true;
  292. expect( view._hasViewportTopOffset ).to.be.false;
  293. } );
  294. it( 'is false if view._isStickyToTheLimiter is false and view.viewportTopOffset is 0', () => {
  295. view.viewportTopOffset = 100;
  296. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  297. top: 90,
  298. bottom: 190,
  299. height: 100
  300. } );
  301. testUtils.sinon.stub( contentElement, 'getBoundingClientRect' ).returns( {
  302. height: 20
  303. } );
  304. view.isActive = true;
  305. expect( view.isSticky ).to.be.true;
  306. expect( view._isStickyToTheLimiter ).to.be.false;
  307. expect( view._hasViewportTopOffset ).to.be.true;
  308. } );
  309. } );
  310. describe( 'view._marginLeft', () => {
  311. it( 'is set if view.isSticky is true view._isStickyToTheLimiter is false', () => {
  312. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  313. top: -10,
  314. bottom: 80,
  315. height: 100
  316. } );
  317. testUtils.sinon.stub( contentElement, 'getBoundingClientRect' ).returns( {
  318. height: 20
  319. } );
  320. Object.assign( windowStub, {
  321. scrollX: 10,
  322. scrollY: 0
  323. } );
  324. expect( view.isSticky ).to.be.false;
  325. expect( view._isStickyToTheLimiter ).to.be.false;
  326. expect( view._marginLeft ).to.equal( null );
  327. view.isActive = true;
  328. expect( view.isSticky ).to.be.true;
  329. expect( view._isStickyToTheLimiter ).to.be.false;
  330. expect( view._marginLeft ).to.equal( '-10px' );
  331. } );
  332. it( 'is not set if view._isStickyToTheLimiter is true', () => {
  333. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  334. top: -10,
  335. bottom: 10,
  336. left: 60,
  337. height: 100
  338. } );
  339. testUtils.sinon.stub( contentElement, 'getBoundingClientRect' ).returns( {
  340. height: 20
  341. } );
  342. testUtils.sinon.stub( document.body, 'getBoundingClientRect' ).returns( {
  343. left: 40
  344. } );
  345. expect( view.isSticky ).to.be.false;
  346. expect( view._isStickyToTheLimiter ).to.be.false;
  347. expect( view._marginLeft ).to.equal( null );
  348. view.isActive = true;
  349. expect( view.isSticky ).to.be.true;
  350. expect( view._isStickyToTheLimiter ).to.be.true;
  351. expect( view._marginLeft ).to.equal( null );
  352. } );
  353. it( 'is not set if view.isSticky is false', () => {
  354. testUtils.sinon.stub( limiterElement, 'getBoundingClientRect' ).returns( {
  355. top: 10,
  356. } );
  357. expect( view.isSticky ).to.be.false;
  358. expect( view._isStickyToTheLimiter ).to.be.false;
  359. expect( view._marginLeft ).to.equal( null );
  360. view.isActive = true;
  361. expect( view.isSticky ).to.be.false;
  362. expect( view._isStickyToTheLimiter ).to.be.false;
  363. expect( view._marginLeft ).to.equal( null );
  364. } );
  365. } );
  366. } );
  367. } );