| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import Widget from '../src/widget';
- import Typing from '@ckeditor/ckeditor5-typing/src/typing';
- import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
- import { downcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/downcast-converters';
- import { toWidget } from '../src/utils';
- import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
- import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import env from '@ckeditor/ckeditor5-utils/src/env';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- /* global document */
- describe( 'Widget', () => {
- let editor, model, view, viewDocument;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- // Most tests assume non-edge environment but we do not set `contenteditable=false` on Edge so stub `env.isEdge`.
- testUtils.sinon.stub( env, 'isEdge' ).get( () => false );
- return VirtualTestEditor.create( { plugins: [ Widget, Typing ] } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- view = editor.editing.view;
- viewDocument = view.document;
- model.schema.register( 'widget', {
- inheritAllFrom: '$block',
- isObject: true
- } );
- model.schema.register( 'paragraph', {
- inheritAllFrom: '$block',
- allowIn: 'div'
- } );
- model.schema.register( 'inline', {
- allowWhere: '$text',
- isObject: true
- } );
- model.schema.register( 'nested', {
- allowIn: 'widget',
- isLimit: true
- } );
- model.schema.extend( '$text', {
- allowIn: [ 'nested', 'editable' ]
- } );
- model.schema.register( 'editable', {
- allowIn: [ 'widget', '$root' ]
- } );
- // Image feature.
- model.schema.register( 'image', {
- allowIn: '$root',
- isObject: true,
- isBlock: true
- } );
- // Block-quote feature.
- model.schema.register( 'blockQuote', {
- allowIn: '$root'
- } );
- model.schema.extend( '$block', { allowIn: 'blockQuote' } );
- // Div element which helps nesting elements.
- model.schema.register( 'div', {
- allowIn: [ 'blockQuote', 'div' ]
- } );
- editor.conversion.for( 'downcast' )
- .add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) )
- .add( downcastElementToElement( { model: 'inline', view: 'figure' } ) )
- .add( downcastElementToElement( { model: 'image', view: 'img' } ) )
- .add( downcastElementToElement( { model: 'blockQuote', view: 'blockquote' } ) )
- .add( downcastElementToElement( { model: 'div', view: 'div' } ) )
- .add( downcastElementToElement( {
- model: 'widget',
- view: ( modelItem, viewWriter ) => {
- const b = viewWriter.createAttributeElement( 'b' );
- const div = viewWriter.createContainerElement( 'div' );
- viewWriter.insert( viewWriter.createPositionAt( div, 0 ), b );
- return toWidget( div, viewWriter, { label: 'element label' } );
- }
- } ) )
- .add( downcastElementToElement( {
- model: 'nested',
- view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
- } ) )
- .add( downcastElementToElement( {
- model: 'editable',
- view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
- } ) );
- } );
- } );
- it( 'should be loaded', () => {
- expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
- } );
- it( 'should add MouseObserver', () => {
- expect( view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
- } );
- it( 'should create selection over clicked widget', () => {
- setModelData( model, '[]<widget></widget>' );
- const viewDiv = viewDocument.getRoot().getChild( 0 );
- const domEventDataMock = {
- target: viewDiv,
- preventDefault: sinon.spy()
- };
- viewDocument.fire( 'mousedown', domEventDataMock );
- expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
- sinon.assert.calledOnce( domEventDataMock.preventDefault );
- } );
- it( 'should create selection when clicked in nested element', () => {
- setModelData( model, '[]<widget></widget>' );
- const viewDiv = viewDocument.getRoot().getChild( 0 );
- const viewB = viewDiv.getChild( 0 );
- const domEventDataMock = {
- target: viewB,
- preventDefault: sinon.spy()
- };
- viewDocument.fire( 'mousedown', domEventDataMock );
- expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
- sinon.assert.calledOnce( domEventDataMock.preventDefault );
- } );
- it( 'should do nothing if clicked inside nested editable', () => {
- setModelData( model, '[]<widget><nested>foo bar</nested></widget>' );
- const viewDiv = viewDocument.getRoot().getChild( 0 );
- const viewFigcaption = viewDiv.getChild( 0 );
- const domEventDataMock = {
- target: viewFigcaption,
- preventDefault: sinon.spy()
- };
- viewDocument.fire( 'mousedown', domEventDataMock );
- sinon.assert.notCalled( domEventDataMock.preventDefault );
- } );
- it( 'should do nothing if clicked in non-widget element', () => {
- setModelData( model, '<paragraph>[]foo bar</paragraph><widget></widget>' );
- const viewP = viewDocument.getRoot().getChild( 0 );
- const domEventDataMock = {
- target: viewP,
- preventDefault: sinon.spy()
- };
- view.focus();
- viewDocument.fire( 'mousedown', domEventDataMock );
- expect( getModelData( model ) ).to.equal( '<paragraph>[]foo bar</paragraph><widget></widget>' );
- sinon.assert.notCalled( domEventDataMock.preventDefault );
- } );
- it( 'should not focus editable if already is focused', () => {
- setModelData( model, '<widget></widget>' );
- const widget = viewDocument.getRoot().getChild( 0 );
- const domEventDataMock = {
- target: widget,
- preventDefault: sinon.spy()
- };
- const focusSpy = sinon.spy( view, 'focus' );
- viewDocument.isFocused = true;
- viewDocument.fire( 'mousedown', domEventDataMock );
- sinon.assert.calledOnce( domEventDataMock.preventDefault );
- sinon.assert.notCalled( focusSpy );
- expect( getModelData( model ) ).to.equal( '[<widget></widget>]' );
- } );
- it( 'should apply fake view selection if model selection is on widget element', () => {
- setModelData( model, '[<widget>foo bar</widget>]' );
- expect( getViewData( view ) ).to.equal(
- '[<div class="ck-widget ck-widget_selected" contenteditable="false">foo bar<b></b></div>]'
- );
- expect( viewDocument.selection.isFake ).to.be.true;
- } );
- it( 'should use element\'s label to set fake selection if one is provided', () => {
- setModelData( model, '[<widget>foo bar</widget>]' );
- expect( viewDocument.selection.fakeSelectionLabel ).to.equal( 'element label' );
- } );
- it( 'should add selected class when no only a widget is selected', () => {
- setModelData( model, '[<paragraph>foo</paragraph><widget></widget><widget></widget>]' );
- expect( viewDocument.selection.isFake ).to.be.false;
- expect( getViewData( view ) ).to.equal(
- '[' +
- '<p>foo</p>' +
- '<div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div>' +
- '<div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div>' +
- ']'
- );
- } );
- it( 'fake selection should be empty if widget is not selected', () => {
- setModelData( model, '<paragraph>foo</paragraph><widget>foo bar</widget>' );
- expect( viewDocument.selection.fakeSelectionLabel ).to.equal( '' );
- } );
- it( 'should toggle selected class', () => {
- setModelData( model, '<paragraph>foo</paragraph>[<widget>foo</widget>]' );
- expect( getViewData( view ) ).to.equal(
- '<p>foo</p>[<div class="ck-widget ck-widget_selected" contenteditable="false">foo<b></b></div>]'
- );
- model.change( writer => {
- writer.setSelection( null );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo</p><div class="ck-widget" contenteditable="false">foo<b></b></div>'
- );
- } );
- it( 'should do nothing when selection is placed in other editable', () => {
- setModelData( model, '<widget><editable>foo bar</editable></widget><editable>[baz]</editable>' );
- expect( getViewData( view ) ).to.equal(
- '<div class="ck-widget" contenteditable="false">' +
- '<figcaption contenteditable="true">foo bar</figcaption>' +
- '<b></b>' +
- '</div>' +
- '<figcaption contenteditable="true">{baz}</figcaption>'
- );
- } );
- describe( 'keys handling', () => {
- describe( 'arrows', () => {
- test(
- 'should move selection forward from selected object - right arrow',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- keyCodes.arrowright,
- '<widget></widget><paragraph>[]foo</paragraph>'
- );
- test(
- 'should move selection forward from selected object - down arrow',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- keyCodes.arrowdown,
- '<widget></widget><paragraph>[]foo</paragraph>'
- );
- test(
- 'should move selection backward from selected object - left arrow',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- keyCodes.arrowleft,
- '<paragraph>foo[]</paragraph><widget></widget>'
- );
- test(
- 'should move selection backward from selected object - up arrow',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- keyCodes.arrowup,
- '<paragraph>foo[]</paragraph><widget></widget>'
- );
- test(
- 'should move selection to next widget - right arrow',
- '[<widget></widget>]<widget></widget>',
- keyCodes.arrowright,
- '<widget></widget>[<widget></widget>]'
- );
- test(
- 'should move selection to next widget - down arrow',
- '[<widget></widget>]<widget></widget>',
- keyCodes.arrowdown,
- '<widget></widget>[<widget></widget>]'
- );
- test(
- 'should move selection to previous widget - left arrow',
- '<widget></widget>[<widget></widget>]',
- keyCodes.arrowleft,
- '[<widget></widget>]<widget></widget>'
- );
- test(
- 'should move selection to previous widget - up arrow',
- '<widget></widget>[<widget></widget>]',
- keyCodes.arrowup,
- '[<widget></widget>]<widget></widget>'
- );
- test(
- 'should do nothing on non-collapsed selection next to object - right arrow',
- '<paragraph>ba[r]</paragraph><widget></widget>',
- keyCodes.arrowright,
- '<paragraph>ba[r]</paragraph><widget></widget>'
- );
- test(
- 'should do nothing on non-collapsed selection next to object - down arrow',
- '<paragraph>ba[r]</paragraph><widget></widget>',
- keyCodes.arrowdown,
- '<paragraph>ba[r]</paragraph><widget></widget>'
- );
- test(
- 'should do nothing on non-collapsed selection next to object - left arrow',
- '<widget></widget><paragraph>[b]ar</paragraph>',
- keyCodes.arrowleft,
- '<widget></widget><paragraph>[b]ar</paragraph>'
- );
- test(
- 'should do nothing on non-collapsed selection next to object - up arrow',
- '<widget></widget><paragraph>[b]ar</paragraph>',
- keyCodes.arrowup,
- '<widget></widget><paragraph>[b]ar</paragraph>'
- );
- test(
- 'should not move selection if there is no correct location - right arrow',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- keyCodes.arrowright,
- '<paragraph>foo</paragraph>[<widget></widget>]'
- );
- test(
- 'should not move selection if there is no correct location - down arrow',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- keyCodes.arrowdown,
- '<paragraph>foo</paragraph>[<widget></widget>]'
- );
- test(
- 'should not move selection if there is no correct location - left arrow',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- keyCodes.arrowleft,
- '[<widget></widget>]<paragraph>foo</paragraph>'
- );
- test(
- 'should not move selection if there is no correct location - up arrow',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- keyCodes.arrowup,
- '[<widget></widget>]<paragraph>foo</paragraph>'
- );
- test(
- 'should do nothing if other key is pressed',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- // Use a safe key (alt) to not trigger the Input features "unsafe keys" handler.
- 18,
- '[<widget></widget>]<paragraph>foo</paragraph>'
- );
- it( 'should prevent default behaviour when there is no correct location - document end', () => {
- const keydownHandler = sinon.spy();
- const domEventDataMock = {
- keyCode: keyCodes.arrowright,
- preventDefault: sinon.spy(),
- };
- setModelData( model, '<paragraph>foo</paragraph>[<widget></widget>]' );
- viewDocument.on( 'keydown', keydownHandler );
- viewDocument.fire( 'keydown', domEventDataMock );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo</paragraph>[<widget></widget>]' );
- sinon.assert.calledOnce( domEventDataMock.preventDefault );
- sinon.assert.notCalled( keydownHandler );
- } );
- it( 'should prevent default behaviour when there is no correct location - document start', () => {
- const keydownHandler = sinon.spy();
- const domEventDataMock = {
- keyCode: keyCodes.arrowleft,
- preventDefault: sinon.spy(),
- };
- setModelData( model, '[<widget></widget>]<paragraph>foo</paragraph>' );
- viewDocument.on( 'keydown', keydownHandler );
- viewDocument.fire( 'keydown', domEventDataMock );
- expect( getModelData( model ) ).to.equal( '[<widget></widget>]<paragraph>foo</paragraph>' );
- sinon.assert.calledOnce( domEventDataMock.preventDefault );
- sinon.assert.notCalled( keydownHandler );
- } );
- test(
- 'should move selection to object element - right arrow',
- '<paragraph>foo[]</paragraph><widget></widget>',
- keyCodes.arrowright,
- '<paragraph>foo</paragraph>[<widget></widget>]'
- );
- test(
- 'should move selection to object element - down arrow',
- '<paragraph>foo[]</paragraph><widget></widget>',
- keyCodes.arrowdown,
- '<paragraph>foo</paragraph>[<widget></widget>]'
- );
- test(
- 'should move selection to object element - left arrow',
- '<widget></widget><paragraph>[]foo</paragraph>',
- keyCodes.arrowleft,
- '[<widget></widget>]<paragraph>foo</paragraph>'
- );
- test(
- 'should move selection to object element - up arrow',
- '<widget></widget><paragraph>[]foo</paragraph>',
- keyCodes.arrowup,
- '[<widget></widget>]<paragraph>foo</paragraph>'
- );
- test(
- 'do nothing on non objects - right arrow',
- '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
- keyCodes.arrowright,
- '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
- );
- test(
- 'do nothing on non objects - down arrow',
- '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>',
- keyCodes.arrowdown,
- '<paragraph>foo[]</paragraph><paragraph>bar</paragraph>'
- );
- test(
- 'do nothing on non objects - left arrow',
- '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
- keyCodes.arrowleft,
- '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
- );
- test(
- 'do nothing on non objects - up arrow',
- '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
- keyCodes.arrowup,
- '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>'
- );
- test(
- 'should work correctly with modifier key: right arrow + ctrl',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- { keyCode: keyCodes.arrowright, ctrlKey: true },
- '<widget></widget><paragraph>[]foo</paragraph>'
- );
- test(
- 'should work correctly with modifier key: right arrow + alt',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- { keyCode: keyCodes.arrowright, altKey: true },
- '<widget></widget><paragraph>[]foo</paragraph>'
- );
- test(
- 'should work correctly with modifier key: right arrow + shift',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- { keyCode: keyCodes.arrowright, shiftKey: true },
- '<widget></widget><paragraph>[]foo</paragraph>'
- );
- test(
- 'should work correctly with modifier key: down arrow + ctrl',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- { keyCode: keyCodes.arrowdown, ctrlKey: true },
- '<widget></widget><paragraph>[]foo</paragraph>'
- );
- test(
- 'should work correctly with modifier key: down arrow + alt',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- { keyCode: keyCodes.arrowdown, altKey: true },
- '<widget></widget><paragraph>[]foo</paragraph>'
- );
- test(
- 'should work correctly with modifier key: down arrow + shift',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- { keyCode: keyCodes.arrowdown, shiftKey: true },
- '<widget></widget><paragraph>[]foo</paragraph>'
- );
- test(
- 'should work correctly with modifier key: left arrow + ctrl',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- { keyCode: keyCodes.arrowleft, ctrlKey: true },
- '<paragraph>foo[]</paragraph><widget></widget>'
- );
- test(
- 'should work correctly with modifier key: left arrow + alt',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- { keyCode: keyCodes.arrowleft, altKey: true },
- '<paragraph>foo[]</paragraph><widget></widget>'
- );
- test(
- 'should work correctly with modifier key: left arrow + shift',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- { keyCode: keyCodes.arrowleft, shiftKey: true },
- '<paragraph>foo[]</paragraph><widget></widget>'
- );
- test(
- 'should work correctly with modifier key: up arrow + ctrl',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- { keyCode: keyCodes.arrowup, ctrlKey: true },
- '<paragraph>foo[]</paragraph><widget></widget>'
- );
- test(
- 'should work correctly with modifier key: up arrow + alt',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- { keyCode: keyCodes.arrowup, altKey: true },
- '<paragraph>foo[]</paragraph><widget></widget>'
- );
- test(
- 'should work correctly with modifier key: up arrow + shift',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- { keyCode: keyCodes.arrowup, shiftKey: true },
- '<paragraph>foo[]</paragraph><widget></widget>'
- );
- test(
- 'should do nothing if there is more than one selection in model',
- '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>',
- keyCodes.arrowright,
- '<paragraph>[foo]</paragraph><widget></widget><paragraph>[bar]</paragraph>'
- );
- test(
- 'should work if selection is in nested element (left arrow)',
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph>[]</paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '<paragraph>foo</paragraph>',
- keyCodes.arrowleft,
- '<paragraph>foo</paragraph>' +
- '[<image></image>]' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph></paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- test(
- 'should work if selection is in nested element (up arrow)',
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph>[]</paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '<paragraph>foo</paragraph>',
- keyCodes.arrowup,
- '<paragraph>foo</paragraph>' +
- '[<image></image>]' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph></paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- test(
- 'should work if selection is in nested element (right arrow)',
- '<paragraph>foo</paragraph>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph>[]</paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '<image></image>' +
- '<paragraph>foo</paragraph>',
- keyCodes.arrowright,
- '<paragraph>foo</paragraph>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph></paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '[<image></image>]' +
- '<paragraph>foo</paragraph>'
- );
- test(
- 'should work if selection is in nested element (down arrow)',
- '<paragraph>foo</paragraph>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph>[]</paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '<image></image>' +
- '<paragraph>foo</paragraph>',
- keyCodes.arrowdown,
- '<paragraph>foo</paragraph>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph></paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '[<image></image>]' +
- '<paragraph>foo</paragraph>'
- );
- } );
- describe( 'Ctrl+A', () => {
- test(
- 'should select the entire content of the nested editable',
- '<widget><nested>foo[]</nested></widget><paragraph>bar</paragraph>',
- { keyCode: keyCodes.a, ctrlKey: true },
- '<widget><nested>[foo]</nested></widget><paragraph>bar</paragraph>'
- );
- test(
- 'should not change the selection if outside of the nested editable',
- '<widget><nested>foo</nested></widget><paragraph>[]bar</paragraph>',
- { keyCode: keyCodes.a, ctrlKey: true },
- '<widget><nested>foo</nested></widget><paragraph>[]bar</paragraph>'
- );
- test(
- 'should selected whole content when widget is selected',
- '<paragraph>foo</paragraph>[<widget></widget>]<paragraph>bar</paragraph>',
- { keyCode: keyCodes.a, ctrlKey: true },
- '<paragraph>[foo</paragraph><widget></widget><paragraph>bar]</paragraph>',
- '<p>{foo</p><div class="ck-widget ck-widget_selected" contenteditable="false"><b></b></div><p>bar}</p>'
- );
- } );
- describe( 'enter', () => {
- test(
- 'should insert a paragraph after the selected widget upon Enter',
- '[<widget></widget>]',
- keyCodes.enter,
- '<widget></widget><paragraph>[]</paragraph>'
- );
- test(
- 'should insert a paragraph before the selected widget upon Shift+Enter',
- '[<widget></widget>]',
- { keyCode: keyCodes.enter, shiftKey: true },
- '<paragraph>[]</paragraph><widget></widget>'
- );
- test(
- 'should insert a paragraph when not a first-child of the root',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- keyCodes.enter,
- '<widget></widget><paragraph>[]</paragraph><paragraph>foo</paragraph>'
- );
- test(
- 'should insert a paragraph when not a last-child of the root',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- { keyCode: keyCodes.enter, shiftKey: true },
- '<paragraph>foo</paragraph><paragraph>[]</paragraph><widget></widget>'
- );
- test(
- 'should insert a paragraph only when an entire widget is selected (#1)',
- '<widget><nested>[foo] bar</nested></widget>',
- keyCodes.enter,
- '<widget><nested>[] bar</nested></widget>'
- );
- test(
- 'should insert a paragraph only when an entire widget is selected (#2)',
- '<paragraph>f[oo</paragraph><widget></widget><paragraph>b]ar</paragraph>',
- keyCodes.enter,
- '<paragraph>f[]ar</paragraph>'
- );
- } );
- function test( name, data, keyCodeOrMock, expected, expectedView ) {
- it( name, () => {
- const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
- keyCode: keyCodeOrMock
- };
- setModelData( model, data );
- viewDocument.fire( 'keydown', new DomEventData(
- viewDocument,
- { target: document.createElement( 'div' ), preventDefault() {} },
- domEventDataMock
- ) );
- expect( getModelData( model ) ).to.equal( expected );
- if ( expectedView ) {
- expect( getViewData( view ) ).to.equal( expectedView );
- }
- } );
- }
- } );
- describe( 'delete integration', () => {
- function test( name, input, direction, expected ) {
- it( name, () => {
- setModelData( model, input );
- const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
- const domEventDataMock = {
- keyCode: direction == 'backward' ? keyCodes.backspace : keyCodes.delete,
- };
- viewDocument.fire( 'keydown', new DomEventData(
- viewDocument,
- { target: document.createElement( 'div' ), preventDefault() {} },
- domEventDataMock
- ) );
- expect( getModelData( model ) ).to.equal( expected );
- scrollStub.restore();
- } );
- }
- // Let's make this integration tests real which will help covering
- // cases like https://github.com/ckeditor/ckeditor5/issues/753.
- // Originally, this test file used the Delete feature only which was not "integrational" enough.
- it( 'tests are executed with the Typing feature', () => {
- expect( editor.plugins.get( 'Typing' ) ).to.not.be.undefined;
- } );
- test(
- 'should select widget when backspace is pressed',
- '<widget></widget><paragraph>[]foo</paragraph>',
- 'backward',
- '[<widget></widget>]<paragraph>foo</paragraph>'
- );
- test(
- 'should remove empty element after selecting widget when backspace is pressed',
- '<widget></widget><paragraph>[]</paragraph>',
- 'backward',
- '[<widget></widget>]'
- );
- test(
- 'should select widget when delete is pressed',
- '<paragraph>foo[]</paragraph><widget></widget>',
- 'forward',
- '<paragraph>foo</paragraph>[<widget></widget>]'
- );
- test(
- 'should remove empty element after selecting widget when delete is pressed',
- '<paragraph>[]</paragraph><widget></widget>',
- 'forward',
- '[<widget></widget>]'
- );
- test(
- 'should not select widget on non-collapsed selection',
- '<widget></widget><paragraph>[f]oo</paragraph>',
- 'backward',
- '<widget></widget><paragraph>[]oo</paragraph>'
- );
- test(
- 'should not affect non-object elements',
- '<paragraph>foo</paragraph><paragraph>[]bar</paragraph>',
- 'backward',
- '<paragraph>foo[]bar</paragraph>'
- );
- test(
- 'should not modify backward delete default behaviour in single paragraph boundaries',
- '<paragraph>[]foo</paragraph>',
- 'backward',
- '<paragraph>[]foo</paragraph>'
- );
- test(
- 'should not modify forward delete default behaviour in single paragraph boundaries',
- '<paragraph>foo[]</paragraph>',
- 'forward',
- '<paragraph>foo[]</paragraph>'
- );
- test(
- 'should delete selected widget with paragraph before - backward',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- 'backward',
- '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
- );
- test(
- 'should delete selected widget with paragraph before - forward',
- '<paragraph>foo</paragraph>[<widget></widget>]',
- 'forward',
- '<paragraph>foo</paragraph><paragraph>[]</paragraph>'
- );
- test(
- 'should delete selected widget with paragraph after - backward',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- 'backward',
- '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
- );
- test(
- 'should delete selected widget with paragraph after - forward',
- '[<widget></widget>]<paragraph>foo</paragraph>',
- 'forward',
- '<paragraph>[]</paragraph><paragraph>foo</paragraph>'
- );
- test(
- 'should delete selected widget between paragraphs - backward',
- '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
- 'backward',
- '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
- );
- test(
- 'should delete selected widget between paragraphs - forward',
- '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>',
- 'forward',
- '<paragraph>bar</paragraph><paragraph>[]</paragraph><paragraph>foo</paragraph>'
- );
- test(
- 'should delete selected widget preceded by another widget - backward',
- '<widget></widget>[<widget></widget>]',
- 'backward',
- '<widget></widget><paragraph>[]</paragraph>'
- );
- test(
- 'should delete selected widget preceded by another widget - forward',
- '<widget></widget>[<widget></widget>]',
- 'forward',
- '<widget></widget><paragraph>[]</paragraph>'
- );
- test(
- 'should delete selected widget before another widget - forward',
- '[<widget></widget>]<widget></widget>',
- 'forward',
- '<paragraph>[]</paragraph><widget></widget>'
- );
- test(
- 'should delete selected widget before another widget - backward',
- '[<widget></widget>]<widget></widget>',
- 'backward',
- '<paragraph>[]</paragraph><widget></widget>'
- );
- test(
- 'should delete selected widget between other widgets - forward',
- '<widget></widget>[<widget></widget>]<widget></widget>',
- 'forward',
- '<widget></widget><paragraph>[]</paragraph><widget></widget>'
- );
- test(
- 'should delete selected widget between other widgets - backward',
- '<widget></widget>[<widget></widget>]<widget></widget>',
- 'backward',
- '<widget></widget><paragraph>[]</paragraph><widget></widget>'
- );
- test(
- 'should select inline objects - backward',
- '<paragraph>foo<inline></inline>[]bar</paragraph>',
- 'backward',
- '<paragraph>foo[<inline></inline>]bar</paragraph>'
- );
- test(
- 'should select inline objects - forward',
- '<paragraph>foo[]<inline></inline>bar</paragraph>',
- 'forward',
- '<paragraph>foo[<inline></inline>]bar</paragraph>'
- );
- test(
- 'should delete selected inline objects - backward',
- '<paragraph>foo[<inline></inline>]bar</paragraph>',
- 'backward',
- '<paragraph>foo[]bar</paragraph>'
- );
- test(
- 'should delete selected inline objects - forward',
- '<paragraph>foo[<inline></inline>]bar</paragraph>',
- 'forward',
- '<paragraph>foo[]bar</paragraph>'
- );
- test(
- 'should use standard delete behaviour when after first letter - backward',
- '<paragraph>a[]</paragraph>',
- 'backward',
- '<paragraph>[]</paragraph>'
- );
- test(
- 'should use standard delete behaviour when before first letter - forward',
- '<paragraph>[]a</paragraph>',
- 'forward',
- '<paragraph>[]</paragraph>'
- );
- it( 'should prevent default behaviour and stop event propagation', () => {
- setModelData( model, '<paragraph>foo[]</paragraph><widget></widget>' );
- const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
- const deleteSpy = sinon.spy();
- viewDocument.on( 'delete', deleteSpy );
- const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
- viewDocument.fire( 'delete', new DomEventData(
- viewDocument,
- domEventDataMock,
- { direction: 'forward', unit: 'character', sequence: 0 }
- ) );
- sinon.assert.calledOnce( domEventDataMock.preventDefault );
- sinon.assert.notCalled( deleteSpy );
- scrollStub.restore();
- } );
- test(
- 'should remove the entire empty element if it is next to a widget',
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
- '<paragraph>foo</paragraph>',
- 'backward',
- '<paragraph>foo</paragraph>[<image></image>]<paragraph>foo</paragraph>'
- );
- test(
- 'should remove the entire empty element (deeper structure) if it is next to a widget',
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
- '<paragraph>foo</paragraph>',
- 'backward',
- '<paragraph>foo</paragraph>' +
- '[<image></image>]' +
- '<paragraph>foo</paragraph>'
- );
- test(
- 'should remove the entire empty element (deeper structure) if it is next to a widget (forward delete)',
- '<paragraph>foo</paragraph>' +
- '<blockQuote><div><div><paragraph>[]</paragraph></div></div></blockQuote>' +
- '<image></image>' +
- '<paragraph>foo</paragraph>',
- 'forward',
- '<paragraph>foo</paragraph>' +
- '[<image></image>]' +
- '<paragraph>foo</paragraph>'
- );
- test(
- 'should not remove the entire element which is not empty and the element is next to a widget',
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote><paragraph>[]</paragraph><paragraph></paragraph></blockQuote>' +
- '<paragraph>foo</paragraph>',
- 'backward',
- '<paragraph>foo</paragraph>' +
- '[<image></image>]' +
- '<blockQuote><paragraph></paragraph></blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- test(
- 'should not remove the entire element which is not empty and the element is next to a widget (forward delete)',
- '<paragraph>foo</paragraph>' +
- '<blockQuote><paragraph>Foo</paragraph><paragraph>[]</paragraph></blockQuote>' +
- '<image></image>' +
- '<paragraph>foo</paragraph>',
- 'forward',
- '<paragraph>foo</paragraph>' +
- '<blockQuote><paragraph>Foo</paragraph></blockQuote>' +
- '[<image></image>]' +
- '<paragraph>foo</paragraph>'
- );
- test(
- 'should not remove the entire element (deeper structure) which is not empty and the element is next to a widget',
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph>[]</paragraph>' +
- '</div>' +
- '</div>' +
- '<paragraph></paragraph>' +
- '</blockQuote>' +
- '<paragraph>foo</paragraph>',
- 'backward',
- '<paragraph>foo</paragraph>' +
- '[<image></image>]' +
- '<blockQuote>' +
- '<paragraph></paragraph>' +
- '</blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- test(
- 'should do nothing if the nested element is not empty and the element is next to a widget',
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph>Foo[]</paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '<paragraph>foo</paragraph>',
- 'backward',
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote>' +
- '<div>' +
- '<div>' +
- '<paragraph>Fo[]</paragraph>' +
- '</div>' +
- '</div>' +
- '</blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- it( 'does nothing when editor when read only mode is enabled (delete)', () => {
- const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
- setModelData( model,
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- editor.isReadOnly = true;
- const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
- viewDocument.fire( 'delete', new DomEventData(
- viewDocument,
- domEventDataMock,
- { direction: 'backward', unit: 'character', sequence: 0 }
- ) );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- scrollStub.restore();
- } );
- it( 'does nothing when editor when read only mode is enabled (forward delete)', () => {
- const scrollStub = sinon.stub( view, 'scrollToTheSelection' );
- setModelData( model,
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- editor.isReadOnly = true;
- const domEventDataMock = { target: document.createElement( 'div' ), preventDefault: sinon.spy() };
- viewDocument.fire( 'delete', new DomEventData(
- viewDocument,
- domEventDataMock,
- { direction: 'forward', unit: 'character', sequence: 0 }
- ) );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>foo</paragraph>' +
- '<image></image>' +
- '<blockQuote><paragraph>[]</paragraph></blockQuote>' +
- '<paragraph>foo</paragraph>'
- );
- scrollStub.restore();
- } );
- } );
- describe( 'selection handler', () => {
- beforeEach( () => {
- return VirtualTestEditor.create( { plugins: [ Widget, Typing ] } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- view = editor.editing.view;
- viewDocument = view.document;
- model.schema.register( 'widget', {
- inheritAllFrom: '$block',
- allowIn: 'widget',
- isObject: true
- } );
- model.schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- model.schema.register( 'nested', {
- allowIn: 'widget',
- isLimit: true
- } );
- model.schema.extend( '$text', {
- allowIn: 'nested'
- } );
- editor.conversion.for( 'downcast' )
- .add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) )
- .add( downcastElementToElement( {
- model: 'widget',
- view: ( modelItem, viewWriter ) => {
- const widget = viewWriter.createContainerElement( 'div' );
- return toWidget( widget, viewWriter, { hasSelectionHandler: true } );
- }
- } ) )
- .add( downcastElementToElement( {
- model: 'nested',
- view: ( modelItem, viewWriter ) => viewWriter.createEditableElement( 'figcaption', { contenteditable: true } )
- } ) );
- } );
- } );
- it( 'should select a widget on mouse click', () => {
- setModelData( model, '<paragraph>bar</paragraph><widget></widget><paragraph>foo[]</paragraph>' );
- const viewWidgetSelectionHandler = viewDocument.getRoot().getChild( 1 ).getChild( 0 );
- const domEventDataMock = {
- target: viewWidgetSelectionHandler,
- preventDefault: sinon.spy()
- };
- viewDocument.fire( 'mousedown', domEventDataMock );
- expect( getModelData( model ) ).to.equal( '<paragraph>bar</paragraph>[<widget></widget>]<paragraph>foo</paragraph>' );
- } );
- it( 'should select the most top-outer widget if widgets are nested', () => {
- setModelData( model, '<widget><widget></widget><widget></widget></widget>' );
- // The top-outer widget.
- const viewWidgetSelectionHandler = viewDocument.getRoot().getChild( 0 );
- const domEventDataMock = {
- target: viewWidgetSelectionHandler,
- preventDefault: sinon.spy()
- };
- viewDocument.fire( 'mousedown', domEventDataMock );
- expect( getViewData( view ) ).to.equal(
- '[<div class="ck-widget ck-widget_selectable ck-widget_selected" contenteditable="false">' +
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>' +
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>]'
- );
- } );
- it( 'should select a proper widget if they are nested and multiplied', () => {
- setModelData( model,
- '<widget></widget>' +
- '<widget>' +
- '<widget></widget>' +
- '<widget></widget>' +
- '</widget>' +
- '<widget></widget>'
- );
- const viewWidgetSelectionHandler = viewDocument.getRoot().getChild( 1 );
- const domEventDataMock = {
- target: viewWidgetSelectionHandler,
- preventDefault: sinon.spy()
- };
- viewDocument.fire( 'mousedown', domEventDataMock );
- expect( getViewData( view ) ).to.equal(
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>' +
- '[<div class="ck-widget ck-widget_selectable ck-widget_selected" contenteditable="false">' +
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>' +
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>]' +
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>'
- );
- } );
- it( 'works fine with a widget that contains more children', () => {
- setModelData( model,
- '<widget>' +
- '<nested>foo bar</nested>' +
- '<widget></widget>' +
- '</widget>'
- );
- const viewWidgetSelectionHandler = viewDocument.getRoot().getChild( 0 );
- const domEventDataMock = {
- target: viewWidgetSelectionHandler,
- preventDefault: sinon.spy()
- };
- viewDocument.fire( 'mousedown', domEventDataMock );
- expect( getViewData( view ) ).to.equal(
- '[<div class="ck-widget ck-widget_selectable ck-widget_selected" contenteditable="false">' +
- '<figcaption contenteditable="true">foo bar</figcaption>' +
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>]'
- );
- } );
- it( 'should select a proper widget for more complex structures', () => {
- setModelData( model,
- '<widget>' +
- '<widget></widget>' +
- '<widget>' +
- '<widget></widget>' +
- '</widget>' +
- '</widget>'
- );
- const viewWidgetSelectionHandler = viewDocument.getRoot().getChild( 0 ).getChild( 1 );
- const domEventDataMock = {
- target: viewWidgetSelectionHandler,
- preventDefault: sinon.spy()
- };
- viewDocument.fire( 'mousedown', domEventDataMock );
- expect( getViewData( view ) ).to.equal(
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>' +
- '[<div class="ck-widget ck-widget_selectable ck-widget_selected" contenteditable="false">' +
- '<div class="ck-widget ck-widget_selectable" contenteditable="false">' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>]' +
- '<div class="ck ck-widget__selection-handler"></div>' +
- '</div>'
- );
- } );
- } );
- } );
|