Hello world!
' ) * .then( editor => { + * console.log( 'Editor was initialized', editor ); + * * // Append the toolbar to the element. * document.body.appendChild( editor.ui.view.toolbar.element ); * - * console.log( 'Editor was initialized', editor ); + * // Initial data was provided so the editor UI element needs to be added manually to the DOM. + * document.body.appendChild( editor.ui.element ); * } ) * .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: + * This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your + * web page content is generated on the client-side and the DOM structure is not ready at the moment when you initialize the editor. + * + * You can also mix those two ways by providing a DOM element to be used and passing the initial data through the config: * * DecoupledEditor - * .create( 'Editor data
' ) + * .create( document.querySelector( '#editor' ), { + * initialData: 'Foo bar.
' + * } ) * .then( editor => { + * console.log( 'Editor was initialized', editor ); + * * // Append the toolbar to the element. * document.body.appendChild( editor.ui.view.toolbar.element ); - * - * // Append the editable to the element. - * document.body.appendChild( editor.ui.view.editable.element ); - * - * console.log( 'Editor was initialized', editor ); * } ) * .catch( err => { * console.error( err.stack ); * } ); * + * This method can be used to initialize the editor on an existing element with specified content in case if your integration + * makes it difficult to set the content of the source element. + * + * Note that an error will be thrown if you pass initial data both as the first parameter and also in the config. + * + * See also the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about + * customizing plugins, toolbar and other. + * * @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. + * or the editor's initial data. * - * 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 a DOM element is passed, its content will be automatically loaded to the editor upon initialization. + * Moreover, the editor data will be set back to the original element once the editor is destroyed. * - * 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. + * If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually. + * It is available under {@link module:editor-decoupled/decouplededitorui~DecoupledEditorUI#element `editor.ui.element`} property. + * + * @param {module:core/editor/editorconfig~EditorConfig} [config] The editor configuration. + * @returns {Promise} A promise resolved once the editor is ready. The promise resolves with the created editor instance. */ - static create( sourceElementOrData, config ) { + static create( sourceElementOrData, config = {} ) { return new Promise( resolve => { const editor = new this( sourceElementOrData, config ); @@ -192,9 +203,14 @@ export default class DecoupledEditor extends Editor { editor.ui.init(); } ) .then( () => { - const initialData = isElement( sourceElementOrData ) ? - getDataFromElement( sourceElementOrData ) : - sourceElementOrData; + if ( !isElement( sourceElementOrData ) && config.initialData ) { + throw new CKEditorError( + 'editor-create-initial-data: ' + + 'EditorConfig#initialData cannot be used together with initial data passed in Editor#create()' + ); + } + + const initialData = config.initialData || getInitialData( sourceElementOrData ); return editor.data.init( initialData ); } ) @@ -206,3 +222,7 @@ export default class DecoupledEditor extends Editor { } mix( DecoupledEditor, DataApiMixin ); + +function getInitialData( sourceElementOrData ) { + return isElement( sourceElementOrData ) ? getDataFromElement( sourceElementOrData ) : sourceElementOrData; +} diff --git a/tests/decouplededitor.js b/tests/decouplededitor.js index 611a283..aa94503 100644 --- a/tests/decouplededitor.js +++ b/tests/decouplededitor.js @@ -114,6 +114,26 @@ describe( 'DecoupledEditor', () => { test( () => editableElement ); } ); + it( 'initializes with config.initialData', () => { + return DecoupledEditor.create( document.createElement( 'div' ), { + initialData: 'Hello world!
', + plugins: [ Paragraph ] + } ).then( editor => { + expect( editor.getData() ).to.equal( 'Hello world!
' ); + + editor.destroy(); + } ); + } ); + + it( 'throws if initial data is passed in Editor#create and config.initialData is also used', done => { + DecoupledEditor.create( 'Hello world!
', { + initialData: 'I am evil!
', + plugins: [ Paragraph ] + } ).catch( () => { + done(); + } ); + } ); + function test( getElementOrData ) { it( 'creates an instance which inherits from the DecoupledEditor', () => { return DecoupledEditor @@ -139,6 +159,19 @@ describe( 'DecoupledEditor', () => { } ); } ); + it( 'should not require config object', () => { + // Just being safe with `builtinPlugins` static property. + class CustomDecoupledEditor extends DecoupledEditor {} + CustomDecoupledEditor.builtinPlugins = [ Paragraph, Bold ]; + + return CustomDecoupledEditor.create( getElementOrData() ) + .then( newEditor => { + expect( newEditor.getData() ).to.equal( 'foo bar
' ); + + return newEditor.destroy(); + } ); + } ); + // https://github.com/ckeditor/ckeditor5-editor-classic/issues/53 it( 'creates an instance of a DecoupledEditor child class', () => { class CustomDecoupledEditor extends DecoupledEditor {}