stickypanelview.js 14 KB

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