Generate Bootstrap-styled views for Devise using `bootstrap_form`.
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 82 commits ahead of king601:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
lib
test
.gitignore
.rspec
.rubocop.yml
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dangerfile
Gemfile
LICENSE.txt
README.md
RELEASING.md
Rakefile
Vagrantfile
devise-bootstrap-form.gemspec

README.md

Devise Bootstrap Form

This gem gives you a nicer place to start customizing views for your Devise model when you're using the bootstrap_form gem. The bootstrap_form gem makes it easier to generate nice-looking Bootstrap forms in Rails. If you're using bootstrap_form, this gem will help make your Devise views look the same as the rest of the forms in your application.

It also makes the Devise views simpler, because the code to define forms using bootstrap_form is simpler than the code for a "raw" Rails form. So any customization you do to the Devise views will be simpler.

You can find usage information below, but the gist of it is you'll run rails g devise:views:bootstrap_form instead of the normal rails g devise:views.

If you're just looking for Bootstrap markup on your Devise views, and don't want to use bootstrap_form, then you should look into the devise-bootstrapped gem, or devise-bootstrap-views.

Installation

Add these lines to your application's Gemfile:

gem 'bootstrap', '~> 4.0'
gem "bootstrap_form", ">= 4.0.0.alpha1"
gem 'devise' # gem 'devise-i18n'
# gem 'devise_invitable'
gem 'devise-bootstrap-form'

And then execute:

bundle install

There are additional installation instructions for bootstrap_form, bootstrap, devise that you must complete before using devise-bootstrap-form, and devise-i18n.

Usage

Once all the gems are installed and configured, and the user model is generated, you can generate the Bootstrap Form views with:

rails generate devise:views:bootstrap_form

If you've already generated the Devise views you can use the -f argument to force an override, but that will erase any of the changes you've made to the views.

Generate the mailer views from normal Devise, as they're not included in devise-bootstrap-form:

rails generate devise:views -v mailer

To switch back to what Devise gives you, remove the app/views/devise folder. Your application will then use the default Devise views, or you can run the normal Devise rails g devise:views generator command and customize the default Devise views.

Generated Layout

Each of the forms in enclosed in the following:

<div class="devise-bootstrap-form">
  <div class="devise-bootstrap-form-row">
    <div class="devise-bootstrap-form-col">
      <!-- the form... -->
    </div>
  </div>
</div>

The generator also generates app/assets/stylesheets/devise_bootstrap_form.scss that contains the following:

.devise-bootstrap-form {
  @extend .container;
}

.devise-bootstrap-form-col {
  @extend .col-12;
  @extend .col-sm-8;
  @extend .col-lg-6;
}

.devise-bootstrap-form-row {
  @extend .row;
  @extend .justify-content-around;
}

You may want to adjust to your own tastes. For example, if the layout used by your Devise views already wraps the view in a .container, you can remove the:

.devise-bootstrap-form {
  @extend .container;
}

from app/assets/stylesheets/devise_bootstrap_form.scss.

You can also modify the views to change the surrounding divs to your needs, or change the SASS in app/assets/stylesheets/devise_bootstrap_form.scss.

If you don't want the devise_bootstrap_form-generated styles at all, remove the following line from app/asserts/application.scss:

@include "devise_bootstrap_form.scss";

Internationalization

If your Gemfile includes devise-i18n, devise-bootstrap-form will generate views with translations. If you're also using devise_invitable, you have to manually copy its translations into your application from the devise_invitable wiki.

Also, don't forget to add gem "rails-i18n" to your Gemfile.

Contributing

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct.

Refer to the CONTRIBUTING document for more details.

Bug reports and pull requests are welcome on GitHub at https://github.com/lcreid/devise-bootstrap-form.

License

The gem is available as open source under the terms of the MIT License.