Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Merge pull request #103 from ckeditor/t/60
Browse files Browse the repository at this point in the history 
Other: Removed automatically filled `config.image.defaultToolbar`. Now, when initializing editor one must always define `config.image.toolbar`. Closes #60.

BREAKING CHANGE: The `config.image.defaultToolbar` is no longer available. All editor instances must configure `config.image.toolbar` instead.
  • Loading branch information
@Reinmar
Reinmar committed Apr 24, 2017
2 parents 19941e9 + 371d35b commit 4db7b34
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 157 deletions.
11 changes: 0 additions & 11 deletions src/imagestyle.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,6 @@ export default class ImageStyle extends Plugin {
for ( let style of styles ) {
this._createButton( style );
}

// Push buttons to default image toolbar if one exists.
const defaultImageToolbarConfig = this.editor.config.get( 'image.defaultToolbar' );

if ( defaultImageToolbarConfig ) {
if ( defaultImageToolbarConfig.length ) {
defaultImageToolbarConfig.push( '|' );
}

styles.forEach( style => defaultImageToolbarConfig.push( style.name ) );
}
}

/**
Expand Down
11 changes: 0 additions & 11 deletions src/imagetextalternative.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,6 @@ export default class ImageTextAlternative extends Plugin {
init() {
this._createButton();

// Push button to default image toolbar if the image toolbar was loaded.
const defaultImageToolbarConfig = this.editor.config.get( 'image.defaultToolbar' );

if ( defaultImageToolbarConfig ) {
if ( defaultImageToolbarConfig.length ) {
defaultImageToolbarConfig.push( '|' );
}

defaultImageToolbarConfig.push( 'imageTextAlternative' );
}

return this._createBalloonPanel().then( panel => {
/**
* Balloon panel containing text alternative change form.
Expand Down
8 changes: 2 additions & 6 deletions src/imagetoolbar.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ import ImageBalloonPanel from './image/ui/imageballoonpanelview';
* Image toolbar class. Creates image toolbar placed inside balloon panel that is showed when image widget is selected.
* Toolbar components are created using editor's {@link module:ui/componentfactory~ComponentFactory ComponentFactory}
* based on {@link module:core/editor/editor~Editor#config configuration} stored under `image.toolbar`.
* Other plugins can add new components to the default toolbar configuration by pushing them to `image.defaultToolbar`
* configuration. Default configuration is used when `image.toolbar` config is not present.
*
* @extends module:core/plugin~Plugin
*/
Expand All @@ -36,8 +34,6 @@ export default class ImageToolbar extends Plugin {
constructor( editor ) {
super( editor );

editor.config.set( 'image.defaultToolbar', [] );

/**
* When set to `true`, toolbar will be repositioned and showed on each render event and focus change.
* Set to `false` to temporary disable the image toolbar.
Expand All @@ -52,10 +48,10 @@ export default class ImageToolbar extends Plugin {
*/
afterInit() {
const editor = this.editor;
const toolbarConfig = editor.config.get( 'image.toolbar' ) || editor.config.get( 'image.defaultToolbar' );
const toolbarConfig = editor.config.get( 'image.toolbar' );

// Don't add the toolbar if there is no configuration.
if ( !toolbarConfig.length ) {
if ( !toolbarConfig || !toolbarConfig.length ) {
return;
}

Expand Down
42 changes: 0 additions & 42 deletions tests/imagestyle.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
* For licensing, see LICENSE.md.
*/

import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
import ImageToolbar from '../src/imagetoolbar';
import ImageStyle from '../src/imagestyle';
import ImageStyleEngine from '../src/imagestyle/imagestyleengine';
import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
Expand Down Expand Up @@ -69,46 +67,6 @@ describe( 'ImageStyle', () => {
}
} );

it( 'should not add buttons to default image toolbar if image toolbar is not present', () => {
expect( editor.config.get( 'image.defaultToolbar' ) ).to.be.undefined;
} );

it( 'should add buttons to default image toolbar if toolbar is present', () => {
const editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );

return ClassicTestEditor.create( editorElement, {
plugins: [ ImageStyle, ImageToolbar ]
} )
.then( newEditor => {
expect( newEditor.config.get( 'image.defaultToolbar' ) ).to.eql( [ 'imageStyleFull', 'imageStyleSide' ] );

newEditor.destroy();
} );
} );

it( 'should add separator before the button if toolbar is present and already has items', () => {
const editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );

const FooPlugin = class extends Plugin {
init() {
this.editor.ui.componentFactory.add( 'foo', () => new ButtonView() );

this.editor.config.get( 'image.defaultToolbar' ).push( 'foo' );
}
};

return ClassicTestEditor.create( editorElement, {
plugins: [ FooPlugin, ImageStyle, ImageToolbar ]
} )
.then( newEditor => {
expect( newEditor.config.get( 'image.defaultToolbar' ) ).to.eql( [ 'foo', '|', 'imageStyleFull', 'imageStyleSide' ] );

newEditor.destroy();
} );
} );

it( 'should not add buttons to image toolbar if configuration is present', () => {
const editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );
Expand Down
41 changes: 0 additions & 41 deletions tests/imagetextalternative.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
* For licensing, see LICENSE.md.
*/

import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
import Image from '../src/image';
import ImageToolbar from '../src/imagetoolbar';
Expand Down Expand Up @@ -92,46 +91,6 @@ describe( 'ImageTextAlternative', () => {
sinon.assert.calledOnce( spy );
expect( plugin.form.lebeledInput.value ).equals( '' );
} );

it( 'should not add button to default image toolbar if image toolbar is not present', () => {
expect( editor.config.get( 'image.defaultToolbar' ) ).to.be.undefined;
} );

it( 'should add button to default image toolbar if toolbar is present', () => {
const editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );

return ClassicTestEditor.create( editorElement, {
plugins: [ ImageTextAlternative, ImageToolbar ]
} )
.then( newEditor => {
expect( newEditor.config.get( 'image.defaultToolbar' ) ).to.eql( [ 'imageTextAlternative' ] );

newEditor.destroy();
} );
} );

it( 'should add separator before the button if toolbar is present and already has items', () => {
const editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );

const FooPlugin = class extends Plugin {
init() {
this.editor.ui.componentFactory.add( 'foo', () => new ButtonView() );

this.editor.config.get( 'image.defaultToolbar' ).push( 'foo' );
}
};

return ClassicTestEditor.create( editorElement, {
plugins: [ FooPlugin, ImageTextAlternative, ImageToolbar ]
} )
.then( newEditor => {
expect( newEditor.config.get( 'image.defaultToolbar' ) ).to.eql( [ 'foo', '|', 'imageTextAlternative' ] );

newEditor.destroy();
} );
} );
} );

