focusobserver.js 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document */
  6. import FocusObserver from '../../../src/view/observer/focusobserver';
  7. import View from '../../../src/view/view';
  8. import ViewRange from '../../../src/view/range';
  9. import createViewRoot from '../_utils/createroot';
  10. import { setData } from '../../../src/dev-utils/view';
  11. describe( 'FocusObserver', () => {
  12. let view, viewDocument, observer;
  13. beforeEach( () => {
  14. view = new View();
  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( view, 'render' );
  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. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewMain, 0, viewMain, 0 ) );
  70. observer.onDomEvent( { type: 'focus', target: domMain } );
  71. expect( viewDocument.isFocused ).to.equal( true );
  72. observer.onDomEvent( { type: 'blur', target: domMain } );
  73. expect( viewDocument.isFocused ).to.be.false;
  74. } );
  75. it( 'should not set isFocused to false on blur when it is fired on other editable', () => {
  76. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewMain, 0, viewMain, 0 ) );
  77. observer.onDomEvent( { type: 'focus', target: domMain } );
  78. expect( viewDocument.isFocused ).to.equal( true );
  79. observer.onDomEvent( { type: 'blur', target: domHeader } );
  80. expect( viewDocument.isFocused ).to.be.true;
  81. } );
  82. it( 'should delay rendering by 50ms', () => {
  83. const renderSpy = sinon.spy( view, 'render' );
  84. const clock = sinon.useFakeTimers();
  85. observer.onDomEvent( { type: 'focus', target: domMain } );
  86. sinon.assert.notCalled( renderSpy );
  87. clock.tick( 50 );
  88. sinon.assert.called( renderSpy );
  89. clock.restore();
  90. } );
  91. it( 'should not call render if destroyed', () => {
  92. const renderSpy = sinon.spy( view, 'render' );
  93. const clock = sinon.useFakeTimers();
  94. observer.onDomEvent( { type: 'focus', target: domMain } );
  95. sinon.assert.notCalled( renderSpy );
  96. observer.destroy();
  97. clock.tick( 50 );
  98. sinon.assert.notCalled( renderSpy );
  99. clock.restore();
  100. } );
  101. } );
  102. describe( 'integration test', () => {
  103. let viewDocument, domRoot, observer;
  104. beforeEach( () => {
  105. domRoot = document.createElement( 'div' );
  106. document.body.appendChild( domRoot );
  107. view = new View();
  108. viewDocument = view.document;
  109. createViewRoot( viewDocument );
  110. view.attachDomRoot( domRoot );
  111. observer = view.getObserver( FocusObserver );
  112. } );
  113. it( 'should always render document after selectionChange event', done => {
  114. const selectionChangeSpy = sinon.spy();
  115. const renderSpy = sinon.spy();
  116. setData( viewDocument, '<div contenteditable="true">foo bar</div>' );
  117. view.render();
  118. viewDocument.on( 'selectionChange', selectionChangeSpy );
  119. view.renderer.on( 'render', renderSpy, { priority: 'low' } );
  120. view.renderer.on( 'render', () => {
  121. sinon.assert.callOrder( selectionChangeSpy, renderSpy );
  122. done();
  123. }, { priority: 'low' } );
  124. // Mock selectionchange event after focus event. Render called by focus observer should be fired after
  125. // async selection change.
  126. viewDocument.fire( 'focus' );
  127. viewDocument.fire( 'selectionChange' );
  128. } );
  129. it( 'should render without selectionChange event', done => {
  130. const selectionChangeSpy = sinon.spy();
  131. const renderSpy = sinon.spy();
  132. setData( viewDocument, '<div contenteditable="true">foo bar</div>' );
  133. view.render();
  134. const domEditable = domRoot.childNodes[ 0 ];
  135. viewDocument.on( 'selectionChange', selectionChangeSpy );
  136. view.renderer.on( 'render', renderSpy, { priority: 'low' } );
  137. view.renderer.on( 'render', () => {
  138. sinon.assert.notCalled( selectionChangeSpy );
  139. sinon.assert.called( renderSpy );
  140. done();
  141. }, { priority: 'low' } );
  142. observer.onDomEvent( { type: 'focus', target: domEditable } );
  143. } );
  144. } );
  145. } );