Bootstrap Editor add-on for CKEditor
Bootstrap Editor seamlessly integrates to CKEditor and allows you edit the structure of Bootstrap or Foundation blocks. You can call Bootstrap Editor to edit the entire content or just the selected block.
Install this plugin just as you install any other CKEditor add-on.
For even more comfort: Bootstrap Include is already included to the package to simplify linking the framework to the editor.
If you use Foundation, Bootstrap Editor also includes Foundation-versions of plugins.
Installation
- Unpack archived files directly to
ckeditor/plugins
. - Turn on the plugin in
ckeditor/config.js
:config.extraPlugins = 'jsplusInclude,jsplusBootstrapEditor,jsplusFileUploaderLite';
-
Specify framework (Bootstrap or Foundation) for Include CSS/JS add-on:
config.jsplusInclude = { framework: "b3" // or "b4", "f5", "f6", "f6x" }
b3
means Bootstrap 3 here.
This option will affect to all other CSS framework-specific add-ons too.
Read more about framework option or including CSS framework into the page. - Add these buttons to the toolbar definition:
- the button for editing whole the content within Bootstrap Editor
jsplusBootstrapEditor
- the button for editing selected block within Bootstrap Editor
jsplusBootstrapEditorSelected
- Quick uploading of images and inserting their originals
jsplusFastUploadImage
- Quick uploading of images and inserting their thumbnails
jsplusFastUploadPreview
- Quick uploading of files and inserting links to them
jsplusFastUploadFile
- Now you can use your installed plugins. Do not forget to sure that browser cache was cleared.
Configuration
Optionally, you can configure the plugin for your needs. A number of parameters are available for that. Parameters are a key-value structure that's passed along with the main config of CKEditor.
You can specify this parameters in standard CKEditor configuration file ckeditor.js
:
config.jsplusBootstrapEditor = {
key1: "value1",
key2: true
};
If you do not use config.js
or prefer not to change it,
you can pass these parameters as the second argument of function
CKEDITOR.replace
which you use for CKEditor initialization. For example:
CKEDITOR.replace("textAreaId", {jsplusBootstrapEditor: {key: "value"}});
For Drupal 8 users we recommend to configure all parameters via control panel if CMS (all options of the plugins are located on configuration page of CKEditor).
Explore the list of available options to see what settings are available to you.