widget.js 13 KB

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