shiftenter.js 3.1 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 ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
  7. import ShiftEnter from '../src/shiftenter';
  8. import ShiftEnterCommand from '../src/shiftentercommand';
  9. import EnterObserver from '../src/enterobserver';
  10. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  11. describe( 'ShiftEnter 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: [ ShiftEnter ]
  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( 'shiftEnter' ) ).to.be.instanceof( ShiftEnterCommand );
  32. } );
  33. it( 'should set proper schema rules', () => {
  34. expect( editor.model.schema.isRegistered( 'softBreak' ) ).to.be.true;
  35. expect( editor.model.schema.checkChild( [ '$block' ], 'softBreak' ) ).to.be.true;
  36. expect( editor.model.schema.isInline( 'softBreak' ) ).to.be.true;
  37. } );
  38. it( 'registers the EnterObserver', () => {
  39. const observer = editor.editing.view.getObserver( EnterObserver );
  40. expect( observer ).to.be.an.instanceOf( EnterObserver );
  41. } );
  42. it( 'listens to the editing view enter event', () => {
  43. const spy = editor.execute = sinon.spy();
  44. const domEvt = getDomEvent();
  45. sinon.stub( editor.editing.view, 'scrollToTheSelection' );
  46. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: true } ) );
  47. expect( spy.calledOnce ).to.be.true;
  48. expect( spy.calledWithExactly( 'shiftEnter' ) ).to.be.true;
  49. expect( domEvt.preventDefault.calledOnce ).to.be.true;
  50. } );
  51. it( 'scrolls the editing document to the selection after executing the command', () => {
  52. const domEvt = getDomEvent();
  53. const executeSpy = editor.execute = sinon.spy();
  54. const scrollSpy = sinon.stub( editor.editing.view, 'scrollToTheSelection' );
  55. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: true } ) );
  56. sinon.assert.calledOnce( scrollSpy );
  57. sinon.assert.callOrder( domEvt.preventDefault, executeSpy, scrollSpy );
  58. } );
  59. it( 'does not execute the command if hard enter should be used', () => {
  60. const domEvt = getDomEvent();
  61. const commandExecuteSpy = sinon.stub( editor.commands.get( 'shiftEnter' ), 'execute' );
  62. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: false } ) );
  63. sinon.assert.notCalled( commandExecuteSpy );
  64. } );
  65. it( 'prevents default event action even if the command should not be executed', () => {
  66. const domEvt = getDomEvent();
  67. viewDocument.fire( 'enter', new DomEventData( viewDocument, domEvt, { isSoft: false } ) );
  68. sinon.assert.calledOnce( domEvt.preventDefault );
  69. } );
  70. function getDomEvent() {
  71. return {
  72. preventDefault: sinon.spy()
  73. };
  74. }
  75. } );