focusobserver.js 5.7 KB

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