Hello world!
' ) * .then( editor => { * 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 ); * } ); * - * Creating an instance when using the initial data instead of a DOM element: + * 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. * - * import InlineEditor from '@ckeditor/ckeditor5-editor-inline/src/inlineeditor'; - * 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 ... + * You can also mix those two ways by providing a DOM element to be used and passing the initial data through the config: * * InlineEditor - * .create( 'Hello world!
' ) + * .create( document.querySelector( '#editor' ), { + * initialData: 'Foo bar.
' + * } ) * .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 ); * } ); * + * 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 the 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-inline/inlineeditor~InlineEditor#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.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-inline/inlineeditor~InlineEditor} 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-inline/inlineeditorui~InlineEditorUI#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 ); @@ -175,9 +178,14 @@ export default class InlineEditor 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 ); } ) @@ -190,3 +198,7 @@ export default class InlineEditor extends Editor { mix( InlineEditor, DataApiMixin ); mix( InlineEditor, ElementApiMixin ); + +function getInitialData( sourceElementOrData ) { + return isElement( sourceElementOrData ) ? getDataFromElement( sourceElementOrData ) : sourceElementOrData; +} diff --git a/tests/inlineeditor.js b/tests/inlineeditor.js index bd960ff..cf6138e 100644 --- a/tests/inlineeditor.js +++ b/tests/inlineeditor.js @@ -99,14 +99,6 @@ describe( 'InlineEditor', () => { } ); } ); - it( 'allows to pass data to the constructor', () => { - return InlineEditor.create( 'Hello world!
', { - plugins: [ Paragraph ] - } ).then( editor => { - expect( editor.getData() ).to.equal( 'Hello world!
' ); - } ); - } ); - it( 'should have undefined the #sourceElement if editor was initialized with data', () => { return InlineEditor.create( 'Hello world!
', { plugins: [ Paragraph ] @@ -155,6 +147,49 @@ describe( 'InlineEditor', () => { expect( editor.getData() ).to.equal( 'foo bar
' ); } ); + it( 'should not require config object', () => { + // Just being safe with `builtinPlugins` static property. + class CustomInlineEditor extends InlineEditor {} + CustomInlineEditor.builtinPlugins = [ Paragraph, Bold ]; + + return CustomInlineEditor.create( editorElement ) + .then( newEditor => { + expect( newEditor.getData() ).to.equal( 'foo bar
' ); + + return newEditor.destroy(); + } ); + } ); + + it( 'allows to pass data to the constructor', () => { + return InlineEditor.create( 'Hello world!
', { + plugins: [ Paragraph ] + } ).then( editor => { + expect( editor.getData() ).to.equal( 'Hello world!
' ); + + editor.destroy(); + } ); + } ); + + it( 'initializes with config.initialData', () => { + return InlineEditor.create( editorElement, { + 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 => { + InlineEditor.create( 'Hello world!
', { + initialData: 'I am evil!
', + plugins: [ Paragraph ] + } ).catch( () => { + done(); + } ); + } ); + // #25 it( 'creates an instance of a InlineEditor child class', () => { // Fun fact: Remove the next 3 lines and you'll get a lovely inf loop due to two diff --git a/tests/manual/inlineeditor-data.js b/tests/manual/inlineeditor-data.js index 0ac9c60..0364aab 100644 --- a/tests/manual/inlineeditor-data.js +++ b/tests/manual/inlineeditor-data.js @@ -21,7 +21,7 @@ function initEditor() { .then( editor => { counter += 1; window.editors.push( editor ); - container.appendChild( editor.element ); + container.appendChild( editor.ui.element ); } ) .catch( err => { console.error( err.stack ); @@ -32,7 +32,7 @@ function destroyEditors() { window.editors.forEach( editor => { editor.destroy() .then( () => { - editor.element.remove(); + editor.ui.element.remove(); } ); } ); window.editors = []; diff --git a/tests/manual/inlineeditor.js b/tests/manual/inlineeditor.js index b74ee14..cabee30 100644 --- a/tests/manual/inlineeditor.js +++ b/tests/manual/inlineeditor.js @@ -63,5 +63,3 @@ function destroyEditors() { document.getElementById( 'initEditors' ).addEventListener( 'click', initEditors ); document.getElementById( 'destroyEditors' ).addEventListener( 'click', destroyEditors ); - -initEditors();