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

Commit b9b68c6

Browse files
authored
Merge pull request #456 from ckeditor/t/450
Other: The "class" property should control the DOM class attribute in all UI components. Closes #450. BREAKING CHANGE: The `BallonPanelView#className` property was renamed to `#class`. BREAKING CHANGE: The `ToolbarView#className` property was renamed to `#class`.
2 parents 80562ef + bcf2b33 commit b9b68c6

File tree

8 files changed

+19
-19
lines changed

8 files changed

+19
-19
lines changed

src/panel/balloon/balloonpanelview.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ export default class BalloonPanelView extends View {
125125
* An additional CSS class added to the {@link #element}.
126126
*
127127
* @observable
128-
* @member {String} #className
128+
* @member {String} #class
129129
*/
130-
this.set( 'className' );
130+
this.set( 'class' );
131131

132132
/**
133133
* A callback that starts pining the panel when {@link #isVisible} gets
@@ -154,7 +154,7 @@ export default class BalloonPanelView extends View {
154154
bind.to( 'position', value => `ck-balloon-panel_${ value }` ),
155155
bind.if( 'isVisible', 'ck-balloon-panel_visible' ),
156156
bind.if( 'withArrow', 'ck-balloon-panel_with-arrow' ),
157-
bind.to( 'className' )
157+
bind.to( 'class' )
158158
],
159159

160160
style: {

src/panel/balloon/contextualballoon.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ export default class ContextualBalloon extends Plugin {
205205
* @param {String} [data.balloonClassName=''] Additional class name which will added to the {#_balloon} view.
206206
*/
207207
_show( { view, balloonClassName = '' } ) {
208-
this.view.className = balloonClassName;
208+
this.view.class = balloonClassName;
209209

210210
this.view.content.add( view );
211211
this.view.pin( this._getBalloonPosition() );

src/toolbar/block/blocktoolbar.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ export default class BlockToolbar extends Plugin {
187187
const panelView = new BalloonPanelView( editor.locale );
188188

189189
panelView.content.add( this.toolbarView );
190-
panelView.className = 'ck-toolbar-container';
190+
panelView.class = 'ck-toolbar-container';
191191
editor.ui.view.body.add( panelView );
192192
editor.ui.focusTracker.add( panelView.element );
193193

src/toolbar/toolbarview.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ export default class ToolbarView extends View {
6868
* An additional CSS class added to the {@link #element}.
6969
*
7070
* @observable
71-
* @member {String} #className
71+
* @member {String} #class
7272
*/
73-
this.set( 'className' );
73+
this.set( 'class' );
7474

7575
/**
7676
* Helps cycling over focusable {@link #items} in the toolbar.
@@ -99,7 +99,7 @@ export default class ToolbarView extends View {
9999
'ck',
100100
'ck-toolbar',
101101
bind.if( 'isVertical', 'ck-toolbar_vertical' ),
102-
bind.to( 'className' )
102+
bind.to( 'class' )
103103
]
104104
},
105105

tests/panel/balloon/balloonpanelview.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ describe( 'BalloonPanelView', () => {
9797
} );
9898
} );
9999

100-
describe( 'className', () => {
100+
describe( 'class', () => {
101101
it( 'should set additional class to the view#element', () => {
102-
view.className = 'foo';
102+
view.class = 'foo';
103103

104104
expect( view.element.classList.contains( 'foo' ) ).to.true;
105105

106-
view.className = '';
106+
view.class = '';
107107

108108
expect( view.element.classList.contains( 'foo' ) ).to.false;
109109
} );

tests/panel/balloon/contextualballoon.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ describe( 'ContextualBalloon', () => {
287287
balloonClassName: 'foo'
288288
} );
289289

290-
expect( balloon.view.className ).to.equal( 'foo' );
290+
expect( balloon.view.class ).to.equal( 'foo' );
291291

292292
balloon.add( {
293293
view: viewB,
@@ -298,7 +298,7 @@ describe( 'ContextualBalloon', () => {
298298
balloonClassName: 'bar'
299299
} );
300300

301-
expect( balloon.view.className ).to.equal( 'bar' );
301+
expect( balloon.view.class ).to.equal( 'bar' );
302302
} );
303303
} );
304304

@@ -392,7 +392,7 @@ describe( 'ContextualBalloon', () => {
392392

393393
balloon.remove( viewB );
394394

395-
expect( balloon.view.className ).to.equal( 'foo' );
395+
expect( balloon.view.class ).to.equal( 'foo' );
396396
} );
397397
} );
398398

tests/toolbar/block/blocktoolbar.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ describe( 'BlockToolbar', () => {
5858
} );
5959

6060
it( 'should have an additional class name', () => {
61-
expect( blockToolbar.panelView.className ).to.equal( 'ck-toolbar-container' );
61+
expect( blockToolbar.panelView.class ).to.equal( 'ck-toolbar-container' );
6262
} );
6363

6464
it( 'should be added to the ui.view.body collection', () => {

tests/toolbar/toolbarview.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,14 @@ describe( 'ToolbarView', () => {
8585
expect( view.element.classList.contains( 'ck-toolbar_vertical' ) ).to.be.true;
8686
} );
8787

88-
it( 'reacts on view#className', () => {
89-
view.className = 'foo';
88+
it( 'reacts on view#class', () => {
89+
view.class = 'foo';
9090
expect( view.element.classList.contains( 'foo' ) ).to.be.true;
9191

92-
view.className = 'bar';
92+
view.class = 'bar';
9393
expect( view.element.classList.contains( 'bar' ) ).to.be.true;
9494

95-
view.className = false;
95+
view.class = false;
9696
expect( view.element.classList.contains( 'foo' ) ).to.be.false;
9797
expect( view.element.classList.contains( 'bar' ) ).to.be.false;
9898
} );

0 commit comments

Comments
 (0)