Permalink
Browse files

Add documentation for add_flash_types [ci skip]

Document a little bit the ActionController::Flash::add_flash_types
class method.
  • Loading branch information...
1 parent 4d733d2 commit b163754bc55c3d23e62071d39451c2fbe4579e99 @robin850 robin850 committed Jul 10, 2013
Showing with 17 additions and 0 deletions.
  1. +17 −0 actionpack/lib/action_controller/metal/flash.rb
@@ -11,6 +11,23 @@ module Flash
end
module ClassMethods
+ # Creates new flash types. You can pass as many types as you want to create
+ # flash types other than the default <tt>alert</tt> and <tt>notice</tt> in
+ # your controllers and views. For instance:
+ #
+ # # in application_controller.rb
+ # class ApplicationController < ActionController::Base
+ # add_flash_types :warning
+ # end
+ #
+ # # in your controller
+ # redirect_to user_path(@user), warning: "Incomplete profile"
+ #
+ # # in your view
+ # <%= warning %>
+ #
+ # This method will automatically define a new method for each of the given
+ # names, and it will be available in your views.
def add_flash_types(*types)
types.each do |type|
next if _flash_types.include?(type)

0 comments on commit b163754

Please sign in to comment.