8
0

widget.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418
  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 widget/widget
  7. */
  8. import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
  9. import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
  10. import WidgetTypeAround from './widgettypearound/widgettypearound';
  11. import { getLabel, isWidget, WIDGET_SELECTED_CLASS_NAME } from './utils';
  12. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  13. import env from '@ckeditor/ckeditor5-utils/src/env';
  14. import '../theme/widget.css';
  15. /**
  16. * The widget plugin. It enables base support for widgets.
  17. *
  18. * See {@glink api/widget package page} for more details and documentation.
  19. *
  20. * This plugin enables multiple behaviors required by widgets:
  21. *
  22. * * The model to view selection converter for the editing pipeline (it handles widget custom selection rendering).
  23. * If a converted selection wraps around a widget element, that selection is marked as
  24. * {@link module:engine/view/selection~Selection#isFake fake}. Additionally, the `ck-widget_selected` CSS class
  25. * is added to indicate that widget has been selected.
  26. * * The mouse and keyboard events handling on and around widget elements.
  27. *
  28. * @extends module:core/plugin~Plugin
  29. */
  30. export default class Widget extends Plugin {
  31. /**
  32. * @inheritDoc
  33. */
  34. static get pluginName() {
  35. return 'Widget';
  36. }
  37. /**
  38. * @inheritDoc
  39. */
  40. static get requires() {
  41. return [ WidgetTypeAround ];
  42. }
  43. /**
  44. * @inheritDoc
  45. */
  46. init() {
  47. const view = this.editor.editing.view;
  48. const viewDocument = view.document;
  49. /**
  50. * Holds previously selected widgets.
  51. *
  52. * @private
  53. * @type {Set.<module:engine/view/element~Element>}
  54. */
  55. this._previouslySelected = new Set();
  56. // Model to view selection converter.
  57. // Converts selection placed over widget element to fake selection
  58. this.editor.editing.downcastDispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  59. // Remove selected class from previously selected widgets.
  60. this._clearPreviouslySelectedWidgets( conversionApi.writer );
  61. const viewWriter = conversionApi.writer;
  62. const viewSelection = viewWriter.document.selection;
  63. const selectedElement = viewSelection.getSelectedElement();
  64. let lastMarked = null;
  65. for ( const range of viewSelection.getRanges() ) {
  66. for ( const value of range ) {
  67. const node = value.item;
  68. // Do not mark nested widgets in selected one. See: #57.
  69. if ( isWidget( node ) && !isChild( node, lastMarked ) ) {
  70. viewWriter.addClass( WIDGET_SELECTED_CLASS_NAME, node );
  71. this._previouslySelected.add( node );
  72. lastMarked = node;
  73. // Check if widget is a single element selected.
  74. if ( node == selectedElement ) {
  75. viewWriter.setSelection( viewSelection.getRanges(), { fake: true, label: getLabel( selectedElement ) } );
  76. }
  77. }
  78. }
  79. }
  80. }, { priority: 'low' } );
  81. // If mouse down is pressed on widget - create selection over whole widget.
  82. view.addObserver( MouseObserver );
  83. this.listenTo( viewDocument, 'mousedown', ( ...args ) => this._onMousedown( ...args ) );
  84. // Handle custom keydown behaviour.
  85. this.listenTo( viewDocument, 'keydown', ( ...args ) => this._onKeydown( ...args ), { priority: 'high' } );
  86. // Handle custom delete behaviour.
  87. this.listenTo( viewDocument, 'delete', ( evt, data ) => {
  88. if ( this._handleDelete( data.direction == 'forward' ) ) {
  89. data.preventDefault();
  90. evt.stop();
  91. }
  92. }, { priority: 'high' } );
  93. }
  94. /**
  95. * Handles {@link module:engine/view/document~Document#event:mousedown mousedown} events on widget elements.
  96. *
  97. * @private
  98. * @param {module:utils/eventinfo~EventInfo} eventInfo
  99. * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
  100. */
  101. _onMousedown( eventInfo, domEventData ) {
  102. const editor = this.editor;
  103. const view = editor.editing.view;
  104. const viewDocument = view.document;
  105. let element = domEventData.target;
  106. // Do nothing for single or double click inside nested editable.
  107. if ( isInsideNestedEditable( element ) ) {
  108. // But at least triple click inside nested editable causes broken selection in Safari.
  109. // For such event, we select the entire nested editable element.
  110. // See: https://github.com/ckeditor/ckeditor5/issues/1463.
  111. if ( env.isSafari && domEventData.domEvent.detail >= 3 ) {
  112. const mapper = editor.editing.mapper;
  113. const modelElement = mapper.toModelElement( element );
  114. this.editor.model.change( writer => {
  115. domEventData.preventDefault();
  116. writer.setSelection( modelElement, 'in' );
  117. } );
  118. }
  119. return;
  120. }
  121. // If target is not a widget element - check if one of the ancestors is.
  122. if ( !isWidget( element ) ) {
  123. element = element.findAncestor( isWidget );
  124. if ( !element ) {
  125. return;
  126. }
  127. }
  128. domEventData.preventDefault();
  129. // Focus editor if is not focused already.
  130. if ( !viewDocument.isFocused ) {
  131. view.focus();
  132. }
  133. // Create model selection over widget.
  134. const modelElement = editor.editing.mapper.toModelElement( element );
  135. this._setSelectionOverElement( modelElement );
  136. }
  137. /**
  138. * Handles {@link module:engine/view/document~Document#event:keydown keydown} events.
  139. *
  140. * @private
  141. * @param {module:utils/eventinfo~EventInfo} eventInfo
  142. * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
  143. */
  144. _onKeydown( eventInfo, domEventData ) {
  145. const keyCode = domEventData.keyCode;
  146. const isLtrContent = this.editor.locale.contentLanguageDirection === 'ltr';
  147. const isForward = keyCode == keyCodes.arrowdown || keyCode == keyCodes[ isLtrContent ? 'arrowright' : 'arrowleft' ];
  148. let wasHandled = false;
  149. // Checks if the keys were handled and then prevents the default event behaviour and stops
  150. // the propagation.
  151. if ( isArrowKeyCode( keyCode ) ) {
  152. wasHandled = this._handleArrowKeys( isForward );
  153. } else if ( keyCode === keyCodes.enter ) {
  154. wasHandled = this._handleEnterKey( domEventData.shiftKey );
  155. }
  156. if ( wasHandled ) {
  157. domEventData.preventDefault();
  158. eventInfo.stop();
  159. }
  160. }
  161. /**
  162. * Handles delete keys: backspace and delete.
  163. *
  164. * @private
  165. * @param {Boolean} isForward Set to true if delete was performed in forward direction.
  166. * @returns {Boolean|undefined} Returns `true` if keys were handled correctly.
  167. */
  168. _handleDelete( isForward ) {
  169. // Do nothing when the read only mode is enabled.
  170. if ( this.editor.isReadOnly ) {
  171. return;
  172. }
  173. const modelDocument = this.editor.model.document;
  174. const modelSelection = modelDocument.selection;
  175. // Do nothing on non-collapsed selection.
  176. if ( !modelSelection.isCollapsed ) {
  177. return;
  178. }
  179. const objectElement = this._getObjectElementNextToSelection( isForward );
  180. if ( objectElement ) {
  181. this.editor.model.change( writer => {
  182. let previousNode = modelSelection.anchor.parent;
  183. // Remove previous element if empty.
  184. while ( previousNode.isEmpty ) {
  185. const nodeToRemove = previousNode;
  186. previousNode = nodeToRemove.parent;
  187. writer.remove( nodeToRemove );
  188. }
  189. this._setSelectionOverElement( objectElement );
  190. } );
  191. return true;
  192. }
  193. }
  194. /**
  195. * Handles arrow keys.
  196. *
  197. * @private
  198. * @param {Boolean} isForward Set to true if arrow key should be handled in forward direction.
  199. * @returns {Boolean|undefined} Returns `true` if keys were handled correctly.
  200. */
  201. _handleArrowKeys( isForward ) {
  202. const model = this.editor.model;
  203. const schema = model.schema;
  204. const modelDocument = model.document;
  205. const modelSelection = modelDocument.selection;
  206. const objectElement = modelSelection.getSelectedElement();
  207. // If object element is selected.
  208. if ( objectElement && schema.isObject( objectElement ) ) {
  209. const position = isForward ? modelSelection.getLastPosition() : modelSelection.getFirstPosition();
  210. const newRange = schema.getNearestSelectionRange( position, isForward ? 'forward' : 'backward' );
  211. if ( newRange ) {
  212. model.change( writer => {
  213. writer.setSelection( newRange );
  214. } );
  215. }
  216. return true;
  217. }
  218. // If selection is next to object element.
  219. // Return if not collapsed.
  220. if ( !modelSelection.isCollapsed ) {
  221. return;
  222. }
  223. const objectElement2 = this._getObjectElementNextToSelection( isForward );
  224. if ( !!objectElement2 && schema.isObject( objectElement2 ) ) {
  225. this._setSelectionOverElement( objectElement2 );
  226. return true;
  227. }
  228. }
  229. /**
  230. * Handles the enter key, giving users and access to positions in the editable directly before
  231. * (<kbd>Shift</kbd>+<kbd>Enter</kbd>) or after (<kbd>Enter</kbd>) the selected widget.
  232. * It improves the UX, mainly when the widget is the first or last child of the root editable
  233. * and there's no other way to type after or before it.
  234. *
  235. * @private
  236. * @param {Boolean} isBackwards Set to true if the new paragraph is to be inserted before
  237. * the selected widget (<kbd>Shift</kbd>+<kbd>Enter</kbd>).
  238. * @returns {Boolean|undefined} Returns `true` if keys were handled correctly.
  239. */
  240. _handleEnterKey( isBackwards ) {
  241. const model = this.editor.model;
  242. const modelSelection = model.document.selection;
  243. const selectedElement = modelSelection.getSelectedElement();
  244. if ( shouldInsertParagraph( selectedElement, model.schema ) ) {
  245. model.change( writer => {
  246. let position = writer.createPositionAt( selectedElement, isBackwards ? 'before' : 'after' );
  247. const paragraph = writer.createElement( 'paragraph' );
  248. // Split the parent when inside a block element.
  249. // https://github.com/ckeditor/ckeditor5/issues/1529
  250. if ( model.schema.isBlock( selectedElement.parent ) ) {
  251. const paragraphLimit = model.schema.findAllowedParent( position, paragraph );
  252. position = writer.split( position, paragraphLimit ).position;
  253. }
  254. writer.insert( paragraph, position );
  255. writer.setSelection( paragraph, 'in' );
  256. } );
  257. return true;
  258. }
  259. }
  260. /**
  261. * Sets {@link module:engine/model/selection~Selection document's selection} over given element.
  262. *
  263. * @private
  264. * @param {module:engine/model/element~Element} element
  265. */
  266. _setSelectionOverElement( element ) {
  267. this.editor.model.change( writer => {
  268. writer.setSelection( writer.createRangeOn( element ) );
  269. } );
  270. }
  271. /**
  272. * Checks if {@link module:engine/model/element~Element element} placed next to the current
  273. * {@link module:engine/model/selection~Selection model selection} exists and is marked in
  274. * {@link module:engine/model/schema~Schema schema} as `object`.
  275. *
  276. * @private
  277. * @param {Boolean} forward Direction of checking.
  278. * @returns {module:engine/model/element~Element|null}
  279. */
  280. _getObjectElementNextToSelection( forward ) {
  281. const model = this.editor.model;
  282. const schema = model.schema;
  283. const modelSelection = model.document.selection;
  284. // Clone current selection to use it as a probe. We must leave default selection as it is so it can return
  285. // to its current state after undo.
  286. const probe = model.createSelection( modelSelection );
  287. model.modifySelection( probe, { direction: forward ? 'forward' : 'backward' } );
  288. const objectElement = forward ? probe.focus.nodeBefore : probe.focus.nodeAfter;
  289. if ( !!objectElement && schema.isObject( objectElement ) ) {
  290. return objectElement;
  291. }
  292. return null;
  293. }
  294. /**
  295. * Removes CSS class from previously selected widgets.
  296. *
  297. * @private
  298. * @param {module:engine/view/downcastwriter~DowncastWriter} writer
  299. */
  300. _clearPreviouslySelectedWidgets( writer ) {
  301. for ( const widget of this._previouslySelected ) {
  302. writer.removeClass( WIDGET_SELECTED_CLASS_NAME, widget );
  303. }
  304. this._previouslySelected.clear();
  305. }
  306. }
  307. // Returns 'true' if provided key code represents one of the arrow keys.
  308. //
  309. // @param {Number} keyCode
  310. // @returns {Boolean}
  311. function isArrowKeyCode( keyCode ) {
  312. return keyCode == keyCodes.arrowright ||
  313. keyCode == keyCodes.arrowleft ||
  314. keyCode == keyCodes.arrowup ||
  315. keyCode == keyCodes.arrowdown;
  316. }
  317. // Returns `true` when element is a nested editable or is placed inside one.
  318. //
  319. // @param {module:engine/view/element~Element}
  320. // @returns {Boolean}
  321. function isInsideNestedEditable( element ) {
  322. while ( element ) {
  323. if ( element.is( 'editableElement' ) && !element.is( 'rootElement' ) ) {
  324. return true;
  325. }
  326. // Click on nested widget should select it.
  327. if ( isWidget( element ) ) {
  328. return false;
  329. }
  330. element = element.parent;
  331. }
  332. return false;
  333. }
  334. // Checks whether the specified `element` is a child of the `parent` element.
  335. //
  336. // @param {module:engine/view/element~Element} element An element to check.
  337. // @param {module:engine/view/element~Element|null} parent A parent for the element.
  338. // @returns {Boolean}
  339. function isChild( element, parent ) {
  340. if ( !parent ) {
  341. return false;
  342. }
  343. return Array.from( element.getAncestors() ).includes( parent );
  344. }
  345. // Checks if enter key should insert paragraph. This should be done only on elements of type object (excluding inline objects).
  346. //
  347. // @param {module:engine/model/element~Element} element And element to check.
  348. // @param {module:engine/model/schema~Schema} schema
  349. function shouldInsertParagraph( element, schema ) {
  350. return element && schema.isObject( element ) && !schema.isInline( element );
  351. }