| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module editor-decoupled/decouplededitor
- */
- import Editor from '@ckeditor/ckeditor5-core/src/editor/editor';
- import DataApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/dataapimixin';
- import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/htmldataprocessor';
- import DecoupledEditorUI from './decouplededitorui';
- import DecoupledEditorUIView from './decouplededitoruiview';
- import getDataFromElement from '@ckeditor/ckeditor5-utils/src/dom/getdatafromelement';
- import setDataInElement from '@ckeditor/ckeditor5-utils/src/dom/setdatainelement';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- import { isElement } from 'lodash-es';
- /**
- * The {@glink builds/guides/overview#decoupled-editor decoupled editor} implementation.
- * It provides an inline editable and a toolbar. However, unlike other editors,
- * it does not render these components anywhere in the DOM unless configured.
- *
- * This type of an editor is dedicated to integrations which require a customized UI with an open
- * structure, allowing developers to specify the exact location of the interface.
- *
- * See the document editor {@glink examples/builds/document-editor demo} to learn about possible use cases
- * for the decoupled editor.
- *
- * In order to create a decoupled editor instance, use the static
- * {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method.
- *
- * # Decoupled editor and document editor build
- *
- * The decoupled editor can be used directly from source (if you installed the
- * [`@ckeditor/ckeditor5-editor-decoupled`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-decoupled) package)
- * but it is also available in the {@glink builds/guides/overview#document-editor document editor build}.
- *
- * {@glink builds/guides/overview Builds} are ready-to-use editors with plugins bundled in. When using the editor from
- * source you need to take care of loading all plugins by yourself
- * (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
- * Using the editor from source gives much better flexibility and allows for easier customization.
- *
- * Read more about initializing the editor from source or as a build in
- * {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`}.
- *
- * @mixes module:core/editor/utils/dataapimixin~DataApiMixin
- * @implements module:core/editor/editorwithui~EditorWithUI
- * @extends module:core/editor/editor~Editor
- */
- export default class DecoupledEditor extends Editor {
- /**
- * Creates an instance of the decoupled editor.
- *
- * **Note:** Do not use the constructor to create editor instances. Use the static
- * {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method instead.
- *
- * @protected
- * @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor
- * (on which the editor will be initialized) or initial data for the editor. For more information see
- * {@link module:editor-balloon/ballooneditor~BalloonEditor.create `BalloonEditor.create()`}.
- * @param {module:core/editor/editorconfig~EditorConfig} config The editor configuration.
- */
- constructor( sourceElementOrData, config ) {
- super( config );
- if ( isElement( sourceElementOrData ) ) {
- this.sourceElement = sourceElementOrData;
- }
- this.data.processor = new HtmlDataProcessor();
- this.model.document.createRoot();
- this.ui = new DecoupledEditorUI( this, new DecoupledEditorUIView( this.locale, this.sourceElement ) );
- }
- /**
- * @inheritDoc
- */
- get element() {
- // This editor has no single "main UI element". Its editable and toolbar are exposed separately and need
- // to be added to the DOM manually by the consumer.
- return null;
- }
- /**
- * Destroys the editor instance, releasing all resources used by it.
- *
- * **Note**: The decoupled editor does not remove the toolbar and editable when destroyed. You can
- * do that yourself in the destruction chain:
- *
- * editor.destroy()
- * .then( () => {
- * // Remove the toolbar from DOM.
- * editor.ui.view.toolbar.element.remove();
- *
- * // Remove the editable from DOM.
- * editor.ui.view.editable.element.remove();
- *
- * console.log( 'Editor was destroyed' );
- * } );
- *
- * @returns {Promise}
- */
- destroy() {
- // Cache the data, then destroy.
- // It's safe to assume that the model->view conversion will not work after super.destroy().
- const data = this.getData();
- this.ui.destroy();
- return super.destroy()
- .then( () => {
- if ( this.sourceElement ) {
- setDataInElement( this.sourceElement, data );
- }
- } );
- }
- /**
- * Creates a decoupled editor instance.
- *
- * Creating an instance when using a {@glink builds/index CKEditor 5 build}:
- *
- * DecoupledEditor
- * .create( document.querySelector( '#editor' ) )
- * .then( editor => {
- * // Append the toolbar to the <body> element.
- * document.body.appendChild( editor.ui.view.toolbar.element );
- *
- * console.log( 'Editor was initialized', editor );
- * } )
- * .catch( err => {
- * console.error( err.stack );
- * } );
- *
- * Creating an instance when using CKEditor from source (make sure to specify the list of plugins to load and the toolbar):
- *
- * import DecoupledEditor from '@ckeditor/ckeditor5-editor-decoupled/src/decouplededitor';
- * import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
- * import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
- * import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
- * import ...
- *
- * DecoupledEditor
- * .create( document.querySelector( '#editor' ), {
- * plugins: [ Essentials, Bold, Italic, ... ],
- * toolbar: [ 'bold', 'italic', ... ]
- * } )
- * .then( editor => {
- * // Append the toolbar to the <body> element.
- * document.body.appendChild( editor.ui.view.toolbar.element );
- *
- * console.log( 'Editor was initialized', editor );
- * } )
- * .catch( err => {
- * console.error( err.stack );
- * } );
- *
- * **Note**: It is possible to create the editor out of a pure data string. The editor will then render
- * an editable element that must be inserted into the DOM for the editor to work properly:
- *
- * DecoupledEditor
- * .create( '<p>Editor data</p>' )
- * .then( editor => {
- * // Append the toolbar to the <body> element.
- * document.body.appendChild( editor.ui.view.toolbar.element );
- *
- * // Append the editable to the <body> element.
- * document.body.appendChild( editor.ui.view.editable.element );
- *
- * console.log( 'Editor was initialized', editor );
- * } )
- * .catch( err => {
- * console.error( err.stack );
- * } );
- *
- * @param {HTMLElement|String} sourceElementOrData The DOM element that will be the source for the created editor
- * (on which the editor will be initialized) or initial data for the editor.
- *
- * If a source element is passed, then its contents will be automatically
- * {@link module:editor-decoupled/decouplededitor~DecoupledEditor#setData loaded} to the editor on startup and the element
- * itself will be used as the editor's editable element.
- *
- * If data is provided, then `editor.ui.view.editable.element` will be created automatically and needs to be added
- * to the DOM manually.
- * @param {module:core/editor/editorconfig~EditorConfig} config The editor configuration.
- * @returns {Promise} A promise resolved once the editor is ready.
- * The promise returns the created {@link module:editor-decoupled/decouplededitor~DecoupledEditor} instance.
- */
- static create( sourceElementOrData, config ) {
- return new Promise( resolve => {
- const editor = new this( sourceElementOrData, config );
- resolve(
- editor.initPlugins()
- .then( () => {
- editor.ui.init();
- editor.fire( 'uiReady' );
- } )
- .then( () => {
- const initialData = isElement( sourceElementOrData ) ?
- getDataFromElement( sourceElementOrData ) :
- sourceElementOrData;
- return editor.data.init( initialData );
- } )
- .then( () => {
- editor.fire( 'dataReady' );
- editor.fire( 'ready' );
- } )
- .then( () => editor )
- );
- } );
- }
- }
- mix( DecoupledEditor, DataApiMixin );
|