| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- import LinkEditing from '../src/linkediting';
- import LinkCommand from '../src/linkcommand';
- import UnlinkCommand from '../src/unlinkcommand';
- import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import Enter from '@ckeditor/ckeditor5-enter/src/enter';
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import { isLinkElement } from '../src/utils';
- import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import Typing from '@ckeditor/ckeditor5-typing/src/typing';
- import BoldEditing from '@ckeditor/ckeditor5-basic-styles/src/bold/boldediting';
- /* global document */
- describe( 'LinkEditing', () => {
- let element, editor, model, view;
- beforeEach( async () => {
- element = document.createElement( 'div' );
- document.body.appendChild( element );
- editor = await ClassicTestEditor.create( element, {
- plugins: [ Paragraph, LinkEditing, Enter ],
- link: {
- decorators: {
- isExternal: {
- mode: 'manual',
- label: 'Open in a new window',
- attributes: {
- target: '_blank',
- rel: 'noopener noreferrer'
- }
- }
- }
- }
- } );
- editor.model.schema.extend( '$text', { allowAttributes: 'bold' } );
- editor.conversion.attributeToElement( {
- model: 'bold',
- view: 'b'
- } );
- model = editor.model;
- view = editor.editing.view;
- } );
- afterEach( async () => {
- element.remove();
- await editor.destroy();
- } );
- it( 'should have pluginName', () => {
- expect( LinkEditing.pluginName ).to.equal( 'LinkEditing' );
- } );
- it( 'should be loaded', () => {
- expect( editor.plugins.get( LinkEditing ) ).to.be.instanceOf( LinkEditing );
- } );
- it( 'should set proper schema rules', () => {
- expect( model.schema.checkAttribute( [ '$block', '$text' ], 'linkHref' ) ).to.be.true;
- expect( model.schema.checkAttribute( [ '$clipboardHolder', '$text' ], 'linkHref' ) ).to.be.true;
- expect( model.schema.checkAttribute( [ '$block' ], 'linkHref' ) ).to.be.false;
- } );
- // Let's check only the minimum to not duplicate `TwoStepCaretMovement` tests.
- // Testing minimum is better than testing using spies that might give false positive results.
- describe( 'two-step caret movement', () => {
- it( 'should be bound to the `linkHref` attribute (LTR)', () => {
- const selection = editor.model.document.selection;
- // Put selection before the link element.
- setModelData( editor.model, '<paragraph>foo[]<$text linkHref="url">b</$text>ar</paragraph>' );
- // The selection's gravity should read attributes from the left.
- expect( selection.hasAttribute( 'linkHref' ), 'hasAttribute( \'linkHref\' )' ).to.be.false;
- // So let's simulate the `keydown` event.
- editor.editing.view.document.fire( 'keydown', {
- keyCode: keyCodes.arrowright,
- preventDefault: () => {},
- domTarget: document.body
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo<$text linkHref="url">[]b</$text>ar</paragraph>' );
- // Selection should get the attributes from the right.
- expect( selection.hasAttribute( 'linkHref' ), 'hasAttribute( \'linkHref\' )' ).to.be.true;
- expect( selection.getAttribute( 'linkHref' ), 'linkHref attribute' ).to.equal( 'url' );
- } );
- it( 'should be bound to the `linkHref` attribute (RTL)', async () => {
- const editor = await ClassicTestEditor.create( element, {
- plugins: [ Paragraph, LinkEditing, Enter ],
- language: {
- content: 'ar'
- }
- } );
- model = editor.model;
- view = editor.editing.view;
- const selection = editor.model.document.selection;
- // Put selection before the link element.
- setModelData( editor.model, '<paragraph>foo[]<$text linkHref="url">b</$text>ar</paragraph>' );
- // The selection's gravity should read attributes from the left.
- expect( selection.hasAttribute( 'linkHref' ), 'hasAttribute( \'linkHref\' )' ).to.be.false;
- // So let's simulate the `keydown` event.
- editor.editing.view.document.fire( 'keydown', {
- keyCode: keyCodes.arrowleft,
- preventDefault: () => {},
- domTarget: document.body
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo<$text linkHref="url">[]b</$text>ar</paragraph>' );
- // Selection should get the attributes from the right.
- expect( selection.hasAttribute( 'linkHref' ), 'hasAttribute( \'linkHref\' )' ).to.be.true;
- expect( selection.getAttribute( 'linkHref' ), 'linkHref attribute' ).to.equal( 'url' );
- await editor.destroy();
- } );
- } );
- // https://github.com/ckeditor/ckeditor5/issues/6053
- describe( 'selection attribute management on paste', () => {
- it( 'should remove link atttributes when pasting a link', () => {
- setModelData( model, '<paragraph>foo[]</paragraph>' );
- model.change( writer => {
- model.insertContent( writer.createText( 'INSERTED', { linkHref: 'ckeditor.com' } ) );
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo<$text linkHref="ckeditor.com">INSERTED</$text>[]</paragraph>' );
- expect( [ ...model.document.selection.getAttributeKeys() ] ).to.be.empty;
- } );
- it( 'should remove all atttributes starting with "link" (e.g. decorator attributes) when pasting a link', () => {
- setModelData( model, '<paragraph>foo[]</paragraph>' );
- model.change( writer => {
- model.insertContent( writer.createText( 'INSERTED', { linkHref: 'ckeditor.com', linkIsExternal: true } ) );
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>' +
- 'foo<$text linkHref="ckeditor.com" linkIsExternal="true">INSERTED</$text>[]' +
- '</paragraph>'
- );
- expect( [ ...model.document.selection.getAttributeKeys() ] ).to.be.empty;
- } );
- it( 'should not remove link atttributes when pasting a non-link content', () => {
- setModelData( model, '<paragraph><$text linkHref="ckeditor.com">foo[]</$text></paragraph>' );
- model.change( writer => {
- model.insertContent( writer.createText( 'INSERTED', { bold: 'true' } ) );
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>' +
- '<$text linkHref="ckeditor.com">foo</$text>' +
- '<$text bold="true">INSERTED[]</$text>' +
- '</paragraph>'
- );
- expect( [ ...model.document.selection.getAttributeKeys() ] ).to.have.members( [ 'bold' ] );
- } );
- it( 'should not remove link atttributes when pasting in the middle of a link with the same URL', () => {
- setModelData( model, '<paragraph><$text linkHref="ckeditor.com">fo[]o</$text></paragraph>' );
- model.change( writer => {
- model.insertContent( writer.createText( 'INSERTED', { linkHref: 'ckeditor.com' } ) );
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph><$text linkHref="ckeditor.com">foINSERTED[]o</$text></paragraph>' );
- expect( [ ...model.document.selection.getAttributeKeys() ] ).to.have.members( [ 'linkHref' ] );
- } );
- it( 'should not remove link atttributes from the selection when pasting before a link when the gravity is overridden', () => {
- setModelData( model, '<paragraph>foo[]<$text linkHref="ckeditor.com">bar</$text></paragraph>' );
- view.document.fire( 'keydown', {
- keyCode: keyCodes.arrowright,
- preventDefault: () => {},
- domTarget: document.body
- } );
- expect( model.document.selection.isGravityOverridden ).to.be.true;
- model.change( writer => {
- model.insertContent( writer.createText( 'INSERTED', { bold: true } ) );
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>' +
- 'foo' +
- '<$text bold="true">INSERTED</$text>' +
- '<$text linkHref="ckeditor.com">[]bar</$text>' +
- '</paragraph>'
- );
- expect( model.document.selection.isGravityOverridden ).to.be.true;
- expect( [ ...model.document.selection.getAttributeKeys() ] ).to.have.members( [ 'linkHref' ] );
- } );
- it( 'should not remove link atttributes when pasting a link into another link (different URLs, no merge)', () => {
- setModelData( model, '<paragraph><$text linkHref="ckeditor.com">f[]oo</$text></paragraph>' );
- model.change( writer => {
- model.insertContent( writer.createText( 'INSERTED', { linkHref: 'http://INSERTED' } ) );
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>' +
- '<$text linkHref="ckeditor.com">f</$text>' +
- '<$text linkHref="http://INSERTED">INSERTED[]</$text>' +
- '<$text linkHref="ckeditor.com">oo</$text>' +
- '</paragraph>'
- );
- expect( [ ...model.document.selection.getAttributeKeys() ] ).to.have.members( [ 'linkHref' ] );
- } );
- it( 'should not remove link atttributes when pasting before another link (different URLs, no merge)', () => {
- setModelData( model, '<paragraph>[]<$text linkHref="ckeditor.com">foo</$text></paragraph>' );
- expect( model.document.selection.isGravityOverridden ).to.be.false;
- model.change( writer => {
- model.insertContent( writer.createText( 'INSERTED', { linkHref: 'http://INSERTED' } ) );
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>' +
- '<$text linkHref="http://INSERTED">INSERTED[]</$text>' +
- '<$text linkHref="ckeditor.com">foo</$text>' +
- '</paragraph>'
- );
- expect( [ ...model.document.selection.getAttributeKeys() ] ).to.have.members( [ 'linkHref' ] );
- expect( model.document.selection.getAttribute( 'linkHref' ) ).to.equal( 'http://INSERTED' );
- } );
- } );
- describe( 'command', () => {
- it( 'should register link command', () => {
- const command = editor.commands.get( 'link' );
- expect( command ).to.be.instanceOf( LinkCommand );
- } );
- it( 'should register unlink command', () => {
- const command = editor.commands.get( 'unlink' );
- expect( command ).to.be.instanceOf( UnlinkCommand );
- } );
- } );
- describe( 'data pipeline conversions', () => {
- it( 'should convert `<a href="url">` to `linkHref="url"` attribute', () => {
- editor.setData( '<p><a href="url">foo</a>bar</p>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<paragraph><$text linkHref="url">foo</$text>bar</paragraph>' );
- expect( editor.getData() ).to.equal( '<p><a href="url">foo</a>bar</p>' );
- } );
- it( 'should be integrated with autoparagraphing', () => {
- editor.setData( '<a href="url">foo</a>bar' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<paragraph><$text linkHref="url">foo</$text>bar</paragraph>' );
- expect( editor.getData() ).to.equal( '<p><a href="url">foo</a>bar</p>' );
- } );
- // https://github.com/ckeditor/ckeditor5/issues/500
- it( 'should not pick up `<a name="foo">`', () => {
- editor.setData( '<p><a name="foo">foo</a>bar</p>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<paragraph>foobar</paragraph>' );
- } );
- // CKEditor 4 does. And CKEditor 5's balloon allows creating such links.
- it( 'should pick up `<a href="">`', () => {
- editor.setData( '<p><a href="">foo</a>bar</p>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<paragraph><$text linkHref="">foo</$text>bar</paragraph>' );
- expect( editor.getData() ).to.equal( '<p><a href="">foo</a>bar</p>' );
- } );
- // The editor's role is not to filter out potentially malicious data.
- // Its job is to not let this code be executed inside the editor (see the test in "editing pipeline conversion").
- it( 'should output a link with a potential XSS code', () => {
- setModelData( model, '<paragraph>[]</paragraph>' );
- model.change( writer => {
- writer.insertText( 'foo', { linkHref: 'javascript:alert(1)' }, model.document.selection.getFirstPosition() );
- } );
- expect( editor.getData() ).to.equal( '<p><a href="javascript:alert(1)">foo</a></p>' );
- } );
- it( 'should load a link with a potential XSS code', () => {
- editor.setData( '<p><a href="javascript:alert(1)">foo</a></p>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<paragraph><$text linkHref="javascript:alert(1)">foo</$text></paragraph>' );
- } );
- } );
- describe( 'editing pipeline conversion', () => {
- it( 'should convert attribute', () => {
- setModelData( model, '<paragraph><$text linkHref="url">foo</$text>bar</paragraph>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal( '<p><a href="url">foo</a>bar</p>' );
- } );
- it( 'should convert to link element instance', () => {
- setModelData( model, '<paragraph><$text linkHref="url">foo</$text>bar</paragraph>' );
- const element = editor.editing.view.document.getRoot().getChild( 0 ).getChild( 0 );
- expect( isLinkElement( element ) ).to.be.true;
- } );
- // https://github.com/ckeditor/ckeditor5-link/issues/121
- it( 'should should set priority for `linkHref` higher than all other attribute elements', () => {
- model.schema.extend( '$text', { allowAttributes: 'foo' } );
- editor.conversion.for( 'downcast' ).attributeToElement( { model: 'foo', view: 'f' } );
- setModelData( model,
- '<paragraph>' +
- '<$text linkHref="url">a</$text><$text foo="true" linkHref="url">b</$text><$text linkHref="url">c</$text>' +
- '</paragraph>' );
- expect( editor.getData() ).to.equal( '<p><a href="url">a<f>b</f>c</a></p>' );
- } );
- it( 'must not render a link with a potential XSS code', () => {
- setModelData( model, '<paragraph><$text linkHref="javascript:alert(1)">[]foo</$text>bar[]</paragraph>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true } ) )
- .to.equal( '<p><a href="#">foo</a>bar</p>' );
- } );
- } );
- describe( 'link highlighting', () => {
- it( 'should convert the highlight to a proper view classes', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">b{}ar</$text> baz</paragraph>'
- );
- expect( model.document.selection.hasAttribute( 'linkHref' ) ).to.be.true;
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">b{}ar</a> baz</p>'
- );
- } );
- it( 'should work whenever selection has linkHref attribute - link start', () => {
- setModelData( model,
- '<paragraph>foo {}<$text linkHref="url">bar</$text> baz</paragraph>'
- );
- expect( model.document.selection.hasAttribute( 'linkHref' ) ).to.be.false;
- model.change( writer => {
- writer.setSelectionAttribute( 'linkHref', 'url' );
- } );
- expect( model.document.selection.hasAttribute( 'linkHref' ) ).to.be.true;
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">{}bar</a> baz</p>'
- );
- } );
- it( 'should work whenever selection has linkHref attribute - link end', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">bar</$text>{} baz</paragraph>'
- );
- expect( model.document.selection.hasAttribute( 'linkHref' ) ).to.be.true;
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">bar{}</a> baz</p>'
- );
- } );
- it( 'should render highlight correctly after splitting the link', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">li{}nk</$text> baz</paragraph>'
- );
- editor.execute( 'enter' );
- expect( getModelData( model ) ).to.equal(
- '<paragraph>foo <$text linkHref="url">li</$text></paragraph>' +
- '<paragraph><$text linkHref="url">[]nk</$text> baz</paragraph>'
- );
- expect( model.document.selection.hasAttribute( 'linkHref' ) ).to.be.true;
- } );
- it( 'should remove classes when selection is moved out from the link', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">li{}nk</$text> baz</paragraph>'
- );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">li{}nk</a> baz</p>'
- );
- model.change( writer => writer.setSelection( model.document.getRoot().getChild( 0 ), 0 ) );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo <a href="url">link</a> baz</p>'
- );
- } );
- it( 'should work correctly when selection is moved inside link', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">li{}nk</$text> baz</paragraph>'
- );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">li{}nk</a> baz</p>'
- );
- model.change( writer => writer.setSelection( model.document.getRoot().getChild( 0 ), 5 ) );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">l{}ink</a> baz</p>'
- );
- } );
- describe( 'downcast conversion integration', () => {
- it( 'works for the #insert event', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">li{}nk</$text> baz</paragraph>'
- );
- model.change( writer => {
- writer.insertText( 'FOO', { linkHref: 'url' }, model.document.selection.getFirstPosition() );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">liFOO{}nk</a> baz</p>'
- );
- } );
- it( 'works for the #remove event', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">li{}nk</$text> baz</paragraph>'
- );
- model.change( writer => {
- writer.remove( writer.createRange(
- writer.createPositionAt( model.document.getRoot().getChild( 0 ), 0 ),
- writer.createPositionAt( model.document.getRoot().getChild( 0 ), 5 )
- ) );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p><a class="ck-link_selected" href="url">i{}nk</a> baz</p>'
- );
- } );
- it( 'works for the #attribute event', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">li{}nk</$text> baz</paragraph>'
- );
- model.change( writer => {
- writer.setAttribute( 'linkHref', 'new-url', writer.createRange(
- model.document.selection.getFirstPosition().getShiftedBy( -1 ),
- model.document.selection.getFirstPosition().getShiftedBy( 1 ) )
- );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a href="url">l</a><a class="ck-link_selected" href="new-url">i{}n</a><a href="url">k</a> baz</p>'
- );
- } );
- it( 'works for the #selection event', () => {
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">li{}nk</$text> baz</paragraph>'
- );
- model.change( writer => {
- writer.setSelection( writer.createRange(
- model.document.selection.getFirstPosition().getShiftedBy( -1 ),
- model.document.selection.getFirstPosition().getShiftedBy( 1 ) )
- );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">l{in}k</a> baz</p>'
- );
- } );
- it( 'works for the addMarker and removeMarker events', () => {
- editor.conversion.for( 'editingDowncast' ).markerToHighlight( { model: 'fooMarker', view: {} } );
- setModelData( model,
- '<paragraph>foo <$text linkHref="url">li{}nk</$text> baz</paragraph>'
- );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionAt( model.document.getRoot().getChild( 0 ), 0 ),
- writer.createPositionAt( model.document.getRoot().getChild( 0 ), 5 )
- );
- writer.addMarker( 'fooMarker', { range, usingOperation: true } );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p><span>foo </span><a class="ck-link_selected" href="url"><span>l</span>i{}nk</a> baz</p>'
- );
- model.change( writer => writer.removeMarker( 'fooMarker' ) );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <a class="ck-link_selected" href="url">li{}nk</a> baz</p>'
- );
- } );
- } );
- } );
- describe( 'link attributes decorator', () => {
- describe( 'default behavior', () => {
- const testLinks = [
- {
- external: true,
- url: 'http://example.com'
- }, {
- external: true,
- url: 'https://cksource.com'
- }, {
- external: false,
- url: 'ftp://server.io'
- }, {
- external: true,
- url: '//schemaless.org'
- }, {
- external: false,
- url: 'www.ckeditor.com'
- }, {
- external: false,
- url: '/relative/url.html'
- }, {
- external: false,
- url: 'another/relative/url.html'
- }, {
- external: false,
- url: '#anchor'
- }, {
- external: false,
- url: 'mailto:some@user.org'
- }, {
- external: false,
- url: 'tel:123456789'
- }
- ];
- it( 'link.addTargetToExternalLinks is predefined as false value', () => {
- expect( editor.config.get( 'link.addTargetToExternalLinks' ) ).to.be.false;
- } );
- describe( 'for link.addTargetToExternalLinks = false', () => {
- let editor, model;
- beforeEach( async () => {
- editor = await ClassicTestEditor.create( element, {
- plugins: [ Paragraph, LinkEditing, Enter ],
- link: {
- addTargetToExternalLinks: true
- }
- } );
- model = editor.model;
- view = editor.editing.view;
- } );
- afterEach( async () => {
- await editor.destroy();
- } );
- it( 'link.addTargetToExternalLinks is set as true value', () => {
- expect( editor.config.get( 'link.addTargetToExternalLinks' ) ).to.be.true;
- } );
- testLinks.forEach( link => {
- it( `link: ${ link.url } should be treat as ${ link.external ? 'external' : 'non-external' } link`, () => {
- editor.setData( `<p><a href="${ link.url }">foo</a>bar</p>` );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( `<paragraph><$text linkHref="${ link.url }">foo</$text>bar</paragraph>` );
- if ( link.external ) {
- expect( editor.getData() )
- .to.equal( `<p><a target="_blank" rel="noopener noreferrer" href="${ link.url }">foo</a>bar</p>` );
- } else {
- expect( editor.getData() ).to.equal( `<p><a href="${ link.url }">foo</a>bar</p>` );
- }
- } );
- } );
- } );
- testLinks.forEach( link => {
- it( `link: ${ link.url } should not get 'target' and 'rel' attributes`, () => {
- editor.setData( `<p><a href="${ link.url }">foo</a>bar</p>` );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( `<paragraph><$text linkHref="${ link.url }">foo</$text>bar</paragraph>` );
- expect( editor.getData() ).to.equal( `<p><a href="${ link.url }">foo</a>bar</p>` );
- } );
- } );
- } );
- describe( 'custom config', () => {
- describe( 'mode: automatic', () => {
- const testLinks = [
- {
- url: 'relative/url.html',
- attributes: {}
- }, {
- url: 'http://exmaple.com',
- attributes: {
- target: '_blank'
- }
- }, {
- url: 'https://example.com/download/link.pdf',
- attributes: {
- target: '_blank',
- download: 'download'
- }
- }, {
- url: 'mailto:some@person.io',
- attributes: {
- class: 'mail-url'
- }
- }
- ];
- beforeEach( async () => {
- await editor.destroy();
- editor = await ClassicTestEditor.create( element, {
- plugins: [ Paragraph, LinkEditing, Enter ],
- link: {
- addTargetToExternalLinks: false,
- decorators: {
- isExternal: {
- mode: 'automatic',
- callback: url => url.startsWith( 'http' ),
- attributes: {
- target: '_blank'
- }
- },
- isDownloadable: {
- mode: 'automatic',
- callback: url => url.includes( 'download' ),
- attributes: {
- download: 'download'
- }
- },
- isMail: {
- mode: 'automatic',
- callback: url => url.startsWith( 'mailto:' ),
- attributes: {
- class: 'mail-url'
- }
- }
- }
- }
- } );
- model = editor.model;
- view = editor.editing.view;
- } );
- testLinks.forEach( link => {
- it( `Link: ${ link.url } should get attributes: ${ JSON.stringify( link.attributes ) }`, () => {
- const ORDER = [ 'target', 'download', 'class' ];
- const attr = Object.entries( link.attributes ).sort( ( a, b ) => {
- const aIndex = ORDER.indexOf( a[ 0 ] );
- const bIndex = ORDER.indexOf( b[ 0 ] );
- return aIndex - bIndex;
- } );
- const reducedAttr = attr.reduce( ( acc, cur ) => {
- return acc + `${ cur[ 0 ] }="${ cur[ 1 ] }" `;
- }, '' );
- editor.setData( `<p><a href="${ link.url }">foo</a>bar</p>` );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( `<paragraph><$text linkHref="${ link.url }">foo</$text>bar</paragraph>` );
- // Order of attributes is important, that's why this is assert is construct in such way.
- expect( editor.getData() ).to.equal( `<p><a ${ reducedAttr }href="${ link.url }">foo</a>bar</p>` );
- } );
- } );
- } );
- } );
- describe( 'custom linkHref converter', () => {
- beforeEach( async () => {
- class CustomLinks extends Plugin {
- init() {
- const editor = this.editor;
- editor.conversion.for( 'downcast' ).add( dispatcher => {
- dispatcher.on( 'attribute:linkHref', ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.item, 'attribute:linkHref' );
- // Very simplified downcast just for test assertion.
- const viewWriter = conversionApi.writer;
- const linkElement = viewWriter.createAttributeElement(
- 'a',
- {
- href: data.attributeNewValue
- }, {
- priority: 5
- }
- );
- viewWriter.setCustomProperty( 'link', true, linkElement );
- viewWriter.wrap( conversionApi.mapper.toViewRange( data.range ), linkElement );
- }, { priority: 'highest' } );
- } );
- }
- }
- await editor.destroy();
- editor = await ClassicTestEditor.create( element, {
- plugins: [ Paragraph, LinkEditing, Enter, CustomLinks ],
- link: {
- addTargetToExternalLinks: true
- }
- } );
- model = editor.model;
- view = editor.editing.view;
- } );
- it( 'has possibility to override default one', () => {
- editor.setData( '<p><a href="http://example.com">foo</a>bar</p>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<paragraph><$text linkHref="http://example.com">foo</$text>bar</paragraph>' );
- expect( editor.getData() ).to.equal( '<p><a href="http://example.com">foo</a>bar</p>' );
- } );
- } );
- describe( 'upcast converter', () => {
- let element, editor;
- beforeEach( () => {
- element = document.createElement( 'div' );
- document.body.appendChild( element );
- } );
- afterEach( () => {
- element.remove();
- } );
- it( 'should upcast attributes from initial data', async () => {
- editor = await ClassicTestEditor.create( element, {
- initialData: '<p><a href="url" target="_blank" rel="noopener noreferrer" download="file">Foo</a>' +
- '<a href="example.com" download="file">Bar</a></p>',
- plugins: [ Paragraph, LinkEditing, Enter ],
- link: {
- decorators: {
- isExternal: {
- mode: 'manual',
- label: 'Open in a new window',
- attributes: {
- target: '_blank',
- rel: 'noopener noreferrer'
- }
- },
- isDownloadable: {
- mode: 'manual',
- label: 'Downloadable',
- attributes: {
- download: 'file'
- }
- }
- }
- }
- } );
- model = editor.model;
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal(
- '<paragraph>' +
- '<$text linkHref="url" linkIsDownloadable="true" linkIsExternal="true">Foo</$text>' +
- '<$text linkHref="example.com" linkIsDownloadable="true">Bar</$text>' +
- '</paragraph>'
- );
- await editor.destroy();
- } );
- it( 'should not upcast partial and incorrect attributes', async () => {
- editor = await ClassicTestEditor.create( element, {
- initialData: '<p><a href="url" target="_blank" download="something">Foo</a>' +
- '<a href="example.com" download="test">Bar</a></p>',
- plugins: [ Paragraph, LinkEditing, Enter ],
- link: {
- decorators: {
- isExternal: {
- mode: 'manual',
- label: 'Open in a new window',
- attributes: {
- target: '_blank',
- rel: 'noopener noreferrer'
- }
- },
- isDownloadable: {
- mode: 'manual',
- label: 'Downloadable',
- attributes: {
- download: 'file'
- }
- }
- }
- }
- } );
- model = editor.model;
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal(
- '<paragraph>' +
- '<$text linkHref="url">Foo</$text>' +
- '<$text linkHref="example.com">Bar</$text>' +
- '</paragraph>'
- );
- await editor.destroy();
- } );
- } );
- } );
- // https://github.com/ckeditor/ckeditor5/issues/1016
- describe( 'typing around the link after a click', () => {
- let editor;
- beforeEach( async () => {
- editor = await ClassicTestEditor.create( element, {
- plugins: [ Paragraph, LinkEditing, Enter, Typing, BoldEditing ],
- link: {
- decorators: {
- isFoo: {
- mode: 'manual',
- label: 'Foo',
- attributes: {
- class: 'foo'
- }
- },
- isBar: {
- mode: 'manual',
- label: 'Bar',
- attributes: {
- target: '_blank'
- }
- }
- }
- }
- } );
- model = editor.model;
- view = editor.editing.view;
- } );
- afterEach( async () => {
- await editor.destroy();
- } );
- it( 'should insert content after the link', () => {
- setModelData( model, '<paragraph><$text linkHref="url">Bar[]</$text></paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph><$text linkHref="url">Bar</$text>[]</paragraph>' );
- editor.execute( 'input', { text: 'Foo' } );
- expect( getModelData( model ) ).to.equal( '<paragraph><$text linkHref="url">Bar</$text>Foo[]</paragraph>' );
- } );
- it( 'should insert content before the link', () => {
- setModelData( model, '<paragraph><$text linkHref="url">[]Bar</$text></paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph>[]<$text linkHref="url">Bar</$text></paragraph>' );
- editor.execute( 'input', { text: 'Foo' } );
- expect( getModelData( model ) ).to.equal( '<paragraph>Foo[]<$text linkHref="url">Bar</$text></paragraph>' );
- } );
- it( 'should insert content to the link if clicked inside it', () => {
- setModelData( model, '<paragraph><$text linkHref="url">B[]ar</$text></paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph><$text linkHref="url">B[]ar</$text></paragraph>' );
- editor.execute( 'input', { text: 'ar. B' } );
- expect( getModelData( model ) ).to.equal( '<paragraph><$text linkHref="url">Bar. B[]ar</$text></paragraph>' );
- } );
- it( 'should insert content between two links (selection at the end of the first link)', () => {
- setModelData( model, '<paragraph><$text linkHref="foo">Foo[]</$text><$text linkHref="bar">Bar</$text></paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph><$text linkHref="foo">Foo</$text>[]<$text linkHref="bar">Bar</$text></paragraph>'
- );
- editor.execute( 'input', { text: 'Foo' } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph><$text linkHref="foo">Foo</$text>Foo[]<$text linkHref="bar">Bar</$text></paragraph>'
- );
- } );
- it( 'should insert content between two links (selection at the beginning of the second link)', () => {
- setModelData( model, '<paragraph><$text linkHref="foo">Foo</$text><$text linkHref="bar">[]Bar</$text></paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph><$text linkHref="foo">Foo</$text>[]<$text linkHref="bar">Bar</$text></paragraph>'
- );
- editor.execute( 'input', { text: 'Foo' } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph><$text linkHref="foo">Foo</$text>Foo[]<$text linkHref="bar">Bar</$text></paragraph>'
- );
- } );
- it( 'should not touch other attributes than `linkHref`', () => {
- setModelData( model, '<paragraph><$text bold="true" linkHref="url">Bar[]</$text></paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph><$text bold="true" linkHref="url">Bar</$text><$text bold="true">[]</$text></paragraph>'
- );
- editor.execute( 'input', { text: 'Foo' } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph><$text bold="true" linkHref="url">Bar</$text><$text bold="true">Foo[]</$text></paragraph>'
- );
- } );
- it( 'should do nothing if the text was not clicked', () => {
- setModelData( model, '<paragraph><$text linkHref="url">Bar[]</$text></paragraph>' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph><$text linkHref="url">Bar[]</$text></paragraph>' );
- } );
- it( 'should do nothing if the selection is not collapsed after the click', () => {
- setModelData( model, '<paragraph>[<$text linkHref="url">Bar</$text>]</paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph>[<$text linkHref="url">Bar</$text>]</paragraph>' );
- } );
- it( 'should do nothing if the text is not a link', () => {
- setModelData( model, '<paragraph><$text bold="true">Bar[]</$text></paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal( '<paragraph><$text bold="true">Bar[]</$text></paragraph>' );
- } );
- it( 'should remove manual decorators', () => {
- model.schema.extend( '$text', {
- allowIn: '$root',
- allowAttributes: [ 'linkIsFoo', 'linkIsBar' ]
- } );
- setModelData( model, '<paragraph><$text linkIsFoo="true" linkIsBar="true" linkHref="url">Bar[]</$text></paragraph>' );
- editor.editing.view.document.fire( 'mousedown' );
- editor.editing.view.document.fire( 'selectionChange', {
- newSelection: view.document.selection
- } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph><$text linkHref="url" linkIsBar="true" linkIsFoo="true">Bar</$text>[]</paragraph>'
- );
- editor.execute( 'input', { text: 'Foo' } );
- expect( getModelData( model ) ).to.equal(
- '<paragraph><$text linkHref="url" linkIsBar="true" linkIsFoo="true">Bar</$text>Foo[]</paragraph>'
- );
- } );
- } );
- } );
|