https://github.com/fakhir-shad/flash_notifier
Integrate Flash Messages with ease using Noty JS, Toastr JS or Bootstrap
https://github.com/fakhir-shad/flash_notifier
bootstrap bootstrap-alert flash-messages noty-js toastr-js
Last synced: about 2 months ago
JSON representation
Integrate Flash Messages with ease using Noty JS, Toastr JS or Bootstrap
- Host: GitHub
- URL: https://github.com/fakhir-shad/flash_notifier
- Owner: fakhir-shad
- License: mit
- Created: 2018-08-03T12:07:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-01T11:48:44.000Z (over 6 years ago)
- Last Synced: 2025-04-15T18:05:59.139Z (about 2 months ago)
- Topics: bootstrap, bootstrap-alert, flash-messages, noty-js, toastr-js
- Language: Ruby
- Size: 43 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# FlashNotifier
If you are tired of integrating flash messages in your rails application over and over again then this gem is for you!
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'flash_notifier'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install flash_notifier
## Usage
### For Bootstrap Flash Messages
Add this helper method in your layout and make sure you have bootstrap installed!
<%= build_bootstrap_flash %>
You can make the flash dismissible by passing following optional options to the above helper method
<%= build_bootstrap_flash dismiss: true, timeout: 5000 %>
##### default timeout duration is 5000, ignore this option if you want to use default timeout duration
You can add your own wrapper class by passing following parameter
<%= build_bootstrap_flash wrapper_class: 'my-flash-notification' %>
### For other two libraries follow following steps
#### Step 1: Choose a Library Noty JS or Toastr JS
#### For Noty JS 3.1.4 ([Official Website](https://ned.im/noty/#/))
Import noty library in your application.js
//= require noty_lib
Add noty stylesheet in your application.scss
@import "noty";
#### For Toastr JS 2.1.4 ([Official Website](https://codeseven.github.io/toastr/))
Import noty library in your application.js
//= require toastr_lib
Add noty stylesheet in your application.scss
@import "toastr.min";
### Step 2
In your layout add this helper method
<%= build_flash %>
### Optional Step 3: Pass options to helper method
To manage progress bar pass param
<%= build_flash progressBar: true %>
To set auto hide timeout pass param
<%= build_flash timeout: 3500 %>
To set default theme pass param (Note this param works only for Noty JS)
<%= build_flash theme: 'mint' %>
##### Values for these params and additional config options can be found here [Noty JS](https://ned.im/noty/#/options), [Toastr JS](https://codeseven.github.io/toastr/demo.html)
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/fakhir-shad/flash_notifier](https://github.com/fakhir-shad/flash_notifier). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the FlashNotifier project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fakhir-shad/flash_notifier/blob/master/CODE_OF_CONDUCT.md).