Opened 12 years ago
Closed 12 years ago
#11282 closed Bug (fixed)
Documentation on Widgets (Part 2) has an error.
| Reported by: | Dennis Dewey | Owned by: | Anna Tomanek |
|---|---|---|---|
| Priority: | Normal | Milestone: | |
| Component: | Documentation & Samples | Version: | 4.3 |
| Keywords: | Cc: |
Description
On this page :
http://docs.ckeditor.com/#!/guide/widget_sdk_tutorial_2
This code block :
CKEDITOR.plugins.add( 'simplebox', {
requires: 'widget',
icons: 'simplebox',
init: function( editor ) {
CKEDITOR.dialog.add( 'simplebox', this.path + 'dialogs/simplebox.js' );
editor.widgets.add( 'simplebox', {
button: 'Create a simple box',
template:
'<div class="simplebox">' +
'<h2 class="simplebox-title">Title</h2>' +
'<div class="simplebox-content"><p>Content...</p></div>' +
'</div>',
editables: {
title: {
selector: '.simplebox-title',
allowedContent: 'br strong em'
},
content: {
selector: '.simplebox-content',
allowedContent: 'p br ul ol li strong em'
}
},
allowedContent:
'div(!simplebox,align-left,align-right,align-center){width};' +
'div(!simplebox-content); h2(!simplebox-title)',
requiredContent: 'div(simplebox)',
dialog: 'simplebox',
upcast: function( element ) {
return element.name == 'div' && element.hasClass( 'simplebox' );
},
init: function() {
var width = this.element.getStyle( 'width' );
if ( with )
this.setData( 'width', width );
if ( this.element.hasClass( 'align-left' ) )
this.setData( 'align', 'left' );
if ( this.element.hasClass( 'align-right' ) )
this.setData( 'align', 'right' );
if ( this.element.hasClass( 'align-center' ) )
this.setData( 'align', 'center' );
},
data: function() {
if ( this.data.width == '' )
this.element.removeStyle( 'width' );
else
this.element.setStyle( 'width', this.data.width );
this.element.removeClass( 'align-left' );
this.element.removeClass( 'align-right' );
this.element.removeClass( 'align-center' );
if ( this.data.align )
this.element.addClass( 'align-' + this.data.align );
}
} );
}
} );
Needs to be replaced with :
CKEDITOR.plugins.add( 'simplebox', {
requires: 'widget',
icons: 'simplebox',
init: function( editor ) {
CKEDITOR.dialog.add( 'simplebox', this.path + 'dialogs/simplebox.js' );
editor.widgets.add( 'simplebox', {
button: 'Create a simple box',
template:
'<div class="simplebox">' +
'<h2 class="simplebox-title">Title</h2>' +
'<div class="simplebox-content"><p>Content...</p></div>' +
'</div>',
editables: {
title: {
selector: '.simplebox-title',
allowedContent: 'br strong em'
},
content: {
selector: '.simplebox-content',
allowedContent: 'p br ul ol li strong em'
}
},
allowedContent:
'div(!simplebox,align-left,align-right,align-center){width};' +
'div(!simplebox-content); h2(!simplebox-title)',
requiredContent: 'div(simplebox)',
dialog: 'simplebox',
upcast: function( element ) {
return element.name == 'div' && element.hasClass( 'simplebox' );
},
init: function() {
var width = this.element.getStyle( 'width' );
if ( width )
this.setData( 'width', width );
if ( this.element.hasClass( 'align-left' ) )
this.setData( 'align', 'left' );
if ( this.element.hasClass( 'align-right' ) )
this.setData( 'align', 'right' );
if ( this.element.hasClass( 'align-center' ) )
this.setData( 'align', 'center' );
},
data: function() {
if ( this.data.width == '' )
this.element.removeStyle( 'width' );
else
this.element.setStyle( 'width', this.data.width );
this.element.removeClass( 'align-left' );
this.element.removeClass( 'align-right' );
this.element.removeClass( 'align-center' );
if ( this.data.align )
this.element.addClass( 'align-' + this.data.align );
}
} );
}
} );
The "with" needs to be replaced with "width" on line 44.
Change History (2)
comment:1 Changed 12 years ago by
| Owner: | set to Anna Tomanek |
|---|---|
| Status: | new → assigned |
comment:2 Changed 12 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
| Type: | Task → Bug |

Thanks for spotting this. This is now fixed in the repository with https://github.com/ckeditor/ckeditor-docs/commit/26c49eca22. The documentation will be rebuilt shortly with the 4.3.1 release.