aboutsummaryrefslogtreecommitdiffstats
path: root/actionview
diff options
context:
space:
mode:
authorGreg Molnar <molnargerg@gmail.com>2014-06-05 13:53:39 +0100
committerGreg Molnar <molnargerg@gmail.com>2014-06-05 13:53:39 +0100
commitfd6df516a050b88538a9f519408bbf73354fdceb (patch)
tree391c6a62c39ff5859f42598494a502a5927c0219 /actionview
parentbb8b2141844872c94141091ffe3b45505fb3b4db (diff)
downloadrails-fd6df516a050b88538a9f519408bbf73354fdceb.tar.gz
rails-fd6df516a050b88538a9f519408bbf73354fdceb.tar.bz2
rails-fd6df516a050b88538a9f519408bbf73354fdceb.zip
document include_blank's usage with a string [ci skip]
Diffstat (limited to 'actionview')
-rw-r--r--actionview/lib/action_view/helpers/form_tag_helper.rb5
1 files changed, 4 insertions, 1 deletions
diff --git a/actionview/lib/action_view/helpers/form_tag_helper.rb b/actionview/lib/action_view/helpers/form_tag_helper.rb
index f12d436f8e..88b8400644 100644
--- a/actionview/lib/action_view/helpers/form_tag_helper.rb
+++ b/actionview/lib/action_view/helpers/form_tag_helper.rb
@@ -82,7 +82,7 @@ module ActionView
# ==== Options
# * <tt>:multiple</tt> - If set to true the selection will allow multiple choices.
# * <tt>:disabled</tt> - If set to true, the user will not be able to use this input.
- # * <tt>:include_blank</tt> - If set to true, an empty option will be created.
+ # * <tt>:include_blank</tt> - If set to true, an empty option will be created. If set to a string, the string will be used as the option's content and the value will be empty.
# * <tt>:prompt</tt> - Create a prompt option with blank value and the text asking user to select something.
# * <tt>:selected</tt> - Provide a default selected value. It should be of the exact type as the provided options.
# * Any other key creates standard HTML attributes for the tag.
@@ -116,6 +116,9 @@ module ActionView
# select_tag "people", options_from_collection_for_select(@people, "id", "name"), include_blank: true
# # => <select id="people" name="people"><option value=""></option><option value="1">David</option></select>
#
+ # select_tag "people", options_from_collection_for_select(@people, "id", "name"), include_blank: "All"
+ # # => <select id="people" name="people"><option value="">All</option><option value="1">David</option></select>
+ #
# select_tag "people", options_from_collection_for_select(@people, "id", "name"), prompt: "Select something"
# # => <select id="people" name="people"><option value="">Select something</option><option value="1">David</option></select>
#