| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348 |
- /**
- * @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 */
- import View from '@ckeditor/ckeditor5-ui/src/view';
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import ClassicEditorUI from '../src/classiceditorui';
- import EditorUI from '@ckeditor/ckeditor5-core/src/editor/editorui';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import ClassicEditorUIView from '../src/classiceditoruiview';
- import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import { assertBinding } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
- import { isElement } from 'lodash-es';
- describe( 'ClassicEditorUI', () => {
- let editor, view, ui, viewElement;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- return VirtualClassicTestEditor
- .create( '', {
- toolbar: [ 'foo', 'bar' ]
- } )
- .then( newEditor => {
- editor = newEditor;
- ui = editor.ui;
- view = ui.view;
- viewElement = view.element;
- } );
- } );
- afterEach( () => {
- editor.destroy();
- } );
- describe( 'constructor()', () => {
- it( 'extends EditorUI', () => {
- expect( ui ).to.instanceof( EditorUI );
- } );
- } );
- describe( 'init()', () => {
- it( 'renders the #view', () => {
- expect( view.isRendered ).to.be.true;
- } );
- describe( 'stickyPanel', () => {
- it( 'binds view.stickyToolbar#isActive to editor.focusTracker#isFocused', () => {
- ui.focusTracker.isFocused = false;
- expect( view.stickyPanel.isActive ).to.be.false;
- ui.focusTracker.isFocused = true;
- expect( view.stickyPanel.isActive ).to.be.true;
- } );
- it( 'sets view.stickyToolbar#limiterElement', () => {
- expect( view.stickyPanel.limiterElement ).to.equal( view.element );
- } );
- it( 'doesn\'t set view.stickyToolbar#viewportTopOffset, if not specified in the config', () => {
- expect( view.stickyPanel.viewportTopOffset ).to.equal( 0 );
- } );
- it( 'sets view.stickyPanel#viewportTopOffset, when specified in the config', () => {
- return VirtualClassicTestEditor
- .create( '', {
- toolbar: {
- viewportTopOffset: 100
- }
- } )
- .then( editor => {
- expect( editor.ui.view.stickyPanel.viewportTopOffset ).to.equal( 100 );
- return editor.destroy();
- } );
- } );
- } );
- describe( 'editable', () => {
- it( 'registers view.editable#element in editor focus tracker', () => {
- ui.focusTracker.isFocused = false;
- view.editable.element.dispatchEvent( new Event( 'focus' ) );
- expect( ui.focusTracker.isFocused ).to.true;
- } );
- it( 'binds view.editable#isFocused', () => {
- assertBinding(
- view.editable,
- { isFocused: false },
- [
- [ ui.focusTracker, { isFocused: true } ]
- ],
- { isFocused: true }
- );
- } );
- it( 'set view.editable#name', () => {
- const editable = editor.editing.view.document.getRoot();
- expect( view.editable.name ).to.equal( editable.rootName );
- } );
- } );
- describe( 'placeholder', () => {
- it( 'sets placeholder from editor.config.placeholder', () => {
- return VirtualClassicTestEditor
- .create( 'foo', {
- extraPlugins: [ Paragraph ],
- placeholder: 'placeholder-text'
- } )
- .then( newEditor => {
- const firstChild = newEditor.editing.view.document.getRoot().getChild( 0 );
- expect( firstChild.getAttribute( 'data-placeholder' ) ).to.equal( 'placeholder-text' );
- return newEditor.destroy();
- } );
- } );
- it( 'sets placeholder from the "placeholder" attribute of a passed <textarea>', () => {
- const element = document.createElement( 'textarea' );
- element.setAttribute( 'placeholder', 'placeholder-text' );
- return VirtualClassicTestEditor
- .create( element, {
- extraPlugins: [ Paragraph ]
- } )
- .then( newEditor => {
- const firstChild = newEditor.editing.view.document.getRoot().getChild( 0 );
- expect( firstChild.getAttribute( 'data-placeholder' ) ).to.equal( 'placeholder-text' );
- return newEditor.destroy();
- } );
- } );
- it( 'uses editor.config.placeholder rather than the "placeholder" attribute of a passed <textarea>', () => {
- const element = document.createElement( 'textarea' );
- element.setAttribute( 'placeholder', 'placeholder-text' );
- return VirtualClassicTestEditor
- .create( element, {
- placeholder: 'config takes precedence',
- extraPlugins: [ Paragraph ]
- } )
- .then( newEditor => {
- const firstChild = newEditor.editing.view.document.getRoot().getChild( 0 );
- expect( firstChild.getAttribute( 'data-placeholder' ) ).to.equal( 'config takes precedence' );
- return newEditor.destroy();
- } );
- } );
- } );
- describe( 'view.toolbar', () => {
- describe( '#items', () => {
- it( 'are filled with the config.toolbar (specified as an Array)', () => {
- return VirtualClassicTestEditor
- .create( '', {
- toolbar: [ 'foo', 'bar' ]
- } )
- .then( editor => {
- const items = editor.ui.view.toolbar.items;
- expect( items.get( 0 ).name ).to.equal( 'foo' );
- expect( items.get( 1 ).name ).to.equal( 'bar' );
- return editor.destroy();
- } );
- } );
- it( 'are filled with the config.toolbar (specified as an Object)', () => {
- return VirtualClassicTestEditor
- .create( '', {
- toolbar: {
- items: [ 'foo', 'bar' ],
- viewportTopOffset: 100
- }
- } )
- .then( editor => {
- const items = editor.ui.view.toolbar.items;
- expect( items.get( 0 ).name ).to.equal( 'foo' );
- expect( items.get( 1 ).name ).to.equal( 'bar' );
- return editor.destroy();
- } );
- } );
- } );
- } );
- it( 'initializes keyboard navigation between view#toolbar and view#editable', () => {
- return VirtualClassicTestEditor.create( '' )
- .then( editor => {
- const ui = editor.ui;
- const view = ui.view;
- const spy = testUtils.sinon.spy( view.toolbar, 'focus' );
- ui.focusTracker.isFocused = true;
- ui.view.toolbar.focusTracker.isFocused = false;
- editor.keystrokes.press( {
- keyCode: keyCodes.f10,
- altKey: true,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- } );
- sinon.assert.calledOnce( spy );
- return editor.destroy();
- } );
- } );
- } );
- describe( 'destroy()', () => {
- it( 'detaches the DOM root then destroys the UI view', () => {
- return VirtualClassicTestEditor.create( '' )
- .then( newEditor => {
- const destroySpy = sinon.spy( newEditor.ui.view, 'destroy' );
- const detachSpy = sinon.spy( newEditor.editing.view, 'detachDomRoot' );
- return newEditor.destroy()
- .then( () => {
- sinon.assert.callOrder( detachSpy, destroySpy );
- } );
- } );
- } );
- it( 'restores the editor element back to its original state', () => {
- const domElement = document.createElement( 'div' );
- domElement.setAttribute( 'foo', 'bar' );
- domElement.setAttribute( 'data-baz', 'qux' );
- domElement.classList.add( 'foo-class' );
- return VirtualClassicTestEditor.create( domElement )
- .then( newEditor => {
- return newEditor.destroy()
- .then( () => {
- const attributes = {};
- for ( const attribute of Array.from( domElement.attributes ) ) {
- attributes[ attribute.name ] = attribute.value;
- }
- expect( attributes ).to.deep.equal( {
- foo: 'bar',
- 'data-baz': 'qux',
- class: 'foo-class'
- } );
- } );
- } );
- } );
- } );
- describe( 'view()', () => {
- it( 'returns view instance', () => {
- expect( ui.view ).to.equal( view );
- } );
- } );
- describe( 'element()', () => {
- it( 'returns correct element instance', () => {
- expect( ui.element ).to.equal( viewElement );
- } );
- } );
- describe( 'getEditableElement()', () => {
- it( 'returns editable element (default)', () => {
- expect( ui.getEditableElement() ).to.equal( view.editable.element );
- } );
- it( 'returns editable element (root name passed)', () => {
- expect( ui.getEditableElement( 'main' ) ).to.equal( view.editable.element );
- } );
- it( 'returns undefined if editable with the given name is absent', () => {
- expect( ui.getEditableElement( 'absent' ) ).to.be.undefined;
- } );
- } );
- } );
- function viewCreator( name ) {
- return locale => {
- const view = new View( locale );
- view.name = name;
- view.element = document.createElement( 'a' );
- return view;
- };
- }
- class VirtualClassicTestEditor extends VirtualTestEditor {
- constructor( sourceElementOrData, config ) {
- super( config );
- if ( isElement( sourceElementOrData ) ) {
- this.sourceElement = sourceElementOrData;
- }
- const view = new ClassicEditorUIView( this.locale, this.editing.view );
- this.ui = new ClassicEditorUI( this, view );
- this.ui.componentFactory.add( 'foo', viewCreator( 'foo' ) );
- this.ui.componentFactory.add( 'bar', viewCreator( 'bar' ) );
- }
- destroy() {
- this.ui.destroy();
- return super.destroy();
- }
- static create( sourceElementOrData, config ) {
- return new Promise( resolve => {
- const editor = new this( sourceElementOrData, config );
- resolve(
- editor.initPlugins()
- .then( () => {
- editor.ui.init();
- const initialData = isElement( sourceElementOrData ) ?
- sourceElementOrData.innerHTML :
- sourceElementOrData;
- editor.data.init( initialData );
- editor.fire( 'ready' );
- } )
- .then( () => editor )
- );
- } );
- }
- }
|