| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538 |
- /**
- * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* global document */
- import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
- import Title from '../src/title';
- import Enter from '@ckeditor/ckeditor5-enter/src/enter';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import BlockQuote from '@ckeditor/ckeditor5-block-quote/src/blockquote';
- import Heading from '@ckeditor/ckeditor5-heading/src/heading';
- import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
- import Image from '@ckeditor/ckeditor5-image/src/image';
- import ImageUpload from '@ckeditor/ckeditor5-image/src/imageupload';
- import Undo from '@ckeditor/ckeditor5-undo/src/undo';
- import DataTransfer from '@ckeditor/ckeditor5-clipboard/src/datatransfer';
- import { UploadAdapterMock, createNativeFileMock } from '@ckeditor/ckeditor5-upload/tests/_utils/mocks';
- import { setData, getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
- describe( 'Title', () => {
- let element, editor, model;
- beforeEach( () => {
- element = document.createElement( 'div' );
- document.body.appendChild( element );
- return ClassicTestEditor.create( element, {
- plugins: [ Title, Heading, BlockQuote, Clipboard, Image, ImageUpload, Enter, Undo ]
- } ).then( _editor => {
- editor = _editor;
- model = editor.model;
- } );
- } );
- afterEach( () => {
- return editor.destroy().then( () => element.remove() );
- } );
- it( 'should requires certain plugins', () => {
- expect( Title.requires ).to.have.members( [ Paragraph, Enter ] );
- } );
- it( 'should have plugin name property', () => {
- expect( Title.pluginName ).to.equal( 'Title' );
- } );
- it( 'should set proper schema rules', () => {
- expect( model.schema.isRegistered( 'title', '$text' ) ).to.equal( true );
- expect( model.schema.checkChild( [ 'title' ], '$text' ) ).to.equal( true );
- expect( model.schema.checkChild( [ '$root' ], 'title' ) ).to.equal( true );
- expect( model.schema.checkChild( [ '$root', 'blockQuote' ], 'title' ) ).to.equal( false );
- expect( model.schema.checkChild( [ '$root', 'paragraph' ], 'title' ) ).to.equal( false );
- } );
- it( 'should convert title to h1', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- expect( editor.getData() ).to.equal( '<h1>Foo</h1><p>Bar</p>' );
- } );
- describe( 'model post-fixing', () => {
- it( 'should set title and content elements', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><paragraph>Bar</paragraph>' );
- } );
- it( 'should create a content element when only title has been set', () => {
- setData( model, '<title>Foo</title>' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><paragraph></paragraph>' );
- } );
- it( 'should create a title and content elements when are missing', () => {
- setData( model, '' );
- expect( getData( model ) ).to.equal( '<title>[]</title><paragraph></paragraph>' );
- } );
- it( 'should change heading1 element to title when is set as a first root child', () => {
- setData( model, '<heading1>Foo</heading1><heading1>Bar</heading1>' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><heading1>Bar</heading1>' );
- } );
- it( 'should change heading2 element to title when is set as a first root child', () => {
- setData( model, '<heading2>Foo</heading2><heading2>Bar</heading2>' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><heading2>Bar</heading2>' );
- } );
- it( 'should change heading3 element to title when is set as a first root child', () => {
- setData( model, '<heading3>Foo</heading3><heading3>Bar</heading3>' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><heading3>Bar</heading3>' );
- } );
- it( 'should change paragraph element to title when is set as a first root child', () => {
- setData( model, '<paragraph>Foo</paragraph><paragraph>Bar</paragraph>' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><paragraph>Bar</paragraph>' );
- } );
- it( 'should change title element to a paragraph when is not a first root child #1', () => {
- setData( model, '<title>Foo</title><title>Bar</title>' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><paragraph>Bar</paragraph>' );
- } );
- it( 'should change title element to a paragraph when is not a first root child #2', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph><title>Biz</title>' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><paragraph>Bar</paragraph><paragraph>Biz</paragraph>' );
- } );
- it( 'should move element after a title element when is not allowed to be a title', () => {
- setData( model, '<blockQuote><paragraph>Foo</paragraph></blockQuote><title>Bar</title>' );
- expect( getData( model ) ).to.equal( '<title>[]Bar</title><blockQuote><paragraph>Foo</paragraph></blockQuote>' );
- } );
- it( 'should create a missing title element before an element that cannot to be a title element', () => {
- setData( model, '<blockQuote><paragraph>Foo</paragraph></blockQuote>' );
- expect( getData( model ) ).to.equal( '<title>[]</title><blockQuote><paragraph>Foo</paragraph></blockQuote>' );
- } );
- it( 'should clear element from disallowed attributes when changing to title element', () => {
- model.schema.extend( '$text', { allowAttributes: 'bold' } );
- model.schema.addAttributeCheck( ( context, attributeName ) => {
- if ( context.endsWith( 'title $text' ) && attributeName === 'bold' ) {
- return false;
- }
- } );
- setData( model,
- '<paragraph>F<$text bold="true">o</$text>o</paragraph><paragraph>B<$text bold="true">a</$text>r</paragraph>'
- );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><paragraph>B<$text bold="true">a</$text>r</paragraph>' );
- } );
- } );
- describe( 'setTitle()', () => {
- it( 'should set new content of a title element', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- editor.plugins.get( 'Title' ).setTitle( 'Biz' );
- expect( getData( model ) ).to.equal( '<title>[]Biz</title><paragraph>Bar</paragraph>' );
- } );
- it( 'should clear content of a title element', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- editor.plugins.get( 'Title' ).setTitle( '' );
- expect( getData( model ) ).to.equal( '<title>[]</title><paragraph>Bar</paragraph>' );
- } );
- } );
- describe( 'getTitle()', () => {
- it( 'should return content of a title element', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- expect( editor.plugins.get( 'Title' ).getTitle() ).to.equal( 'Foo' );
- } );
- it( 'should return content of an empty title element', () => {
- setData( model, '<title></title><paragraph>Bar</paragraph>' );
- expect( editor.plugins.get( 'Title' ).getTitle() ).to.equal( '' );
- } );
- } );
- describe( 'setBody()', () => {
- it( 'should set new content to body', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- editor.plugins.get( 'Title' ).setBody( 'Biz' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><paragraph>Biz</paragraph>' );
- } );
- it( 'should set empty content to body', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- editor.plugins.get( 'Title' ).setBody( '' );
- expect( getData( model ) ).to.equal( '<title>[]Foo</title><paragraph></paragraph>' );
- } );
- it( 'should set html content to body', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- editor.plugins.get( 'Title' ).setBody( '<blockQuote>Bar</blockQuote><p>Biz</p>' );
- expect( getData( model ) ).to.equal(
- '<title>[]Foo</title><blockQuote><paragraph>Bar</paragraph></blockQuote><paragraph>Biz</paragraph>'
- );
- } );
- } );
- describe( 'getBody()', () => {
- it( 'should return all data except the title element', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph><paragraph>Biz</paragraph>' );
- expect( editor.plugins.get( 'Title' ).getBody() ).to.equal( '<p>Bar</p><p>Biz</p>' );
- } );
- it( 'should return empty paragraph when body is empty', () => {
- setData( model, '<title>Foo</title>' );
- expect( editor.plugins.get( 'Title' ).getBody() ).to.equal( '<p> </p>' );
- } );
- } );
- describe( 'placeholders', () => {
- let viewRoot;
- beforeEach( () => {
- viewRoot = editor.editing.view.document.getRoot();
- } );
- it( 'should attach placeholder placeholder to title and body', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- const title = viewRoot.getChild( 0 );
- const body = viewRoot.getChild( 1 );
- expect( title.getAttribute( 'data-placeholder' ) ).to.equal( 'Title' );
- expect( body.getAttribute( 'data-placeholder' ) ).to.equal( 'Body' );
- expect( title.hasClass( 'ck-placeholder' ) ).to.equal( false );
- expect( body.hasClass( 'ck-placeholder' ) ).to.equal( false );
- } );
- it( 'should show placeholder in empty title and body', () => {
- setData( model, '<title></title><paragraph></paragraph>' );
- const title = viewRoot.getChild( 0 );
- const body = viewRoot.getChild( 1 );
- expect( title.getAttribute( 'data-placeholder' ) ).to.equal( 'Title' );
- expect( body.getAttribute( 'data-placeholder' ) ).to.equal( 'Body' );
- expect( title.hasClass( 'ck-placeholder' ) ).to.equal( true );
- expect( body.hasClass( 'ck-placeholder' ) ).to.equal( true );
- } );
- it( 'should hide placeholder from body with more than one child elements', () => {
- setData( editor.model, '<title>Foo</title><paragraph></paragraph><paragraph></paragraph>' );
- const body = viewRoot.getChild( 1 );
- expect( body.getAttribute( 'data-placeholder' ) ).to.equal( 'Body' );
- expect( body.hasClass( 'ck-placeholder' ) ).to.equal( false );
- } );
- it( 'should hide placeholder from body with element other than paragraph', () => {
- setData( editor.model, '<title>Foo</title><heading1></heading1>' );
- const body = viewRoot.getChild( 1 );
- expect( body.hasAttribute( 'data-placeholder' ) ).to.equal( true );
- expect( body.hasClass( 'ck-placeholder' ) ).to.equal( false );
- } );
- it( 'should hide placeholder when title element become not empty', () => {
- setData( model, '<title></title><paragraph>[]</paragraph>' );
- expect( viewRoot.getChild( 0 ).hasClass( 'ck-placeholder' ) ).to.equal( true );
- model.change( writer => {
- writer.appendText( 'Bar', null, model.document.getRoot().getChild( 0 ) );
- } );
- expect( viewRoot.getChild( 0 ).hasClass( 'ck-placeholder' ) ).to.equal( false );
- } );
- it( 'should hide placeholder when body element become not empty', () => {
- setData( model, '<title>Foo</title><paragraph></paragraph>' );
- expect( viewRoot.getChild( 1 ).hasClass( 'ck-placeholder' ) ).to.equal( true );
- model.change( writer => {
- writer.appendText( 'Bar', null, model.document.getRoot().getChild( 1 ) );
- } );
- expect( viewRoot.getChild( 1 ).hasClass( 'ck-placeholder' ) ).to.equal( false );
- } );
- it( 'should properly map the body placeholder in DOM when undoing', () => {
- const viewRoot = editor.editing.view.document.getRoot();
- const domConverter = editor.editing.view.domConverter;
- let bodyDomElement;
- setData( editor.model, '<title>[Foo</title><paragraph>Bar</paragraph><paragraph>Baz]</paragraph>' );
- editor.model.deleteContent( editor.model.document.selection );
- bodyDomElement = domConverter.mapViewToDom( viewRoot.getChild( 1 ) );
- expect( bodyDomElement.dataset.placeholder ).to.equal( 'Body' );
- expect( bodyDomElement.classList.contains( 'ck-placeholder' ) ).to.be.true;
- editor.execute( 'undo' );
- bodyDomElement = domConverter.mapViewToDom( viewRoot.getChild( 1 ) );
- expect( bodyDomElement.dataset.placeholder ).to.equal( 'Body' );
- expect( bodyDomElement.classList.contains( 'ck-placeholder' ) ).to.be.false;
- } );
- } );
- describe( 'Tab press handling', () => {
- it( 'should handle tab key when the selection is at the beginning of the title', () => {
- setData( model, '<title>[]foo</title><paragraph>bar</paragraph>' );
- const eventData = getEventData( keyCodes.tab );
- editor.keystrokes.press( eventData );
- sinon.assert.calledOnce( eventData.preventDefault );
- sinon.assert.calledOnce( eventData.stopPropagation );
- expect( getData( model ) ).to.equal( '<title>foo</title><paragraph>[]bar</paragraph>' );
- } );
- it( 'should handle tab key when the selection is at the end of the title', () => {
- setData( model, '<title>foo[]</title><paragraph>bar</paragraph>' );
- const eventData = getEventData( keyCodes.tab );
- editor.keystrokes.press( eventData );
- sinon.assert.calledOnce( eventData.preventDefault );
- sinon.assert.calledOnce( eventData.stopPropagation );
- expect( getData( model ) ).to.equal( '<title>foo</title><paragraph>[]bar</paragraph>' );
- } );
- it( 'should not handle tab key when the selection is in the title and body', () => {
- setData( model, '<title>fo[o</title><paragraph>b]ar</paragraph>' );
- const eventData = getEventData( keyCodes.tab );
- editor.keystrokes.press( eventData );
- sinon.assert.notCalled( eventData.preventDefault );
- sinon.assert.notCalled( eventData.stopPropagation );
- expect( getData( model ) ).to.equal( '<title>fo[o</title><paragraph>b]ar</paragraph>' );
- } );
- it( 'should not handle tab key when the selection is in the body', () => {
- setData( model, '<title>foo</title><paragraph>[]bar</paragraph>' );
- const eventData = getEventData( keyCodes.tab );
- editor.keystrokes.press( eventData );
- sinon.assert.notCalled( eventData.preventDefault );
- sinon.assert.notCalled( eventData.stopPropagation );
- expect( getData( model ) ).to.equal( '<title>foo</title><paragraph>[]bar</paragraph>' );
- } );
- } );
- describe( 'Shift + Tab press handling', () => {
- it( 'should handle shift + tab keys when the selection is at the beginning of the body', () => {
- setData( model, '<title>foo</title><paragraph>[]bar</paragraph>' );
- const eventData = getEventData( keyCodes.tab, { shiftKey: true } );
- editor.keystrokes.press( eventData );
- sinon.assert.calledOnce( eventData.preventDefault );
- sinon.assert.calledOnce( eventData.stopPropagation );
- expect( getData( model ) ).to.equal( '<title>[]foo</title><paragraph>bar</paragraph>' );
- } );
- it( 'should not handle shift + tab keys when the selection is not at the beginning of the body', () => {
- setData( model, '<title>foo</title><paragraph>b[]ar</paragraph>' );
- const eventData = getEventData( keyCodes.tab, { shiftKey: true } );
- editor.keystrokes.press( eventData );
- sinon.assert.notCalled( eventData.preventDefault );
- sinon.assert.notCalled( eventData.stopPropagation );
- expect( getData( model ) ).to.equal( '<title>foo</title><paragraph>b[]ar</paragraph>' );
- } );
- it( 'should not handle shift + tab keys when the selection is not collapsed', () => {
- setData( model, '<title>foo</title><paragraph>[b]ar</paragraph>' );
- const eventData = getEventData( keyCodes.tab, { shiftKey: true } );
- editor.keystrokes.press( eventData );
- sinon.assert.notCalled( eventData.preventDefault );
- sinon.assert.notCalled( eventData.stopPropagation );
- expect( getData( model ) ).to.equal( '<title>foo</title><paragraph>[b]ar</paragraph>' );
- } );
- it( 'should not handle shift + tab keys when the selection is in the title', () => {
- setData( model, '<title>[]foo</title><paragraph>bar</paragraph>' );
- const eventData = getEventData( keyCodes.tab, { shiftKey: true } );
- editor.keystrokes.press( eventData );
- sinon.assert.notCalled( eventData.preventDefault );
- sinon.assert.notCalled( eventData.stopPropagation );
- expect( getData( model ) ).to.equal( '<title>[]foo</title><paragraph>bar</paragraph>' );
- } );
- } );
- describe( 'prevent extra paragraphing', () => {
- it( 'should remove the extra paragraph when pasting to the editor with body placeholder', () => {
- setData( model, '<title>[]</title>' );
- const dataTransferMock = {
- getData: type => {
- if ( type === 'text/html' ) {
- return '<h1>Title</h1><p>Body</p>';
- }
- },
- types: [],
- files: []
- };
- editor.editing.view.document.fire( 'paste', {
- dataTransfer: dataTransferMock,
- preventDefault() {}
- } );
- expect( getData( model ) ).to.equal( '<title>Title</title><paragraph>Body[]</paragraph>' );
- } );
- it( 'should not remove the extra paragraph when pasting to the editor with directly created body element', () => {
- setData( model, '<title>[]</title><paragraph></paragraph>' );
- const dataTransferMock = {
- getData: type => {
- if ( type === 'text/html' ) {
- return '<h1>Title</h1><p>Body</p>';
- }
- },
- types: [],
- files: []
- };
- editor.editing.view.document.fire( 'paste', {
- dataTransfer: dataTransferMock,
- preventDefault() {}
- } );
- expect( getData( model ) ).to.equal( '<title>Title</title><paragraph>Body[]</paragraph><paragraph></paragraph>' );
- } );
- it( 'should remove the extra paragraph when pressing enter in the title', () => {
- setData( model, '<title>fo[]o</title>' );
- editor.execute( 'enter' );
- expect( getData( model ) ).to.equal( '<title>fo</title><paragraph>[]o</paragraph>' );
- } );
- it( 'should not remove the extra paragraph when pressing enter in the title when body is created directly', () => {
- setData( model, '<title>fo[]o</title><paragraph></paragraph>' );
- editor.execute( 'enter' );
- expect( getData( model ) ).to.equal( '<title>fo</title><paragraph>[]o</paragraph><paragraph></paragraph>' );
- } );
- } );
- describe( 'upload to title - integration', () => {
- let file, fileRepository;
- beforeEach( () => {
- fileRepository = editor.plugins.get( 'FileRepository' );
- fileRepository.createUploadAdapter = newLoader => new UploadAdapterMock( newLoader );
- file = createNativeFileMock();
- } );
- it( 'should move image after the title when was dropped before it', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- const dataTransfer = new DataTransfer( { files: [ file ], types: [ 'Files' ] } );
- const targetRange = model.createRange( model.createPositionAt( model.document.getRoot(), 0 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- editor.editing.view.document.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- const { id } = fileRepository.getLoader( file );
- expect( getData( model ) ).to.equal(
- '<title>Foo</title>' +
- `[<image uploadId="${ id }" uploadStatus="reading"></image>]` +
- '<paragraph>Bar</paragraph>'
- );
- } );
- it( 'should move image after the title when was dropped to it', () => {
- setData( model, '<title>Foo</title><paragraph>Bar</paragraph>' );
- const dataTransfer = new DataTransfer( { files: [ file ], types: [ 'Files' ] } );
- const title = model.document.getRoot().getChild( 0 );
- const targetRange = model.createRange( model.createPositionAt( title, 1 ) );
- const targetViewRange = editor.editing.mapper.toViewRange( targetRange );
- editor.editing.view.document.fire( 'clipboardInput', { dataTransfer, targetRanges: [ targetViewRange ] } );
- const { id } = fileRepository.getLoader( file );
- expect( getData( model ) ).to.equal(
- '<title>Foo</title>' +
- `[<image uploadId="${ id }" uploadStatus="reading"></image>]` +
- '<paragraph>Bar</paragraph>'
- );
- } );
- } );
- } );
- function getEventData( keyCode, { shiftKey = false } = {} ) {
- return {
- keyCode,
- shiftKey,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- }
|