focusobserver.js 5.9 KB

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