enterobserver.js 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  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 View from '@ckeditor/ckeditor5-engine/src/view/view';
  7. import EnterObserver from '../src/enterobserver';
  8. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  9. import createViewRoot from '@ckeditor/ckeditor5-engine/tests/view/_utils/createroot';
  10. import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
  11. describe( 'EnterObserver', () => {
  12. let view, viewDocument;
  13. beforeEach( () => {
  14. view = new View();
  15. viewDocument = view.document;
  16. view.addObserver( EnterObserver );
  17. } );
  18. // See #10.
  19. it( 'can be initialized', () => {
  20. expect( () => {
  21. createViewRoot( viewDocument );
  22. view.attachDomRoot( document.createElement( 'div' ) );
  23. } ).to.not.throw();
  24. } );
  25. describe( 'enter event', () => {
  26. it( 'is fired on keydown', () => {
  27. const spy = sinon.spy();
  28. viewDocument.on( 'enter', spy );
  29. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  30. keyCode: getCode( 'enter' ),
  31. shiftKey: false
  32. } ) );
  33. expect( spy.calledOnce ).to.be.true;
  34. expect( spy.firstCall.args[ 1 ].isSoft ).to.be.false;
  35. } );
  36. it( 'detects whether shift was pressed along with the "enter" key', () => {
  37. const spy = sinon.spy();
  38. viewDocument.on( 'enter', spy );
  39. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  40. keyCode: getCode( 'enter' ),
  41. shiftKey: true
  42. } ) );
  43. expect( spy.calledOnce ).to.be.true;
  44. expect( spy.firstCall.args[ 1 ].isSoft ).to.be.true;
  45. } );
  46. it( 'is not fired on keydown when keyCode does not match enter', () => {
  47. const spy = sinon.spy();
  48. viewDocument.on( 'enter', spy );
  49. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  50. keyCode: 1
  51. } ) );
  52. expect( spy.calledOnce ).to.be.false;
  53. } );
  54. it( 'should stop keydown event when enter event is stopped', () => {
  55. const keydownSpy = sinon.spy();
  56. viewDocument.on( 'keydown', keydownSpy );
  57. viewDocument.on( 'enter', evt => evt.stop() );
  58. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  59. keyCode: getCode( 'enter' )
  60. } ) );
  61. sinon.assert.notCalled( keydownSpy );
  62. } );
  63. it( 'should not stop keydown event when enter event is not stopped', () => {
  64. const keydownSpy = sinon.spy();
  65. viewDocument.on( 'keydown', keydownSpy );
  66. viewDocument.on( 'enter', evt => evt.stop() );
  67. viewDocument.fire( 'keydown', new DomEventData( viewDocument, getDomEvent(), {
  68. keyCode: getCode( 'x' )
  69. } ) );
  70. sinon.assert.calledOnce( keydownSpy );
  71. } );
  72. } );
  73. function getDomEvent() {
  74. return {
  75. preventDefault: sinon.spy()
  76. };
  77. }
  78. } );