bootsy

by volmer

volmer /bootsy

Disclaimer: this project is no longer maintained.

455 Stars 172 Forks Last release: almost 4 years ago (v2.3.1) MIT License 459 Commits 42 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Bootsy

Gem Version Build Status

Disclaimer: this project is no longer maintained.

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

Live demo

Requirements

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

Installation

  1. Add Bootsy to your Gemfile and
    bundle install
    it:
    ruby
    gem 'bootsy'
    
  bundle install
  1. Mount Bootsy at the beginning of your

    config/routes.rb
    : ```ruby Rails.application.routes.draw do mount Bootsy::Engine => '/bootsy', as: 'bootsy'

    ...

end ```

  1. Require Bootsy in the asset pipeline:

In your

app/assets/javascripts/application.js
, put this after requiring jQuery and Bootstrap:
  //= require bootsy

In your

app/assets/stylesheets/application.css
, put this line after requiring Bootstrap:
  *= require bootsy
  1. Add and run migrations:
    console
    bundle exec rake bootsy:install:migrations
    bundle exec rake db:migrate
    

Usage

Just call

bootsy_area
in your
FormBuilder
instances, the same way you'd call
textarea
. Example: ```erb <%= formfor(@post) do |f| %> <%= f.label :title %> <%= f.textfield :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:
ruby
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: ```ruby private

def postparams params.require(:post).permit(:title, :content, :bootsyimagegalleryid) end ```

Bootsy with Simple Form builders

You can use

bootsy
as an input type in
SimpleForm::FormBuilder
instances. Example: ```erb <%= simpleformfor @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:

erb

Available options are:
:blockquote
,
: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:

erb

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. Create a copy of Bootsy's initalizer file in your

config/initializers
and feel free to uncomment and change the options as you like.

I18n

You can translate Bootsy to your own language. Simply create a locale file for it in your

config/locales
directory similar to Bootsy's master English file.

You also need to translate Bootsy on the JavaScript side. Just follow this example. Bootsy will try to guess the locale based on the

lang
attribute of the page's
 tag.
You can set the locale directly by setting a 
data-bootsy-locale
attribute on your
.

License

MIT License. Copyright 2012-2017 Volmer Campos Soares

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.