Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
WYSIWYG editor for Bootstrap, integrated in Rails assets pipeline
Failed to load latest commit information.
.bundle remove .rvmrc
lib version up
testapp change
vendor/assets Fixes regression
.gitignore New release
CONTRIBUTING.md contributing.md
Gemfile initial commit
README.md Make the gem github include code more concise
Rakefile Fixes regression
bootstrap-wysihtml5-rails.gemspec update

README.md

Bootstrap wysihtml5 for Rails

Gem Version

endorse

Bootstrap is a toolkit from Twitter designed to kickstart development of webapps and sites. It includes base CSS and HTML for typography, forms, buttons, tables, grids, navigation, and more.

http://twitter.github.com/bootstrap/

Bootstrap Wysihtml5 is a plugin for Bootstrap designed by James Hollingworth. It provides a stylish wysiwyg editor for Bootstrap. We use Christian Sterzl's fork.

https://github.com/bootstrap-wysiwyg/bootstrap3-wysiwyg

bootstrap-wysihtml5-rails project integrates it with Rails 3 assets pipeline.

https://github.com/Nerian/bootstrap-wysihtml5-rails

Latest version with Bootstrap 2 support was 0.3.1.24. New releases only package Bootstrap 3 support.

Rails > 3.1

Include bootstrap-wysihtml5-rails in Gemfile;

gem 'bootstrap-wysihtml5-rails'

or you can install from latest build;

gem 'bootstrap-wysihtml5-rails', github: 'nerian/bootstrap-wysihtml5-rails'

and run bundle install.

This gem doesn't include Bootstrap. You can get Bootstrap here: https://github.com/twbs/bootstrap-sass

Configuration

Bootstrap-wysihtml5 depends on bootstrap and jQuery.

app/assets/stylesheets/application.css

*= require bootstrap-wysihtml5

app/assets/javascripts/application.js

//= require bootstrap-wysihtml5

You may include all locales like this:

//= require bootstrap-wysihtml5/locales

Or just add the ones that you want

//= require bootstrap-wysihtml5/locales/de-DE
//= require bootstrap-wysihtml5/locales/es-ES

//= require bootstrap-wysihtml5 will embed both wysihtml5x and handlebars. But you can fine tune what you require, like this:

//= require bootstrap-wysihtml5/wysihtml5x-toolbar.js
//= require bootstrap-wysihtml5/handlebars.runtime.min.js

//= require bootstrap-wysihtml5/minimum

You may need to restart your rails server.

Using bootstrap-wysihtml5-rails directly

Just call wysihtml5() with any selector.

<textarea id="some-textarea" class='wysihtml5' placeholder="Enter text ..."></textarea>

<script type="text/javascript">
  $(document).ready(function(){

    $('.wysihtml5').each(function(i, elem) {
      $(elem).wysihtml5();
    });

  })
</script>

Using bootstrap-wysihtml5-rails with simple_form

There is simple_form input which you can apply via as: :wysihtml5 option.

<%= f.input :content, as: :wysihtml5 %>

If using Turbolinks

$(document).on('page:load', function(){
  window['rangy'].initialized = false
})

License

Copyright (c) 2012-2014 Gonzalo Rodríguez-Baltanás Díaz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.