Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A beautiful wysiwyg editor with image upload for Rails
JavaScript Ruby HTML Cucumber CSS

Merge pull request #134 from pedrosnk/master

change config.serve_static_assets to config.serve_static_files.
latest commit 2f13a03a6b
@volmer authored

README.md

Bootsy

Gem Version Build Status Dependency Status Code Climate Coverage Status

Bootsy is a WYSIWYG editor for Rails based on Bootstrap-wysihtml5 with image uploads using CarrierWave.

Live demo

Requirements

  • ImageMagick or GraphicsMagick (for MiniMagick);
  • Rails 4;
  • Bootstrap 3 fully installed in your app.

Installation

  1. Add Bootsy to your Gemfile:

    gem 'bootsy'
  2. Run the bundle command to install it:

    bundle install
  3. Run the install generator:

    rails generate bootsy:install

    It will include the javascripts and stylesheets in the assets pipeline, create the bootsy.rb initializer and add a copy of the english translations.

    Note: If your project uses SASS or LESS and application.css does not exist, you will be required to require bootsy manually using *= require bootsy or if you prefer to import assets yourself @import "bootsy";

  4. Add and run migrations:

    rake bootsy:install:migrations
    rake db:migrate

Usage

Just call bootsy_area in your FormBuilder instances, the same way you'd call textarea. Example:

<%= form_for(@post) do |f| %>
  <%= f.label :title %>
  <%= f.text_field :title %>

  <%= f.label :content %>
  <%= f.bootsy_area :content %>

  <%= f.submit %>
<% end %>

Bootsy will group the uploaded images as galleries and associate them to one of your models. For instance, if you have a Post model and you want to use bootsy_area with it, you must include the Bootsy::Container module:

class Post < ActiveRecord::Base
  include Bootsy::Container
end

Don't forget to ensure the association between your model objects with Bootsy image galleries. For strong_parameters, you must whitelist the bootsy_image_gallery_id parameter in your controller:

private

def post_params
  params.require(:post).permit(:title, :content, :bootsy_image_gallery_id)
end

Bootsy with Simple Form builders

You can use bootsy as an input type in SimpleForm::FormBuilder instances. Example:

<%= simple_form_for @post do |f| %>
  <%= f.input :title %>

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

  <%= f.button :submit %>
<% end %>

Editor options

You can customize Bootsy through a hash of editor_options:

Enable/disable features

You can enable and disable features as you like. For instance, if you don't want link and color features:

<%= f.bootsy_area :my_attribute, editor_options: { link: false, color: false } %>

Available options are: :font_styles, :emphasis, :lists, :html, :link, :image and :color.

Alert of unsaved changes

By default Bootsy alerts the user about unsaved changes if the page is closed or reloaded. You can disable this feature with:

<%= f.bootsy_area :my_attribute, editor_options: { alert_unsaved: false } %>

Uploads

If you don't want to have image uploads, just call bootsy_area in a form builder not associated to a Bootsy::Container model. This way users will still be able to insert images in the text area using an external image URL.

Configuration

You can set the default editor options, image sizes available (small, medium, large and/or its original), dimensions and more. Take a look at Bootsy's initalizer file /config/initializers/bootsy.rb in your app and feel free to uncomment and change the options as you like.

I18n

Bootsy defines some i18n keys. English translations are added by default to your config/locales directory as bootsy.en.yml. You can use it as a template to translate Bootsy to your language. Here are some examples. You also need to translate Bootstrap-wysihtml5, the underlying javascript editor. Instructions here. You also need to translate Bootsy's javascript messages. Just follow this example.

License

MIT License. Copyright 2012-2015 Volmer Soares

Something went wrong with that request. Please try again.