| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module editor-balloon/ballooneditor
- */
- import Editor from '@ckeditor/ckeditor5-core/src/editor/editor';
- import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/htmldataprocessor';
- import BalloonToolbar from '@ckeditor/ckeditor5-ui/src/toolbar/balloon/balloontoolbar';
- import BalloonEditorUI from './ballooneditorui';
- import BalloonEditorUIView from './ballooneditoruiview';
- import setDataInElement from '@ckeditor/ckeditor5-utils/src/dom/setdatainelement';
- import getDataFromElement from '@ckeditor/ckeditor5-utils/src/dom/getdatafromelement';
- import DataApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/dataapimixin';
- import ElementApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/elementapimixin';
- import attachToForm from '@ckeditor/ckeditor5-core/src/editor/utils/attachtoform';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- import { isElement } from 'lodash-es';
- /**
- * The {@glink builds/guides/overview#balloon-editor balloon editor} implementation (Medium-like editor).
- * It uses an inline editable and a toolbar based on the {@link module:ui/toolbar/balloon/balloontoolbar~BalloonToolbar}.
- * See the {@glink examples/builds/balloon-editor demo}.
- *
- * In order to create a balloon editor instance, use the static
- * {@link module:editor-balloon/ballooneditor~BalloonEditor.create `BalloonEditor.create()`} method.
- *
- * # Balloon editor and balloon build
- *
- * The balloon editor can be used directly from source (if you installed the
- * [`@ckeditor/ckeditor5-editor-balloon`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-balloon) package)
- * but it is also available in the {@glink builds/guides/overview#balloon-editor balloon 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 easier customization.
- *
- * Read more about initializing the editor from source or as a build in
- * {@link module:editor-balloon/ballooneditor~BalloonEditor.create `BalloonEditor.create()`}.
- *
- * @mixes module:core/editor/utils/dataapimixin~DataApiMixin
- * @mixes module:core/editor/utils/elementapimixin~ElementApiMixin
- * @implements module:core/editor/editorwithui~EditorWithUI
- * @extends module:core/editor/editor~Editor
- */
- export default class BalloonEditor extends Editor {
- /**
- * Creates an instance of the balloon editor.
- *
- * **Note:** do not use the constructor to create editor instances. Use the static
- * {@link module:editor-balloon/ballooneditor~BalloonEditor.create `BalloonEditor.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;
- }
- const plugins = this.config.get( 'plugins' );
- plugins.push( BalloonToolbar );
- this.config.set( 'plugins', plugins );
- this.config.define( 'balloonToolbar', this.config.get( 'toolbar' ) );
- this.data.processor = new HtmlDataProcessor();
- this.model.document.createRoot();
- this.ui = new BalloonEditorUI( this, new BalloonEditorUIView( this.locale, this.sourceElement ) );
- attachToForm( this );
- }
- /**
- * Destroys the editor instance, releasing all resources used by it.
- *
- * Updates the original editor element with the data.
- *
- * @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 balloon editor instance.
- *
- * Creating an instance when using a {@glink builds/index CKEditor build}:
- *
- * BalloonEditor
- * .create( document.querySelector( '#editor' ) )
- * .then( editor => {
- * 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 BalloonEditor from '@ckeditor/ckeditor5-editor-balloon/src/ballooneditor';
- * 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 ...
- *
- * BalloonEditor
- * .create( document.querySelector( '#editor' ), {
- * plugins: [ Essentials, Bold, Italic, ... ],
- * toolbar: [ 'bold', 'italic', ... ]
- * } )
- * .then( editor => {
- * console.log( 'Editor was initialized', editor );
- * } )
- * .catch( err => {
- * console.error( err.stack );
- * } );
- *
- * Creating an instance when using initial data instead of a DOM element:
- *
- * import BalloonEditor from '@ckeditor/ckeditor5-editor-balloon/src/ballooneditor';
- * 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 ...
- *
- * BalloonEditor
- * .create( '<p>Hello world!</p>', {
- * plugins: [ Essentials, Bold, Italic, ... ],
- * toolbar: [ 'bold', 'italic', ... ]
- * } )
- * .then( editor => {
- * console.log( 'Editor was initialized', editor );
- *
- * // Initial data was provided so `editor.element` needs to be added manually to the DOM.
- * document.body.appendChild( editor.element );
- * } )
- * .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-balloon/ballooneditor~BalloonEditor#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.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-balloon/ballooneditor~BalloonEditor} instance.
- */
- static create( sourceElementOrData, config ) {
- return new Promise( resolve => {
- const editor = new this( sourceElementOrData, config );
- resolve(
- editor.initPlugins()
- .then( () => {
- editor.ui.init();
- } )
- .then( () => {
- const initialData = isElement( sourceElementOrData ) ?
- getDataFromElement( sourceElementOrData ) :
- sourceElementOrData;
- return editor.data.init( initialData );
- } )
- .then( () => {
- editor.fire( 'dataReady' );
- editor.fire( 'ready' );
- } )
- .then( () => editor )
- );
- } );
- }
- }
- mix( BalloonEditor, DataApiMixin );
- mix( BalloonEditor, ElementApiMixin );
|