| Module | ActionView::Helpers::FormTagHelper |
| In: |
vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb
|
Provides a number of methods for creating form tags that doesn‘t rely on conventions with an object assigned to the template like FormHelper does. With the FormTagHelper, you provide the names and values yourself.
NOTE: The html options disabled, readonly, and multiple can all be treated as booleans. So specifying :disabled => true will give disabled="disabled".
Creates a check box.
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 142
142: def check_box_tag(name, value = "1", checked = false, options = {})
143: html_options = { "type" => "checkbox", "name" => name, "id" => name, "value" => value }.update(options.stringify_keys)
144: html_options["checked"] = "checked" if checked
145: tag :input, html_options
146: end
Outputs "</form>"
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 63
63: def end_form_tag
64: "</form>"
65: end
Creates a file upload field.
If you are using file uploads then you will also need to set the multipart option for the form:
<%= form_tag { :action => "post" }, { :multipart => true } %>
<label for="file">File to Upload</label> <%= file_field_tag "file" %>
<%= submit_tag %>
<%= end_form_tag %>
The specified URL will then be passed a File object containing the selected file, or if the field was left blank, a StringIO object.
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 114
114: def file_field_tag(name, options = {})
115: text_field_tag(name, nil, options.update("type" => "file"))
116: end
Starts a form tag that points the action to an url configured with url_for_options just like ActionController::Base#url_for. The method for the form defaults to POST.
Examples:
ERb example:
<% form_tag '/posts' do -%>
<div><%= submit_tag 'Save' %></div>
<% end -%>
Will output:
<form action="/posts" method="post"><div><input type="submit" name="submit" value="Save" /></div></form>
Options:
If "put", "delete", or another verb is used, a hidden input with name _method
is added to simulate the verb over post.
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 33
33: def form_tag(url_for_options = {}, options = {}, *parameters_for_url, &block)
34: html_options = options.stringify_keys
35: html_options["enctype"] = "multipart/form-data" if html_options.delete("multipart")
36: html_options["action"] = url_for(url_for_options, *parameters_for_url)
37:
38: method_tag = ""
39:
40: case method = html_options.delete("method").to_s
41: when /^get$/i # must be case-insentive, but can't use downcase as might be nil
42: html_options["method"] = "get"
43: when /^post$/i, "", nil
44: html_options["method"] = "post"
45: else
46: html_options["method"] = "post"
47: method_tag = content_tag(:div, tag(:input, :type => "hidden", :name => "_method", :value => method), :style => 'margin:0;padding:0')
48: end
49:
50: if block_given?
51: content = capture(&block)
52: concat(tag(:form, html_options, true) + method_tag, block.binding)
53: concat(content, block.binding)
54: concat("</form>", block.binding)
55: else
56: tag(:form, html_options, true) + method_tag
57: end
58: end
Creates a hidden field.
Takes the same options as text_field_tag
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 100
100: def hidden_field_tag(name, value = nil, options = {})
101: text_field_tag(name, value, options.stringify_keys.update("type" => "hidden"))
102: end
Displays an image which when clicked will submit the form.
source is passed to AssetTagHelper#image_path
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 171
171: def image_submit_tag(source, options = {})
172: tag :input, { "type" => "image", "src" => image_path(source) }.update(options.stringify_keys)
173: end
Creates a password field.
Takes the same options as text_field_tag
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 121
121: def password_field_tag(name = "password", value = nil, options = {})
122: text_field_tag(name, value, options.update("type" => "password"))
123: end
Creates a radio button.
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 149
149: def radio_button_tag(name, value, checked = false, options = {})
150: pretty_tag_value = value.to_s.gsub(/\s/, "_").gsub(/(?!-)\W/, "").downcase
151: html_options = { "type" => "radio", "name" => name, "id" => "#{name}_#{pretty_tag_value}", "value" => value }.update(options.stringify_keys)
152: html_options["checked"] = "checked" if checked
153: tag :input, html_options
154: end
Creates a dropdown selection box, or if the :multiple option is set to true, a multiple choice selection box.
Helpers::FormOptions can be used to create common select boxes such as countries, time zones, or associated records.
option_tags is a string containing the option tags for the select box:
# Outputs <select id="people" name="people"><option>David</option></select> select_tag "people", "<option>David</option>"
Options:
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 81
81: def select_tag(name, option_tags = nil, options = {})
82: content_tag :select, option_tags, { "name" => name, "id" => name }.update(options.stringify_keys)
83: end
Creates a submit button with the text value as the caption. If options contains a pair with the key of "disable_with", then the value will be used to rename a disabled version of the submit button.
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 158
158: def submit_tag(value = "Save changes", options = {})
159: options.stringify_keys!
160:
161: if disable_with = options.delete("disable_with")
162: options["onclick"] = "this.disabled=true;this.value='#{disable_with}';this.form.submit();#{options["onclick"]}"
163: end
164:
165: tag :input, { "type" => "submit", "name" => "commit", "value" => value }.update(options.stringify_keys)
166: end
Creates a text input area.
Options:
# Outputs <textarea name="body" id="body" cols="25" rows="10"></textarea> <%= text_area_tag "body", nil, :size => "25x10" %>
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 131
131: def text_area_tag(name, content = nil, options = {})
132: options.stringify_keys!
133:
134: if size = options.delete("size")
135: options["cols"], options["rows"] = size.split("x")
136: end
137:
138: content_tag :textarea, content, { "name" => name, "id" => name }.update(options.stringify_keys)
139: end
Creates a standard text field.
Options:
A hash of standard HTML options for the tag.
# File vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb, line 93
93: def text_field_tag(name, value = nil, options = {})
94: tag :input, { "type" => "text", "name" => name, "id" => name, "value" => value }.update(options.stringify_keys)
95: end