| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals document, Event, console */
- import ClassicEditorUI from '../src/classiceditorui';
- import ClassicEditorUIView from '../src/classiceditoruiview';
- import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/htmldataprocessor';
- import ClassicEditor from '../src/classiceditor';
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
- import DataApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/dataapimixin';
- import ElementApiMixin from '@ckeditor/ckeditor5-core/src/editor/utils/elementapimixin';
- import RootElement from '@ckeditor/ckeditor5-engine/src/model/rootelement';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import ArticlePluginSet from '@ckeditor/ckeditor5-core/tests/_utils/articlepluginset';
- import { describeMemoryUsage, testMemoryUsage } from '@ckeditor/ckeditor5-core/tests/_utils/memory';
- import { removeEditorBodyOrphans } from '@ckeditor/ckeditor5-core/tests/_utils/cleanup';
- describe( 'ClassicEditor', () => {
- let editor, editorElement;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- editorElement = document.createElement( 'div' );
- editorElement.innerHTML = '<p><strong>foo</strong> bar</p>';
- document.body.appendChild( editorElement );
- testUtils.sinon.stub( console, 'warn' ).callsFake( () => {} );
- } );
- afterEach( () => {
- editorElement.remove();
- } );
- describe( 'constructor()', () => {
- beforeEach( () => {
- editor = new ClassicEditor( editorElement );
- } );
- it( 'uses HTMLDataProcessor', () => {
- expect( editor.data.processor ).to.be.instanceof( HtmlDataProcessor );
- } );
- it( 'has a Data Interface', () => {
- expect( testUtils.isMixed( ClassicEditor, DataApiMixin ) ).to.true;
- } );
- it( 'has a Element Interface', () => {
- expect( testUtils.isMixed( ClassicEditor, ElementApiMixin ) ).to.true;
- } );
- it( 'creates main root element', () => {
- expect( editor.model.document.getRoot( 'main' ) ).to.instanceof( RootElement );
- } );
- it( 'contains the source element as #sourceElement property', () => {
- expect( editor.sourceElement ).to.equal( editorElement );
- } );
- it( 'handles form element', () => {
- const form = document.createElement( 'form' );
- const textarea = document.createElement( 'textarea' );
- form.appendChild( textarea );
- document.body.appendChild( form );
- // Prevents page realods in Firefox ;|
- form.addEventListener( 'submit', evt => {
- evt.preventDefault();
- } );
- return ClassicEditor.create( textarea, {
- plugins: [ Paragraph ]
- } ).then( editor => {
- expect( textarea.value ).to.equal( '' );
- editor.setData( '<p>Foo</p>' );
- form.dispatchEvent( new Event( 'submit', {
- // We need to be able to do preventDefault() to prevent page reloads in Firefox.
- cancelable: true
- } ) );
- expect( textarea.value ).to.equal( '<p>Foo</p>' );
- return editor.destroy().then( () => {
- form.remove();
- } );
- } );
- } );
- describe( 'ui', () => {
- it( 'creates the UI using BoxedEditorUI classes', () => {
- expect( editor.ui ).to.be.instanceof( ClassicEditorUI );
- expect( editor.ui.view ).to.be.instanceof( ClassicEditorUIView );
- } );
- describe( 'automatic toolbar items groupping', () => {
- it( 'should be on by default', () => {
- const editorElement = document.createElement( 'div' );
- const editor = new ClassicEditor( editorElement );
- expect( editor.ui.view.toolbar.options.shouldGroupWhenFull ).to.be.true;
- editorElement.remove();
- } );
- it( 'can be disabled using config.toolbar.shouldNotGroupWhenFull', () => {
- const editorElement = document.createElement( 'div' );
- const editor = new ClassicEditor( editorElement, {
- toolbar: {
- shouldNotGroupWhenFull: true
- }
- } );
- expect( editor.ui.view.toolbar.options.shouldGroupWhenFull ).to.be.false;
- editorElement.remove();
- } );
- } );
- } );
- } );
- describe( 'create()', () => {
- beforeEach( () => {
- return ClassicEditor
- .create( editorElement, {
- plugins: [ Paragraph, Bold ]
- } )
- .then( newEditor => {
- editor = newEditor;
- } );
- } );
- afterEach( () => {
- return editor.destroy();
- } );
- it( 'creates an instance which inherits from the ClassicEditor', () => {
- expect( editor ).to.be.instanceof( ClassicEditor );
- } );
- it( 'loads data from the editor element', () => {
- expect( editor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
- } );
- // #53
- it( 'creates an instance of a ClassicEditor child class', () => {
- class CustomClassicEditor extends ClassicEditor {}
- return CustomClassicEditor
- .create( editorElement, {
- plugins: [ Paragraph, Bold ]
- } )
- .then( newEditor => {
- expect( newEditor ).to.be.instanceof( CustomClassicEditor );
- expect( newEditor ).to.be.instanceof( ClassicEditor );
- expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
- return newEditor.destroy();
- } );
- } );
- it( 'should not require config object', () => {
- // Just being safe with `builtinPlugins` static property.
- class CustomClassicEditor extends ClassicEditor {}
- CustomClassicEditor.builtinPlugins = [ Paragraph, Bold ];
- return CustomClassicEditor.create( editorElement )
- .then( newEditor => {
- expect( newEditor.getData() ).to.equal( '<p><strong>foo</strong> bar</p>' );
- return newEditor.destroy();
- } );
- } );
- it( 'allows to pass data to the constructor', () => {
- return ClassicEditor.create( '<p>Hello world!</p>', {
- plugins: [ Paragraph ]
- } ).then( editor => {
- expect( editor.getData() ).to.equal( '<p>Hello world!</p>' );
- editor.destroy();
- } );
- } );
- it( 'initializes with config.initialData', () => {
- return ClassicEditor.create( editorElement, {
- initialData: '<p>Hello world!</p>',
- plugins: [ Paragraph ]
- } ).then( editor => {
- expect( editor.getData() ).to.equal( '<p>Hello world!</p>' );
- editor.destroy();
- } );
- } );
- it( 'throws if initial data is passed in Editor#create and config.initialData is also used', done => {
- ClassicEditor.create( '<p>Hello world!</p>', {
- initialData: '<p>I am evil!</p>',
- plugins: [ Paragraph ]
- } ).catch( () => {
- removeEditorBodyOrphans();
- done();
- } );
- } );
- it( 'should have undefined the #sourceElement if editor was initialized with data', () => {
- return ClassicEditor
- .create( '<p>Foo.</p>', {
- plugins: [ Paragraph, Bold ]
- } )
- .then( newEditor => {
- expect( newEditor.sourceElement ).to.be.undefined;
- return newEditor.destroy();
- } );
- } );
- describe( 'ui', () => {
- it( 'inserts editor UI next to editor element', () => {
- expect( editor.ui.view.element.previousSibling ).to.equal( editorElement );
- } );
- it( 'attaches editable UI as view\'s DOM root', () => {
- expect( editor.editing.view.getDomRoot() ).to.equal( editor.ui.view.editable.element );
- } );
- } );
- } );
- describe( 'create - events', () => {
- afterEach( () => {
- return editor.destroy();
- } );
- it( 'fires all events in the right order', () => {
- const fired = [];
- function spy( evt ) {
- fired.push( `${ evt.name }-${ evt.source.constructor.name.toLowerCase() }` );
- }
- class EventWatcher extends Plugin {
- init() {
- this.editor.ui.on( 'ready', spy );
- this.editor.data.on( 'ready', spy );
- this.editor.on( 'ready', spy );
- }
- }
- return ClassicEditor
- .create( editorElement, {
- plugins: [ EventWatcher ]
- } )
- .then( newEditor => {
- expect( fired ).to.deep.equal(
- [ 'ready-classiceditorui', 'ready-datacontroller', 'ready-classiceditor' ] );
- editor = newEditor;
- } );
- } );
- it( 'fires ready once UI is rendered', () => {
- let isReady;
- class EventWatcher extends Plugin {
- init() {
- this.editor.ui.on( 'ready', () => {
- isReady = this.editor.ui.view.isRendered;
- } );
- }
- }
- return ClassicEditor
- .create( editorElement, {
- plugins: [ EventWatcher ]
- } )
- .then( newEditor => {
- expect( isReady ).to.be.true;
- editor = newEditor;
- } );
- } );
- } );
- describe( 'destroy', () => {
- beforeEach( function() {
- return ClassicEditor
- .create( editorElement, { plugins: [ Paragraph ] } )
- .then( newEditor => {
- editor = newEditor;
- } );
- } );
- it( 'sets the data back to the editor element', () => {
- editor.setData( '<p>foo</p>' );
- return editor.destroy()
- .then( () => {
- expect( editorElement.innerHTML ).to.equal( '<p>foo</p>' );
- } );
- } );
- it( 'does not update the source element if editor was initialized with data', async () => {
- await editor.destroy();
- return ClassicEditor
- .create( '<p>Foo.</p>', {
- plugins: [ Paragraph, Bold ]
- } )
- .then( newEditor => {
- const spy = sinon.stub( newEditor, 'updateSourceElement' );
- return newEditor.destroy()
- .then( () => {
- expect( spy.called ).to.be.false;
- spy.restore();
- } );
- } );
- } );
- it( 'restores the editor element', () => {
- expect( editor.sourceElement.style.display ).to.equal( 'none' );
- return editor.destroy()
- .then( () => {
- expect( editor.sourceElement.style.display ).to.equal( '' );
- } );
- } );
- } );
- describeMemoryUsage( () => {
- testMemoryUsage(
- 'should not grow on multiple create/destroy',
- () => ClassicEditor
- .create( document.querySelector( '#mem-editor' ), {
- plugins: [ ArticlePluginSet ],
- toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote' ],
- image: {
- toolbar: [ 'imageStyle:full', 'imageStyle:side', '|', 'imageTextAlternative' ]
- }
- } ) );
- } );
- } );
|