enter.js 2.5 KB

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