8
0

stickypanelview.js 14 KB

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