Skip to content

alejandrodevs/flash_rails_messages

Repository files navigation

FlashRailsMessages

Build Status Coverage Status

This gem provides an easy and simple way to display flash rails messages. This works with Bootstrap 4+ and Zurb Foundation 6+ frameworks.

Installation

Add this line to your application's Gemfile:

gem 'flash_rails_messages'

And then execute:

$ bundle

Or install it yourself as:

$ gem install flash_rails_messages

Bootstrap 4+

To integrate FlashRailsMessages with Bootstrap run the next:

rails generate flash_rails_messages:install --bootstrap

NOTE: Be sure that you added Bootstrap to your application.

Zurb Foundation 6+

To integrate FlashRailsMessages with Zurb Foundation 3 run the next:

rails generate flash_rails_messages:install --foundation

NOTE: Be sure that you added Foundation to your application.

Usage

You just need to add the line below in your layout:

<%= render_flash_messages %>

Dismissible alerts

<%= render_flash_messages dismissible: true %>

Passing other options

<%= render_flash_messages dismissible: true, id: 'my-alert', class: 'custom-class' %>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alejandrodevs/flash_rails_messages. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the FlashRailsMessages project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.