enter.js 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  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 ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  7. import Enter from '../src/enter';
  8. import EnterCommand from '../src/entercommand';
  9. import EnterObserver from '../src/enterobserver';
  10. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  11. describe( 'Enter feature', () => {
  12. let element, editor, viewDocument;
  13. beforeEach( () => {
  14. element = document.createElement( 'div' );
  15. document.body.appendChild( element );
  16. return ClassicTestEditor
  17. .create( element, {
  18. plugins: [ Enter ]
  19. } )
  20. .then( newEditor => {
  21. editor = newEditor;
  22. viewDocument = editor.editing.view.document;
  23. } );
  24. } );
  25. afterEach( () => {
  26. element.remove();
  27. sinon.restore();
  28. } );
  29. it( 'creates the commands', () => {
  30. expect( editor.commands.get( 'enter' ) ).to.be.instanceof( EnterCommand );
  31. } );
  32. it( 'registers the EnterObserver', () => {
  33. const observer = editor.editing.view.getObserver( EnterObserver );
  34. expect( observer ).to.be.an.instanceOf( EnterObserver );
  35. } );
  36. it( 'listens to the editing view enter event', () => {
  37. const spy = editor.execute = sinon.spy();
  38. const domEvt = getDomEvent();
  39. sinon.stub( editor.editing.view, 'scrollToTheSelection' );
  40. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: false } ) );
  41. expect( spy.calledOnce ).to.be.true;
  42. expect( spy.calledWithExactly( 'enter' ) ).to.be.true;
  43. expect( domEvt.preventDefault.calledOnce ).to.be.true;
  44. } );
  45. it( 'scrolls the editing document to the selection after executing the command', () => {
  46. const domEvt = getDomEvent();
  47. const executeSpy = editor.execute = sinon.spy();
  48. const scrollSpy = sinon.stub( editor.editing.view, 'scrollToTheSelection' );
  49. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt ) );
  50. sinon.assert.calledOnce( scrollSpy );
  51. sinon.assert.callOrder( domEvt.preventDefault, executeSpy, scrollSpy );
  52. } );
  53. it( 'does not execute the command if soft enter should be used', () => {
  54. const domEvt = getDomEvent();
  55. const commandExecuteSpy = sinon.stub( editor.commands.get( 'enter' ), 'execute' );
  56. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: true } ) );
  57. sinon.assert.notCalled( commandExecuteSpy );
  58. } );
  59. it( 'prevents default event action even if the command should not be executed', () => {
  60. const domEvt = getDomEvent();
  61. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: true } ) );
  62. sinon.assert.calledOnce( domEvt.preventDefault );
  63. } );
  64. function getDomEvent() {
  65. return {
  66. preventDefault: sinon.spy()
  67. };
  68. }
  69. } );