focusobserver.js 5.8 KB

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