focusobserver.js 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  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 FocusObserver from '../../../src/view/observer/focusobserver';
  7. import View from '../../../src/view/view';
  8. import createViewRoot from '../_utils/createroot';
  9. import { setData } from '../../../src/dev-utils/view';
  10. import { StylesProcessor } from '../../../src/view/stylesmap';
  11. describe( 'FocusObserver', () => {
  12. let view, viewDocument, observer;
  13. let stylesProcessor;
  14. before( () => {
  15. stylesProcessor = new StylesProcessor();
  16. } );
  17. beforeEach( () => {
  18. view = new View( stylesProcessor );
  19. viewDocument = view.document;
  20. observer = view.getObserver( FocusObserver );
  21. } );
  22. afterEach( () => {
  23. view.destroy();
  24. } );
  25. it( 'should define domEventType', () => {
  26. expect( observer.domEventType ).to.deep.equal( [ 'focus', 'blur' ] );
  27. } );
  28. it( 'should use capturing phase', () => {
  29. expect( observer.useCapture ).to.be.true;
  30. } );
  31. describe( 'onDomEvent', () => {
  32. it( 'should fire focus with the right event data', () => {
  33. const spy = sinon.spy();
  34. viewDocument.on( 'focus', spy );
  35. observer.onDomEvent( { type: 'focus', target: document.body } );
  36. expect( spy.calledOnce ).to.be.true;
  37. const data = spy.args[ 0 ][ 1 ];
  38. expect( data.domTarget ).to.equal( document.body );
  39. } );
  40. it( 'should fire blur with the right event data', () => {
  41. const spy = sinon.spy();
  42. viewDocument.on( 'blur', spy );
  43. observer.onDomEvent( { type: 'blur', target: document.body } );
  44. expect( spy.calledOnce ).to.be.true;
  45. const data = spy.args[ 0 ][ 1 ];
  46. expect( data.domTarget ).to.equal( document.body );
  47. } );
  48. it( 'should render document after blurring', () => {
  49. const renderSpy = sinon.spy();
  50. view.on( 'render', renderSpy );
  51. observer.onDomEvent( { type: 'blur', target: document.body } );
  52. sinon.assert.calledOnce( renderSpy );
  53. } );
  54. } );
  55. describe( 'handle isFocused property of the document', () => {
  56. let domMain, domHeader, viewMain;
  57. beforeEach( () => {
  58. domMain = document.createElement( 'div' );
  59. domHeader = document.createElement( 'h1' );
  60. viewMain = createViewRoot( viewDocument );
  61. view.attachDomRoot( domMain );
  62. } );
  63. it( 'should set isFocused to true on focus', () => {
  64. observer.onDomEvent( { type: 'focus', target: domMain } );
  65. expect( viewDocument.isFocused ).to.equal( true );
  66. } );
  67. it( 'should set isFocused to false on blur', () => {
  68. observer.onDomEvent( { type: 'focus', target: domMain } );
  69. expect( viewDocument.isFocused ).to.equal( true );
  70. observer.onDomEvent( { type: 'blur', target: domMain } );
  71. expect( viewDocument.isFocused ).to.be.false;
  72. } );
  73. it( 'should set isFocused to false on blur when selection in same editable', () => {
  74. view.change( writer => {
  75. writer.setSelection( viewMain, 0 );
  76. } );
  77. observer.onDomEvent( { type: 'focus', target: domMain } );
  78. expect( viewDocument.isFocused ).to.equal( true );
  79. observer.onDomEvent( { type: 'blur', target: domMain } );
  80. expect( viewDocument.isFocused ).to.be.false;
  81. } );
  82. it( 'should not set isFocused to false on blur when it is fired on other editable', () => {
  83. view.change( writer => {
  84. writer.setSelection( viewMain, 0 );
  85. } );
  86. observer.onDomEvent( { type: 'focus', target: domMain } );
  87. expect( viewDocument.isFocused ).to.equal( true );
  88. observer.onDomEvent( { type: 'blur', target: domHeader } );
  89. expect( viewDocument.isFocused ).to.be.true;
  90. } );
  91. it( 'should delay rendering by 50ms', () => {
  92. const renderSpy = sinon.spy();
  93. view.on( 'render', renderSpy );
  94. const clock = sinon.useFakeTimers();
  95. observer.onDomEvent( { type: 'focus', target: domMain } );
  96. sinon.assert.notCalled( renderSpy );
  97. clock.tick( 50 );
  98. sinon.assert.called( renderSpy );
  99. clock.restore();
  100. } );
  101. it( 'should not call render if destroyed', () => {
  102. const renderSpy = sinon.spy();
  103. view.on( 'render', renderSpy );
  104. const clock = sinon.useFakeTimers();
  105. observer.onDomEvent( { type: 'focus', target: domMain } );
  106. sinon.assert.notCalled( renderSpy );
  107. observer.destroy();
  108. clock.tick( 50 );
  109. sinon.assert.notCalled( renderSpy );
  110. clock.restore();
  111. } );
  112. } );
  113. describe( 'integration test', () => {
  114. let viewDocument, domRoot, observer;
  115. beforeEach( () => {
  116. domRoot = document.createElement( 'div' );
  117. document.body.appendChild( domRoot );
  118. view = new View( stylesProcessor );
  119. viewDocument = view.document;
  120. createViewRoot( viewDocument );
  121. view.attachDomRoot( domRoot );
  122. observer = view.getObserver( FocusObserver );
  123. } );
  124. afterEach( () => {
  125. view.destroy();
  126. domRoot.remove();
  127. } );
  128. it( 'should always render document after selectionChange event', done => {
  129. const selectionChangeSpy = sinon.spy();
  130. const renderSpy = sinon.spy();
  131. setData( view, '<div contenteditable="true">foo bar</div>' );
  132. view.forceRender();
  133. viewDocument.on( 'selectionChange', selectionChangeSpy );
  134. view.on( 'render', renderSpy );
  135. view.on( 'render', () => {
  136. sinon.assert.callOrder( selectionChangeSpy, renderSpy );
  137. done();
  138. } );
  139. // Mock selectionchange event after focus event. Render called by focus observer should be fired after
  140. // async selection change.
  141. viewDocument.fire( 'focus' );
  142. viewDocument.fire( 'selectionChange' );
  143. } );
  144. it( 'should render without selectionChange event', done => {
  145. const selectionChangeSpy = sinon.spy();
  146. const renderSpy = sinon.spy();
  147. setData( view, '<div contenteditable="true">foo bar</div>' );
  148. view.forceRender();
  149. const domEditable = domRoot.childNodes[ 0 ];
  150. viewDocument.on( 'selectionChange', selectionChangeSpy );
  151. view.on( 'render', renderSpy );
  152. view.on( 'render', () => {
  153. sinon.assert.notCalled( selectionChangeSpy );
  154. sinon.assert.called( renderSpy );
  155. done();
  156. } );
  157. observer.onDomEvent( { type: 'focus', target: domEditable } );
  158. } );
  159. } );
  160. } );