To configure how Bootstrap Widgets should behave, you can use a number of parameters passed as a key-value structure when the editor is invoked.
The way you pass parameters to the editor depends on what edition you use. Please refer to specific instructions to each edition: CKEditor, TinyMCE.
If you use the Foundation version, change "bootstrap" to "foundation" everywhere in parameter names. In the future versions of Bootstrap Widgets we plan to introduce unified parameter names.
Button add-on
jsplus_bootstrap_button_default_style
: stringDefault value (Bootstrap):
btn-primary
Default value (Foundation): empty
Available values (Bootstrap):
btn-default
, btn-primary
, btn-success
, btn-info
, btn-warning
, btn-danger
, btn-link
Available values (Foundation):
(empty)
, secondary
, succcess
, alert
Default type of the button in the dialog.
jsplus_bootstrap_button_default_size
: stringDefault value: empty
Available values (Bootstrap):
btn-xs
, btn-sm
, (empty)
, btn-lg
Available values (Foundation):
tiny
, small
, (empty)
, large
Default size for the buttons.
jsplus_bootstrap_button_default_tag
: stringDefault value:
a
Available values:
a
, input
, button
Default tag for a new button.
jsplus_bootstrap_button_default_link
: stringDefault value:
http://
Default URL for
href
of the button.jsplus_bootstrap_button_default_input_type
: StringDefault value:
button
Available values:
button
, submit
, cancel
Default type for buttons represented with
<input>
tag.jsplus_bootstrap_button_default_enabled
: booleanDefault value:
true
Available values:
true
, false
Default state of the enabled flag in the dialog.
jsplus_bootstrap_button_default_width_100
: booleanDefault value:
false
Available values:
true
, false
Default state of the "Width 100%" checkbox.
jsplus_bootstrap_button_default_text
: stringDefault value:
Download
Default text on the button.
jsplus_foundation_button_default_radius
: booleanDefault value:
false
Available values:
true
, false
Default state of "Radius" checkbox. For Foundation only.
jsplus_foundation_button_default_round
: booleanDefault value:
false
Available values:
true
, false
Default state of "Round" checkbox. For Foundation only.
Icons add-on
jsplus_bootstrap_icons_default_size
: IntegerDefault value:
24
Sets default icon size in the dialog.
jsplus_bootstrap_icons_default_color
: Color (String)Default value:
#000
Default value for color in the dialog.
jsplus_bootstrap_icons_default_add_size_to_style
: BooleanDefault value:
false
Available values:
true
, false
Default state of the 'Add to style' checkbox for size. ``true`` means checked.
jsplus_bootstrap_icons_default_add_color_to_style
: BooelanDefault value:
false
Available values:
true
, false
Default state of the 'Add to style' checkbox for color. ``true`` means checked.
jsplus_bootstrap_icons_default_use_bitmap
: BooleanDefault value:
false
Available values:
true
, false
The 'Insert as a bitmap' checkbox will be checked by default if this parameter is set to ``true``.
jsplus_bootstrap_icons_images_generator_url
: URL (String)Default value: Auto detected URL
Sets if icons generator URL will be automatically detected by this add-on by default.
If there is some specific URL routing configuration on your website, please specify this parameter to has full URL of PHP script for creating a bitmaps (included into a plugin).
jsplus_bootstrap_icons_bitmap_allowed
: BooleanDefault value:
true
Available values:
true
, false
If you want to completely disable the feature of generating bitmaps and hide the corresponding checkbox set this option to ``false``. This can be helpful if your server does not support PHP (and can not run the bitmap generator) or when you want to use font glyphicons all the time.
Image Gallery add-on
jsplus_bootstrap_gallery_uploader_url
: URLDefault value: auto detection
Set this URL to specify the location of uploader images manually. This option affects all JS+ uploader add-ons.
jsplus_bootstrap_gallery_template
: HTML (String)Template for every image inserted with this plugin. Read more in the styling notice below.
jsplus_bootstrap_gallery_template_wrap
: HTML (String)Template that wraps all images to a gallery. Read more in the styling notice.
jsplus_bootstrap_gallery_col_count_show
: BooleanDefault value:
true
Available values:
true
, false
If set to
false
the panel with the column count option will be hidden.jsplus_bootstrap_gallery_default_col_count
: IntegerDefault value:
3
Available values:
1
, 2
, 3
, 4
, 6
, 12
The default number of columns in the gallery. Because Bootstrap has 12 columns in the scaffold structure, the option is limited to 6 available values.
jsplus_bootstrap_gallery_img_resize_show
: BooleanDefault value:
true
Available values:
true
, false
Defines visibility of the image resize panel in the plugin's dialog. All image options described below are applied regardless of the value of this option (it affects visibility only).
jsplus_bootstrap_gallery_default_img_resize
: BooleanDefault value:
true
Available values:
true
, false
Default state of the "Resize image" checkbox in the dialog.
jsplus_bootstrap_gallery_default_img_resize_width
: IntegerDefault value:
800
Defalt value of the "Resize width" text field.
jsplus_bootstrap_gallery_default_img_resize_height
: IntegerDefault value:
600
Defalt value of the "Resize height" text field.
jsplus_bootstrap_gallery_default_img_enlarge
: BooleanDefault value:
false
Available values:
true
, false
If this option is set to
true
, the plugin applies image resize even if target resolution is more than the original one.jsplus_bootstrap_gallery_thumb_resize_show
: BooleanDefault value:
true
Available values:
true
, false
Defines visibility of the thumbnails resize panel. If the panel is hidden, the thumbnail will be resized with default width/height values (see the styling notice below).
jsplus_bootstrap_gallery_default_thumb_width
: IntegerDefault value:
300
Target width for thumbnail in pixels.
jsplus_bootstrap_gallery_default_thumb_height
: IntegerDefault value:
200
Target height for thumbnail in pixels.
jsplus_bootstrap_gallery_default_thumb_enlarge
: BooleanDefault value:
true
Available values:
true
, false
By default even when the source image has lower resolution than target resolution of the thumbnail, the resize (up) will be applied. Set this option to
false
to override this behaviour.jsplus_bootstrap_gallery_allowed_ext
: StringDefault value:
"jpg,jpeg,gif,png,bmp,tif,tiff"
Available values: Comma separated extensions list
Image extensions that are allowed for upload. This option must be synchronized with server configuration (make changes also to
config.php
for PHP version or into IIS configuration for .NET). Some browsers may ignore this parameter.Styling
The styling of this plugin is fully equal to JS+ CKEditor & TinyMCE Image Gallery plugin (without Bootstrap support). You can use its styling manual as example of this plugin galleries styling.
In addition to substituted parameters in Image Gallery plugin, this plugin has also this parameter:
{COL_WIDTH}
- will be substituted with column's width (equals to 12/jsplus_bootstrap_gallery_default_col_count
)
Label add-on
jsplus_bootstrap_label_default_style
: StringDefault value:
label-primary
Available values:
label-default
, label-primary
, label-success
, label-info
, label-warning
, label-danger
Default visual style (color) for a new label.
jsplus_bootstrap_label_default_corners
: StringDefault value:
none
Available values:
none
, radius
, rounded
Default style for corners of a new label. Since Bootstrap has no built-in styles for label corners, all values that are different from
radius
will be represented in the style of the inserted HTML element.jsplus_bootstrap_label_default_title
: StringDefault value:
New
Default text for the title of a new Bootstrap label.
Badge add-on
This add-on is available for Bootstrap users only. Foundation framework just does not have such a widget.
jsplus_bootstrap_badge_default_title
: StringDefault value:
"42"
Default text for the title of a new badge