| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals Event, document */
- import LinkFormView from '../../src/ui/linkformview';
- import View from '@ckeditor/ckeditor5-ui/src/view';
- import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import KeystrokeHandler from '@ckeditor/ckeditor5-utils/src/keystrokehandler';
- import FocusTracker from '@ckeditor/ckeditor5-utils/src/focustracker';
- import FocusCycler from '@ckeditor/ckeditor5-ui/src/focuscycler';
- import ViewCollection from '@ckeditor/ckeditor5-ui/src/viewcollection';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import ManualDecorator from '../../src/utils/manualdecorator';
- import Collection from '@ckeditor/ckeditor5-utils/src/collection';
- import { add as addTranslations, _clear as clearTranslations } from '@ckeditor/ckeditor5-utils/src/translation-service';
- import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
- import Link from '../../src/link';
- import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- describe( 'LinkFormView', () => {
- let view;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- view = new LinkFormView( { t: val => val }, { manualDecorators: [] } );
- view.render();
- } );
- afterEach( () => {
- view.destroy();
- } );
- describe( 'constructor()', () => {
- it( 'should create element from template', () => {
- expect( view.element.classList.contains( 'ck' ) ).to.true;
- expect( view.element.classList.contains( 'ck-link-form' ) ).to.true;
- expect( view.element.classList.contains( 'ck-responsive-form' ) ).to.true;
- expect( view.element.getAttribute( 'tabindex' ) ).to.equal( '-1' );
- } );
- it( 'should create child views', () => {
- expect( view.urlInputView ).to.be.instanceOf( View );
- expect( view.saveButtonView ).to.be.instanceOf( View );
- expect( view.cancelButtonView ).to.be.instanceOf( View );
- expect( view.saveButtonView.element.classList.contains( 'ck-button-save' ) ).to.be.true;
- expect( view.cancelButtonView.element.classList.contains( 'ck-button-cancel' ) ).to.be.true;
- expect( view.children.get( 0 ) ).to.equal( view.urlInputView );
- expect( view.children.get( 1 ) ).to.equal( view.saveButtonView );
- expect( view.children.get( 2 ) ).to.equal( view.cancelButtonView );
- } );
- it( 'should create #focusTracker instance', () => {
- expect( view.focusTracker ).to.be.instanceOf( FocusTracker );
- } );
- it( 'should create #keystrokes instance', () => {
- expect( view.keystrokes ).to.be.instanceOf( KeystrokeHandler );
- } );
- it( 'should create #_focusCycler instance', () => {
- expect( view._focusCycler ).to.be.instanceOf( FocusCycler );
- } );
- it( 'should create #_focusables view collection', () => {
- expect( view._focusables ).to.be.instanceOf( ViewCollection );
- } );
- it( 'should fire `cancel` event on cancelButtonView#execute', () => {
- const spy = sinon.spy();
- view.on( 'cancel', spy );
- view.cancelButtonView.fire( 'execute' );
- expect( spy.calledOnce ).to.true;
- } );
- describe( 'url input view', () => {
- it( 'has placeholder', () => {
- expect( view.urlInputView.fieldView.placeholder ).to.equal( 'https://example.com' );
- } );
- } );
- describe( 'template', () => {
- it( 'has url input view', () => {
- expect( view.template.children[ 0 ].get( 0 ) ).to.equal( view.urlInputView );
- } );
- it( 'has button views', () => {
- expect( view.template.children[ 0 ].get( 1 ) ).to.equal( view.saveButtonView );
- expect( view.template.children[ 0 ].get( 2 ) ).to.equal( view.cancelButtonView );
- } );
- } );
- } );
- describe( 'render()', () => {
- it( 'should register child views in #_focusables', () => {
- expect( view._focusables.map( f => f ) ).to.have.members( [
- view.urlInputView,
- view.saveButtonView,
- view.cancelButtonView
- ] );
- } );
- it( 'should register child views\' #element in #focusTracker', () => {
- const spy = testUtils.sinon.spy( FocusTracker.prototype, 'add' );
- view = new LinkFormView( { t: () => {} }, { manualDecorators: [] } );
- view.render();
- sinon.assert.calledWithExactly( spy.getCall( 0 ), view.urlInputView.element );
- sinon.assert.calledWithExactly( spy.getCall( 1 ), view.saveButtonView.element );
- sinon.assert.calledWithExactly( spy.getCall( 2 ), view.cancelButtonView.element );
- } );
- it( 'starts listening for #keystrokes coming from #element', () => {
- view = new LinkFormView( { t: () => {} }, { manualDecorators: [] } );
- const spy = sinon.spy( view.keystrokes, 'listenTo' );
- view.render();
- sinon.assert.calledOnce( spy );
- sinon.assert.calledWithExactly( spy, view.element );
- } );
- describe( 'activates keyboard navigation for the toolbar', () => {
- it( 'so "tab" focuses the next focusable item', () => {
- const keyEvtData = {
- keyCode: keyCodes.tab,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- // Mock the url input is focused.
- view.focusTracker.isFocused = true;
- view.focusTracker.focusedElement = view.urlInputView.element;
- const spy = sinon.spy( view.saveButtonView, 'focus' );
- view.keystrokes.press( keyEvtData );
- sinon.assert.calledOnce( keyEvtData.preventDefault );
- sinon.assert.calledOnce( keyEvtData.stopPropagation );
- sinon.assert.calledOnce( spy );
- } );
- it( 'so "shift + tab" focuses the previous focusable item', () => {
- const keyEvtData = {
- keyCode: keyCodes.tab,
- shiftKey: true,
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- // Mock the cancel button is focused.
- view.focusTracker.isFocused = true;
- view.focusTracker.focusedElement = view.cancelButtonView.element;
- const spy = sinon.spy( view.saveButtonView, 'focus' );
- view.keystrokes.press( keyEvtData );
- sinon.assert.calledOnce( keyEvtData.preventDefault );
- sinon.assert.calledOnce( keyEvtData.stopPropagation );
- sinon.assert.calledOnce( spy );
- } );
- } );
- } );
- describe( 'DOM bindings', () => {
- describe( 'submit event', () => {
- it( 'should trigger submit event', () => {
- const spy = sinon.spy();
- view.on( 'submit', spy );
- view.element.dispatchEvent( new Event( 'submit' ) );
- expect( spy.calledOnce ).to.true;
- } );
- } );
- } );
- describe( 'focus()', () => {
- it( 'focuses the #urlInputView', () => {
- const spy = sinon.spy( view.urlInputView, 'focus' );
- view.focus();
- sinon.assert.calledOnce( spy );
- } );
- } );
- describe( 'manual decorators', () => {
- let view, collection, linkCommand;
- beforeEach( () => {
- collection = new Collection();
- collection.add( new ManualDecorator( {
- id: 'decorator1',
- label: 'Foo',
- attributes: {
- foo: 'bar'
- }
- } ) );
- collection.add( new ManualDecorator( {
- id: 'decorator2',
- label: 'Download',
- attributes: {
- download: 'download'
- },
- defaultValue: true
- } ) );
- collection.add( new ManualDecorator( {
- id: 'decorator3',
- label: 'Multi',
- attributes: {
- class: 'fancy-class',
- target: '_blank',
- rel: 'noopener noreferrer'
- }
- } ) );
- class LinkCommandMock {
- constructor( manualDecorators ) {
- this.manualDecorators = manualDecorators;
- this.set( 'value' );
- }
- }
- mix( LinkCommandMock, ObservableMixin );
- linkCommand = new LinkCommandMock( collection );
- view = new LinkFormView( { t: val => val }, linkCommand );
- view.render();
- } );
- afterEach( () => {
- view.destroy();
- collection.clear();
- } );
- it( 'switch buttons reflects state of manual decorators', () => {
- expect( view._manualDecoratorSwitches.length ).to.equal( 3 );
- expect( view._manualDecoratorSwitches.get( 0 ) ).to.deep.include( {
- name: 'decorator1',
- label: 'Foo',
- isOn: undefined
- } );
- expect( view._manualDecoratorSwitches.get( 1 ) ).to.deep.include( {
- name: 'decorator2',
- label: 'Download',
- isOn: true
- } );
- expect( view._manualDecoratorSwitches.get( 2 ) ).to.deep.include( {
- name: 'decorator3',
- label: 'Multi',
- isOn: undefined
- } );
- } );
- it( 'reacts on switch button changes', () => {
- const modelItem = collection.first;
- const viewItem = view._manualDecoratorSwitches.first;
- expect( modelItem.value ).to.be.undefined;
- expect( viewItem.isOn ).to.be.undefined;
- viewItem.element.dispatchEvent( new Event( 'click' ) );
- expect( modelItem.value ).to.be.true;
- expect( viewItem.isOn ).to.be.true;
- viewItem.element.dispatchEvent( new Event( 'click' ) );
- expect( modelItem.value ).to.be.false;
- expect( viewItem.isOn ).to.be.false;
- } );
- it( 'reacts on switch button changes for the decorator with defaultValue', () => {
- const modelItem = collection.get( 1 );
- const viewItem = view._manualDecoratorSwitches.get( 1 );
- expect( modelItem.value ).to.be.undefined;
- expect( viewItem.isOn ).to.be.true;
- viewItem.element.dispatchEvent( new Event( 'click' ) );
- expect( modelItem.value ).to.be.false;
- expect( viewItem.isOn ).to.be.false;
- viewItem.element.dispatchEvent( new Event( 'click' ) );
- expect( modelItem.value ).to.be.true;
- expect( viewItem.isOn ).to.be.true;
- } );
- describe( 'getDecoratorSwitchesState()', () => {
- it( 'should provide object with decorators states', () => {
- expect( view.getDecoratorSwitchesState() ).to.deep.equal( {
- decorator1: undefined,
- decorator2: true,
- decorator3: undefined
- } );
- view._manualDecoratorSwitches.map( item => {
- item.element.dispatchEvent( new Event( 'click' ) );
- } );
- view._manualDecoratorSwitches.get( 2 ).element.dispatchEvent( new Event( 'click' ) );
- expect( view.getDecoratorSwitchesState() ).to.deep.equal( {
- decorator1: true,
- decorator2: false,
- decorator3: false
- } );
- } );
- it( 'should use decorator default value if command and decorator values are not set', () => {
- expect( view.getDecoratorSwitchesState() ).to.deep.equal( {
- decorator1: undefined,
- decorator2: true,
- decorator3: undefined
- } );
- } );
- it( 'should use a decorator value if decorator value is set', () => {
- for ( const decorator of collection ) {
- decorator.value = true;
- }
- expect( view.getDecoratorSwitchesState() ).to.deep.equal( {
- decorator1: true,
- decorator2: true,
- decorator3: true
- } );
- for ( const decorator of collection ) {
- decorator.value = false;
- }
- expect( view.getDecoratorSwitchesState() ).to.deep.equal( {
- decorator1: false,
- decorator2: false,
- decorator3: false
- } );
- } );
- it( 'should use a decorator value if link command value is set', () => {
- linkCommand.value = '';
- expect( view.getDecoratorSwitchesState() ).to.deep.equal( {
- decorator1: undefined,
- decorator2: undefined,
- decorator3: undefined
- } );
- for ( const decorator of collection ) {
- decorator.value = false;
- }
- expect( view.getDecoratorSwitchesState() ).to.deep.equal( {
- decorator1: false,
- decorator2: false,
- decorator3: false
- } );
- for ( const decorator of collection ) {
- decorator.value = true;
- }
- expect( view.getDecoratorSwitchesState() ).to.deep.equal( {
- decorator1: true,
- decorator2: true,
- decorator3: true
- } );
- } );
- } );
- } );
- describe( 'localization of manual decorators', () => {
- before( () => {
- addTranslations( 'pl', {
- 'Open in a new tab': 'Otwórz w nowym oknie'
- } );
- } );
- after( () => {
- clearTranslations();
- } );
- let editor, editorElement, linkFormView;
- beforeEach( () => {
- editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ Link ],
- toolbar: [ 'link' ],
- language: 'pl',
- link: {
- decorators: {
- IsExternal: {
- mode: 'manual',
- label: 'Open in a new tab',
- attributes: {
- target: '_blank'
- }
- }
- }
- }
- } )
- .then( newEditor => {
- editor = newEditor;
- linkFormView = new LinkFormView( editor.locale, editor.commands.get( 'link' ) );
- } );
- } );
- afterEach( () => {
- editorElement.remove();
- return editor.destroy();
- } );
- it( 'translates labels of manual decorators UI', () => {
- expect( linkFormView._manualDecoratorSwitches.first.label ).to.equal( 'Otwórz w nowym oknie' );
- } );
- } );
- } );
|