describe( 'balloon panel form', () => {
Expand Down
43 changes: 0 additions & 43 deletions tests/imagetoolbar.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,6 @@ describe( 'ImageToolbar', () => {
expect( editor.plugins.get( ImageToolbar ) ).to.be.instanceOf( ImageToolbar );
} );

it( 'should initialize image.defaultToolbar to an empty array', () => {
const editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );

return ClassicEditor.create( editorElement, {
plugins: [ ImageToolbar ],
} )
.then( editor => {
expect( editor.config.get( 'image.defaultToolbar' ) ).to.eql( [] );

return editor.destroy();
} );
} );

it( 'should not initialize if there is no configuration', () => {
const editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );
Expand All @@ -70,25 +56,6 @@ describe( 'ImageToolbar', () => {
} );
} );

it( 'should allow other plugins to alter default config', () => {
const editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );

return ClassicEditor.create( editorElement, {
plugins: [ ImageToolbar, FakeButton, AlterDefaultConfig ]
} )
.then( newEditor => {
const panel = newEditor.plugins.get( ImageToolbar )._panel;
const toolbar = panel.content.get( 0 );
const button = toolbar.items.get( 0 );

expect( newEditor.config.get( 'image.defaultToolbar' ) ).to.eql( [ 'fake_button' ] );
expect( button.label ).to.equal( 'fake button' );

newEditor.destroy();
} );
} );

it( 'should add ImageBalloonPanel to view body', () => {
expect( panel ).to.be.instanceOf( ImageBalloonPanel );
} );
Expand Down Expand Up @@ -145,14 +112,4 @@ describe( 'ImageToolbar', () => {
} );
}
}

class AlterDefaultConfig extends Plugin {
init() {
const defaultImageToolbarConfig = this.editor.config.get( 'image.defaultToolbar' );

if ( defaultImageToolbarConfig ) {
defaultImageToolbarConfig.push( 'fake_button' );
}
}
}
} );
5 changes: 4 additions & 1 deletion tests/manual/caption.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ ClassicEditor.create( document.querySelector( '#editor' ), {
Enter, Typing, Paragraph, Heading, Image, ImageToolbar,
Undo, Clipboard, ImageCaption, ImageStyle, Bold, Italic, Heading, List
],
toolbar: [ 'headings', 'undo', 'redo', 'bold', 'italic', 'bulletedList', 'numberedList' ]
toolbar: [ 'headings', 'undo', 'redo', 'bold', 'italic', 'bulletedList', 'numberedList' ],
image: {
toolbar: [ 'imageStyleFull', 'imageStyleSide', '|' , 'imageTextAlternative' ]
}
} )
.then( editor => {
window.editor = editor;
Expand Down
5 changes: 4 additions & 1 deletion tests/manual/imagestyle.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ import ImageToolbar from '../../src/imagetoolbar';

ClassicEditor.create( document.querySelector( '#editor' ), {
plugins: [ ImageToolbar, EnterPlugin, TypingPlugin, ParagraphPlugin, HeadingPlugin, ImagePlugin, UndoPlugin, ClipboardPlugin, ImageStyle ],
toolbar: [ 'headings', 'undo', 'redo' ]
toolbar: [ 'headings', 'undo', 'redo' ],
image: {
toolbar: [ 'imageStyleFull', 'imageStyleSide' ]
}
} )
.then( editor => {
window.editor = editor;
Expand Down
5 changes: 4 additions & 1 deletion tests/manual/textalternative.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ import ImageToolbar from '../../src/imagetoolbar';

ClassicEditor.create( document.querySelector( '#editor' ), {
plugins: [ EnterPlugin, TypingPlugin, ParagraphPlugin, HeadingPlugin, ImagePlugin, UndoPlugin, ClipboardPlugin, ImageToolbar ],
toolbar: [ 'headings', 'undo', 'redo' ]
toolbar: [ 'headings', 'undo', 'redo' ],
image: {
toolbar: [ 'imageTextAlternative' ]
}
} )
.then( editor => {
window.editor = editor;
Expand Down

0 comments on commit 4db7b34

Please sign in to comment.