| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492 |
- /**
- * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /* global document */
- import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
- import BalloonEditor from '@ckeditor/ckeditor5-editor-balloon/src/ballooneditor';
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
- import Widget from '../src/widget';
- import WidgetToolbarRepository from '../src/widgettoolbarrepository';
- import { isWidget, toWidget } from '../src/utils';
- import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
- import View from '@ckeditor/ckeditor5-ui/src/view';
- import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- describe( 'WidgetToolbarRepository', () => {
- let editor, model, balloon, widgetToolbarRepository, editorElement;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- return ClassicTestEditor
- .create( editorElement, {
- plugins: [ Paragraph, FakeButton, WidgetToolbarRepository, FakeWidget, FakeChildWidget ],
- fake: {
- toolbar: [ 'fake_button' ]
- }
- } )
- .then( newEditor => {
- editor = newEditor;
- model = newEditor.model;
- widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
- balloon = editor.plugins.get( 'ContextualBalloon' );
- } );
- } );
- afterEach( () => {
- editorElement.remove();
- return editor.destroy();
- } );
- it( 'should be loaded', () => {
- expect( editor.plugins.get( WidgetToolbarRepository ) ).to.be.instanceOf( WidgetToolbarRepository );
- } );
- it( 'should work if balloon toolbar is not available', () => {
- editorElement.remove();
- editor.destroy();
- editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- expect( editor.plugins.has( 'BalloonToolbar' ) ).to.be.false;
- expect( editor.plugins.has( WidgetToolbarRepository ) ).to.be.true;
- } );
- describe( 'register()', () => {
- it( 'should create a widget toolbar and add it to the collection', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: () => null,
- } );
- expect( widgetToolbarRepository._toolbarDefinitions.size ).to.equal( 1 );
- expect( widgetToolbarRepository._toolbarDefinitions.get( 'fake' ) ).to.be.an( 'object' );
- } );
- it( 'should throw when adding two times widget with the same id', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: () => null
- } );
- expect( () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: () => null
- } );
- } ).to.throw( CKEditorError, /^widget-toolbar-duplicated/ );
- } );
- } );
- describe( 'integration tests', () => {
- beforeEach( () => {
- editor.ui.focusTracker.isFocused = true;
- } );
- it( 'toolbar should be visible when the `getRelatedElement` callback returns a selected widget element', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget
- } );
- setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
- const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
- expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
- } );
- it( 'toolbar should be hidden when the `getRelatedElement` callback returns null', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget
- } );
- setData( model, '[<paragraph>foo</paragraph>]<fake-widget></fake-widget>' );
- expect( balloon.visibleView ).to.equal( null );
- } );
- it( 'toolbar should be hidden when the `getRelatedElement` callback returns null #2', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget
- } );
- setData( model, '<paragraph>foo</paragraph>[<fake-widget></fake-widget>]' );
- model.change( writer => {
- // Select the <paragraph>foo</paragraph>.
- writer.setSelection( model.document.getRoot().getChild( 0 ), 'in' );
- } );
- expect( balloon.visibleView ).to.equal( null );
- } );
- it( 'toolbar should update its position when other widget is selected', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget
- } );
- setData( model, '[<fake-widget></fake-widget>]<fake-widget></fake-widget>' );
- model.change( writer => {
- // Select the second widget.
- writer.setSelection( model.document.getRoot().getChild( 1 ), 'on' );
- } );
- const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
- expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
- } );
- it( 'it should be possible to create a widget toolbar for content inside the widget', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidgetContent
- } );
- setData( model, '<fake-widget>[foo]</fake-widget>' );
- const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
- expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
- } );
- it( 'toolbar should not engage when is in the balloon yet invisible', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget
- } );
- const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
- setData( model, '[<fake-widget></fake-widget>]' );
- expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
- const lastView = new View();
- lastView.element = document.createElement( 'div' );
- balloon.add( {
- view: lastView,
- position: {
- target: document.body
- }
- } );
- expect( balloon.visibleView ).to.equal( lastView );
- editor.ui.fire( 'update' );
- expect( balloon.visibleView ).to.equal( lastView );
- } );
- // #60
- it( 'should show up only for the related element which is deepest in the view document', () => {
- // The point of this widget is to provide a getRelatedElement function that
- // returns a super–shallow related element which is ignored but satisfies code coverage.
- widgetToolbarRepository.register( 'dummy', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: () => editor.editing.view.document.getRoot()
- } );
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget
- } );
- widgetToolbarRepository.register( 'fake-child', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeChildWidget
- } );
- setData( model,
- '<paragraph>foo</paragraph>' +
- '<fake-widget>' +
- '<paragraph>foo</paragraph>' +
- '[<fake-child-widget></fake-child-widget>]' +
- '</fake-widget>' );
- const fakeChildWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake-child' ).view;
- expect( balloon.visibleView ).to.equal( fakeChildWidgetToolbarView );
- } );
- // #60
- it( 'should attach to the new related view element upon selecting another widget', () => {
- const view = editor.editing.view;
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget
- } );
- widgetToolbarRepository.register( 'fake-child', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeChildWidget
- } );
- setData( model,
- '<paragraph>foo</paragraph>' +
- '[<fake-widget>' +
- '<paragraph>foo</paragraph>' +
- '<fake-child-widget></fake-child-widget>' +
- '</fake-widget>]' );
- const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
- const fakeChildWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake-child' ).view;
- expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
- const fakeChildViewElement = view.document.getRoot().getChild( 1 ).getChild( 1 );
- const updatePositionSpy = sinon.spy( balloon, 'add' );
- view.change( writer => {
- // [<fake-child-widget></fake-child-widget>]
- writer.setSelection( fakeChildViewElement, 'on' );
- } );
- expect( balloon.visibleView ).to.equal( fakeChildWidgetToolbarView );
- expect( updatePositionSpy.firstCall.args[ 0 ].position.target ).to.equal(
- view.domConverter.viewToDom( fakeChildViewElement ) );
- } );
- } );
- } );
- describe( 'WidgetToolbarRepository - integration with the BalloonToolbar', () => {
- let clock, editor, model, balloon, balloonToolbar, widgetToolbarRepository, editorElement;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- editorElement = document.createElement( 'div' );
- document.body.appendChild( editorElement );
- clock = testUtils.sinon.useFakeTimers();
- return BalloonEditor
- .create( editorElement, {
- plugins: [ Paragraph, FakeButton, WidgetToolbarRepository, FakeWidget, Bold ],
- balloonToolbar: [ 'bold' ],
- fake: {
- toolbar: [ 'fake_button' ]
- }
- } )
- .then( newEditor => {
- editor = newEditor;
- model = newEditor.model;
- widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
- balloon = editor.plugins.get( 'ContextualBalloon' );
- balloonToolbar = editor.plugins.get( 'BalloonToolbar' );
- editor.ui.focusTracker.isFocused = true;
- } );
- } );
- afterEach( () => {
- editorElement.remove();
- return editor.destroy();
- } );
- it( 'balloon toolbar should be hidden when the widget is selected', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget,
- } );
- const fakeWidgetToolbarView = widgetToolbarRepository._toolbarDefinitions.get( 'fake' ).view;
- setData( model, '[<fake-widget></fake-widget>]<paragraph>foo</paragraph>' );
- editor.ui.focusTracker.isFocused = true;
- clock.tick( 200 );
- expect( balloon.visibleView ).to.equal( fakeWidgetToolbarView );
- } );
- it( 'balloon toolbar should be visible when the widget is not selected', () => {
- widgetToolbarRepository.register( 'fake', {
- items: editor.config.get( 'fake.toolbar' ),
- getRelatedElement: getSelectedFakeWidget
- } );
- setData( model, '<fake-widget></fake-widget><paragraph>[foo]</paragraph>' );
- editor.ui.focusTracker.isFocused = true;
- clock.tick( 200 );
- expect( balloon.visibleView ).to.equal( balloonToolbar.toolbarView );
- } );
- } );
- const fakeWidgetSymbol = Symbol( 'fakeWidget' );
- const fakeChildWidgetSymbol = Symbol( 'fakeChildWidget' );
- function getSelectedFakeWidget( selection ) {
- const viewElement = selection.getSelectedElement();
- if ( viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( fakeWidgetSymbol ) ) {
- return viewElement;
- }
- return null;
- }
- function getSelectedFakeChildWidget( selection ) {
- const viewElement = selection.getSelectedElement();
- if ( viewElement && isWidget( viewElement ) && !!viewElement.getCustomProperty( fakeChildWidgetSymbol ) ) {
- return viewElement;
- }
- return null;
- }
- function getSelectedFakeWidgetContent( selection ) {
- const pos = selection.getFirstPosition();
- let node = pos.parent;
- while ( node ) {
- if ( node.is( 'element' ) && isWidget( node ) && node.getCustomProperty( fakeWidgetSymbol ) ) {
- return node;
- }
- node = node.parent;
- }
- return null;
- }
- // Plugin that adds fake_button to editor's component factory.
- class FakeButton extends Plugin {
- init() {
- this.editor.ui.componentFactory.add( 'fake_button', locale => {
- const view = new ButtonView( locale );
- view.set( {
- label: 'fake button'
- } );
- return view;
- } );
- }
- }
- // Simple widget plugin
- // It registers `<fake-widget>` block in model and represents `div` in the view.
- // It allows having text inside self.
- class FakeWidget extends Plugin {
- static get requires() {
- return [ Widget ];
- }
- init() {
- const editor = this.editor;
- const schema = editor.model.schema;
- schema.register( 'fake-widget', {
- isObject: true,
- isBlock: true,
- allowWhere: '$block'
- } );
- schema.extend( '$text', { allowIn: 'fake-widget' } );
- schema.extend( 'paragraph', { allowIn: 'fake-widget' } );
- const conversion = editor.conversion;
- conversion.for( 'dataDowncast' ).elementToElement( {
- model: 'fake-widget',
- view: ( modelElement, viewWriter ) => {
- return viewWriter.createContainerElement( 'div' );
- }
- } );
- conversion.for( 'editingDowncast' ).elementToElement( {
- model: 'fake-widget',
- view: ( modelElement, viewWriter ) => {
- const fakeWidget = viewWriter.createContainerElement( 'div' );
- viewWriter.setCustomProperty( fakeWidgetSymbol, true, fakeWidget );
- return toWidget( fakeWidget, viewWriter, { label: 'fake-widget' } );
- }
- } );
- conversion.for( 'upcast' ).elementToElement( {
- view: {
- name: 'div'
- },
- model: ( view, modelWriter ) => {
- return modelWriter.createElement( 'fake-widget' );
- }
- } );
- }
- }
- // A simple child widget plugin
- // It registers `<fake-child-widget>` block in model and represents `div` in the view.
- // It allows having text inside self.
- class FakeChildWidget extends Plugin {
- static get requires() {
- return [ Widget ];
- }
- init() {
- const editor = this.editor;
- const schema = editor.model.schema;
- schema.register( 'fake-child-widget', {
- isObject: true,
- isBlock: true,
- allowWhere: '$block',
- allowIn: 'fake-widget'
- } );
- schema.extend( '$text', { allowIn: 'fake-child-widget' } );
- schema.extend( 'paragraph', { allowIn: 'fake-child-widget' } );
- const conversion = editor.conversion;
- conversion.for( 'dataDowncast' ).elementToElement( {
- model: 'fake-child-widget',
- view: ( modelElement, viewWriter ) => {
- return viewWriter.createContainerElement( 'div' );
- }
- } );
- conversion.for( 'editingDowncast' ).elementToElement( {
- model: 'fake-child-widget',
- view: ( modelElement, viewWriter ) => {
- const fakeWidget = viewWriter.createContainerElement( 'div' );
- viewWriter.setCustomProperty( fakeChildWidgetSymbol, true, fakeWidget );
- return toWidget( fakeWidget, viewWriter, { label: 'fake-child-widget' } );
- }
- } );
- conversion.for( 'upcast' ).elementToElement( {
- view: {
- name: 'div'
- },
- model: ( view, modelWriter ) => {
- return modelWriter.createElement( 'fake-child-widget' );
- }
- } );
- }
- }
|