inlineeditor.js 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
  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 editor-inline/inlineeditor
  7. */
  8. import Editor from '@ckeditor/ckeditor5-core/src/editor/editor';
  9. import DataApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/dataapimixin';
  10. import ElementApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/elementapimixin';
  11. import attachToForm from '@ckeditor/ckeditor5-core/src/editor/utils/attachtoform';
  12. import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/htmldataprocessor';
  13. import InlineEditorUI from './inlineeditorui';
  14. import InlineEditorUIView from './inlineeditoruiview';
  15. import setDataInElement from '@ckeditor/ckeditor5-utils/src/dom/setdatainelement';
  16. import getDataFromElement from '@ckeditor/ckeditor5-utils/src/dom/getdatafromelement';
  17. import mix from '@ckeditor/ckeditor5-utils/src/mix';
  18. import { isElement } from 'lodash-es';
  19. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  20. import secureSourceElement from '@ckeditor/ckeditor5-core/src/editor/utils/securesourceelement';
  21. /**
  22. * The {@glink builds/guides/overview#inline-editor inline editor} implementation.
  23. * It uses an inline editable and a floating toolbar.
  24. * See the {@glink examples/builds/inline-editor demo}.
  25. *
  26. * In order to create a inline editor instance, use the static
  27. * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method.
  28. *
  29. * # Inline editor and inline build
  30. *
  31. * The inline editor can be used directly from source (if you installed the
  32. * [`@ckeditor/ckeditor5-editor-inline`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-inline) package)
  33. * but it is also available in the {@glink builds/guides/overview#inline-editor inline build}.
  34. *
  35. * {@glink builds/guides/overview Builds} are ready-to-use editors with plugins bundled in. When using the editor from
  36. * source you need to take care of loading all plugins by yourself
  37. * (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
  38. * Using the editor from source gives much better flexibility and allows easier customization.
  39. *
  40. * Read more about initializing the editor from source or as a build in
  41. * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`}.
  42. *
  43. * @mixes module:core/editor/utils/dataapimixin~DataApiMixin
  44. * @mixes module:core/editor/utils/elementapimixin~ElementApiMixin
  45. * @implements module:core/editor/editorwithui~EditorWithUI
  46. * @extends module:core/editor/editor~Editor
  47. */
  48. export default class InlineEditor extends Editor {
  49. /**
  50. * Creates an instance of the inline editor.
  51. *
  52. * **Note:** Do not use the constructor to create editor instances. Use the static
  53. * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method instead.
  54. *
  55. * @protected
  56. * @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor
  57. * (on which the editor will be initialized) or initial data for the editor. For more information see
  58. * {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`}.
  59. * @param {module:core/editor/editorconfig~EditorConfig} config The editor configuration.
  60. */
  61. constructor( sourceElementOrData, config ) {
  62. super( config );
  63. this.data.processor = new HtmlDataProcessor( this.data.viewDocument );
  64. this.model.document.createRoot();
  65. if ( isElement( sourceElementOrData ) ) {
  66. this.sourceElement = sourceElementOrData;
  67. secureSourceElement( this );
  68. }
  69. const shouldToolbarGroupWhenFull = !this.config.get( 'toolbar.shouldNotGroupWhenFull' );
  70. const view = new InlineEditorUIView( this.locale, this.editing.view, this.sourceElement, {
  71. shouldToolbarGroupWhenFull
  72. } );
  73. this.ui = new InlineEditorUI( this, view );
  74. attachToForm( this );
  75. }
  76. /**
  77. * Destroys the editor instance, releasing all resources used by it.
  78. *
  79. * Updates the original editor element with the data.
  80. *
  81. * @returns {Promise}
  82. */
  83. destroy() {
  84. // Cache the data, then destroy.
  85. // It's safe to assume that the model->view conversion will not work after super.destroy().
  86. const data = this.getData();
  87. this.ui.destroy();
  88. return super.destroy()
  89. .then( () => {
  90. if ( this.sourceElement ) {
  91. setDataInElement( this.sourceElement, data );
  92. }
  93. } );
  94. }
  95. /**
  96. * Creates a new inline editor instance.
  97. *
  98. * There are three general ways how the editor can be initialized.
  99. *
  100. * # Using an existing DOM element (and loading data from it)
  101. *
  102. * You can initialize the editor using an existing DOM element:
  103. *
  104. * InlineEditor
  105. * .create( document.querySelector( '#editor' ) )
  106. * .then( editor => {
  107. * console.log( 'Editor was initialized', editor );
  108. * } )
  109. * .catch( err => {
  110. * console.error( err.stack );
  111. * } );
  112. *
  113. * The element's content will be used as the editor data and the element will become the editable element.
  114. *
  115. * # Creating a detached editor
  116. *
  117. * Alternatively, you can initialize the editor by passing the initial data directly as a `String`.
  118. * In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:
  119. *
  120. * InlineEditor
  121. * .create( '<p>Hello world!</p>' )
  122. * .then( editor => {
  123. * console.log( 'Editor was initialized', editor );
  124. *
  125. * // Initial data was provided so the editor UI element needs to be added manually to the DOM.
  126. * document.body.appendChild( editor.ui.element );
  127. * } )
  128. * .catch( err => {
  129. * console.error( err.stack );
  130. * } );
  131. *
  132. * This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your
  133. * web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.
  134. *
  135. * # Using an existing DOM element (and data provided in `config.initialData`)
  136. *
  137. * You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
  138. *
  139. * InlineEditor
  140. * .create( document.querySelector( '#editor' ), {
  141. * initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
  142. * } )
  143. * .then( editor => {
  144. * console.log( 'Editor was initialized', editor );
  145. * } )
  146. * .catch( err => {
  147. * console.error( err.stack );
  148. * } );
  149. *
  150. * This method can be used to initialize the editor on an existing element with the specified content in case if your integration
  151. * makes it difficult to set the content of the source element.
  152. *
  153. * Note that an error will be thrown if you pass the initial data both as the first parameter and also in the configuration.
  154. *
  155. * # Configuring the editor
  156. *
  157. * See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
  158. * customizing plugins, toolbar and more.
  159. *
  160. * # Using the editor from source
  161. *
  162. * The code samples listed in the previous sections of this documentation assume that you are using an
  163. * {@glink builds/guides/overview editor build} (for example – `@ckeditor/ckeditor5-build-inline`).
  164. *
  165. * If you want to use the inline editor from source (`@ckeditor/ckeditor5-editor-inline/src/inlineeditor`),
  166. * you need to define the list of
  167. * {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
  168. * {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
  169. * source in the {@glink builds/guides/integration/advanced-setup "Advanced setup" guide}.
  170. *
  171. * @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor
  172. * or the editor's initial data.
  173. *
  174. * If a DOM element is passed, its content will be automatically loaded to the editor upon initialization.
  175. * Moreover, the editor data will be set back to the original element once the editor is destroyed.
  176. *
  177. * If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually.
  178. * It is available under the {@link module:editor-inline/inlineeditorui~InlineEditorUI#element `editor.ui.element`} property.
  179. *
  180. * @param {module:core/editor/editorconfig~EditorConfig} [config] The editor configuration.
  181. * @returns {Promise} A promise resolved once the editor is ready. The promise resolves with the created editor instance.
  182. */
  183. static create( sourceElementOrData, config = {} ) {
  184. return new Promise( resolve => {
  185. const isHTMLElement = isElement( sourceElementOrData );
  186. if ( isHTMLElement && sourceElementOrData.tagName === 'TEXTAREA' ) {
  187. // Documented in core/editor/editor.js
  188. throw new CKEditorError(
  189. 'editor-wrong-element: This type of editor cannot be initialized inside <textarea> element.', null );
  190. }
  191. const editor = new this( sourceElementOrData, config );
  192. resolve(
  193. editor.initPlugins()
  194. .then( () => {
  195. editor.ui.init();
  196. } )
  197. .then( () => {
  198. if ( !isHTMLElement && config.initialData ) {
  199. // Documented in core/editor/editorconfig.jdoc.
  200. throw new CKEditorError(
  201. 'editor-create-initial-data: ' +
  202. 'The config.initialData option cannot be used together with initial data passed in Editor.create().',
  203. null
  204. );
  205. }
  206. const initialData = config.initialData || getInitialData( sourceElementOrData );
  207. return editor.data.init( initialData );
  208. } )
  209. .then( () => editor.fire( 'ready' ) )
  210. .then( () => editor )
  211. );
  212. } );
  213. }
  214. }
  215. mix( InlineEditor, DataApiMixin );
  216. mix( InlineEditor, ElementApiMixin );
  217. function getInitialData( sourceElementOrData ) {
  218. return isElement( sourceElementOrData ) ? getDataFromElement( sourceElementOrData ) : sourceElementOrData;
  219. }