enterobserver.js 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  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. /**
  6. * @module enter/enterobserver
  7. */
  8. import Observer from '@ckeditor/ckeditor5-engine/src/view/observer/observer';
  9. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  10. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  11. /**
  12. * Enter observer introduces the {@link module:engine/view/document~Document#event:enter} event.
  13. *
  14. * @extends module:engine/view/observer/observer~Observer
  15. */
  16. export default class EnterObserver extends Observer {
  17. constructor( view ) {
  18. super( view );
  19. const doc = this.document;
  20. doc.on( 'keydown', ( evt, data ) => {
  21. if ( this.isEnabled && data.keyCode == keyCodes.enter ) {
  22. // Save the event object to check later if it was stopped or not.
  23. let event;
  24. doc.once( 'enter', evt => ( event = evt ), { priority: 'highest' } );
  25. doc.fire( 'enter', new DomEventData( doc, data.domEvent, {
  26. isSoft: data.shiftKey
  27. } ) );
  28. // Stop `keydown` event if `enter` event was stopped.
  29. // https://github.com/ckeditor/ckeditor5/issues/753
  30. if ( event && event.stop.called ) {
  31. evt.stop();
  32. }
  33. }
  34. } );
  35. }
  36. /**
  37. * @inheritDoc
  38. */
  39. observe() {}
  40. }
  41. /**
  42. * Event fired when the user presses the <kbd>Enter</kbd> key.
  43. *
  44. * Note: This event is fired by the {@link module:enter/enterobserver~EnterObserver observer}
  45. * (usually registered by the {@link module:enter/enter~Enter Enter feature} and
  46. * {@link module:enter/shiftenter~ShiftEnter ShiftEnter feature}).
  47. *
  48. * @event module:engine/view/document~Document#event:enter
  49. * @param {module:engine/view/observer/domeventdata~DomEventData} data
  50. * @param {Boolean} data.isSoft Whether it's a soft enter (<kbd>Shift</kbd>+<kbd>Enter</kbd>) or hard enter (<kbd>Enter</kbd>).
  51. */