enter.js 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  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 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. return editor.destroy();
  29. } );
  30. it( 'creates the commands', () => {
  31. expect( editor.commands.get( 'enter' ) ).to.be.instanceof( EnterCommand );
  32. } );
  33. it( 'registers the EnterObserver', () => {
  34. const observer = editor.editing.view.getObserver( EnterObserver );
  35. expect( observer ).to.be.an.instanceOf( EnterObserver );
  36. } );
  37. it( 'listens to the editing view enter event', () => {
  38. const spy = editor.execute = sinon.spy();
  39. const domEvt = getDomEvent();
  40. sinon.stub( editor.editing.view, 'scrollToTheSelection' );
  41. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: false } ) );
  42. expect( spy.calledOnce ).to.be.true;
  43. expect( spy.calledWithExactly( 'enter' ) ).to.be.true;
  44. expect( domEvt.preventDefault.calledOnce ).to.be.true;
  45. } );
  46. it( 'scrolls the editing document to the selection after executing the command', () => {
  47. const domEvt = getDomEvent();
  48. const executeSpy = editor.execute = sinon.spy();
  49. const scrollSpy = sinon.stub( editor.editing.view, 'scrollToTheSelection' );
  50. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt ) );
  51. sinon.assert.calledOnce( scrollSpy );
  52. sinon.assert.callOrder( domEvt.preventDefault, executeSpy, scrollSpy );
  53. } );
  54. it( 'does not execute the command if soft enter should be used', () => {
  55. const domEvt = getDomEvent();
  56. const commandExecuteSpy = sinon.stub( editor.commands.get( 'enter' ), 'execute' );
  57. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: true } ) );
  58. sinon.assert.notCalled( commandExecuteSpy );
  59. } );
  60. it( 'prevents default event action even if the command should not be executed', () => {
  61. const domEvt = getDomEvent();
  62. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: true } ) );
  63. sinon.assert.calledOnce( domEvt.preventDefault );
  64. } );
  65. function getDomEvent() {
  66. return {
  67. preventDefault: sinon.spy()
  68. };
  69. }
  70. } );