diff --git a/src/decouplededitor.js b/src/decouplededitor.js index 06e65b6..6191418 100644 --- a/src/decouplededitor.js +++ b/src/decouplededitor.js @@ -16,6 +16,7 @@ import getDataFromElement from '@ckeditor/ckeditor5-utils/src/dom/getdatafromele import setDataInElement from '@ckeditor/ckeditor5-utils/src/dom/setdatainelement'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; import { isElement } from 'lodash-es'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * The {@glink builds/guides/overview#document-editor decoupled editor} implementation. @@ -151,8 +152,8 @@ export default class DecoupledEditor extends Editor { * 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: + * Creating an instance when using initial data instead of a DOM element. + * The editor will then render an editable element that must be inserted into the DOM for the editor to work properly: * * DecoupledEditor * .create( '

Editor data

' ) @@ -169,6 +170,22 @@ export default class DecoupledEditor extends Editor { * console.error( err.stack ); * } ); * + * Creating an instance on an existing DOM element using external initial content (specified in config): + * + * DecoupledEditor + * .create( document.querySelector( '#editor' ), { + * initialData: '

Initial data

Foo bar.

' + * } ) + * .then( editor => { + * // Append the toolbar to the element. + * document.body.appendChild( editor.ui.view.toolbar.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. * @@ -178,11 +195,11 @@ export default class DecoupledEditor extends Editor { * * 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. + * @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 ) { + static create( sourceElementOrData, config = {} ) { return new Promise( resolve => { const editor = new this( sourceElementOrData, config ); @@ -192,9 +209,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 +228,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 {}