Provides a number of methods for creating form tags that doesn’t rely on an Active Record object assigned to the template like FormHelper does. Instead, you provide the names and values manually.
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 form input tag.
:disabled - If set to true, the user will not be able to use this input.
Any other key creates standard HTML options for the tag.
check_box_tag 'accept' # => <input id="accept" name="accept" type="checkbox" value="1" /> check_box_tag 'rock', 'rock music' # => <input id="rock" name="rock" type="checkbox" value="rock music" /> check_box_tag 'receive_email', 'yes', true # => <input checked="checked" id="receive_email" name="receive_email" type="checkbox" value="yes" /> check_box_tag 'tos', 'yes', false, :class => 'accept_tos' # => <input class="accept_tos" id="tos" name="tos" type="checkbox" value="yes" /> check_box_tag 'eula', 'accepted', false, :disabled => true # => <input disabled="disabled" id="eula" name="eula" type="checkbox" value="accepted" />
# File lib/action_view/helpers/form_tag_helper.rb, line 320 320: def check_box_tag(name, value = "1", checked = false, options = {}) 321: html_options = { "type" => "checkbox", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(options.stringify_keys) 322: html_options["checked"] = "checked" if checked 323: tag :input, html_options 324: end
Creates a text field of type “email”.
Accepts the same options as text_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 493 493: def email_field_tag(name, value = nil, options = {}) 494: text_field_tag(name, value, options.stringify_keys.update("type" => "email")) 495: end
Creates a field set for grouping HTML form elements.
legend will become the fieldset’s title (optional as per W3C). options accept the same values as tag.
<%= field_set_tag do %> <p><%= text_field_tag 'name' %></p> <% end %> # => <fieldset><p><input id="name" name="name" type="text" /></p></fieldset> <%= field_set_tag 'Your details' do %> <p><%= text_field_tag 'name' %></p> <% end %> # => <fieldset><legend>Your details</legend><p><input id="name" name="name" type="text" /></p></fieldset> <%= field_set_tag nil, :class => 'format' do %> <p><%= text_field_tag 'name' %></p> <% end %> # => <fieldset class="format"><p><input id="name" name="name" type="text" /></p></fieldset>
# File lib/action_view/helpers/form_tag_helper.rb, line 456 456: def field_set_tag(legend = nil, options = nil, &block) 457: content = capture(&block) 458: output = tag(:fieldset, options, true) 459: output.safe_concat(content_tag(:legend, legend)) unless legend.blank? 460: output.concat(content) 461: output.safe_concat("</fieldset>") 462: 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 tag:
<%= form_tag '/upload', :multipart => true do %> <label for="file">File to Upload</label> <%= file_field_tag "file" %> <%= submit_tag %> <% end %>
The specified URL will then be passed a File object containing the selected file, or if the field was left blank, a StringIO object.
Creates standard HTML attributes for the tag.
:disabled - If set to true, the user will not be able to use this input.
file_field_tag 'attachment' # => <input id="attachment" name="attachment" type="file" /> file_field_tag 'avatar', :class => 'profile_input' # => <input class="profile_input" id="avatar" name="avatar" type="file" /> file_field_tag 'picture', :disabled => true # => <input disabled="disabled" id="picture" name="picture" type="file" /> file_field_tag 'resume', :value => '~/resume.doc' # => <input id="resume" name="resume" type="file" value="~/resume.doc" /> file_field_tag 'user_pic', :accept => 'image/png,image/gif,image/jpeg' # => <input accept="image/png,image/gif,image/jpeg" id="user_pic" name="user_pic" type="file" /> file_field_tag 'file', :accept => 'text/html', :class => 'upload', :value => 'index.html' # => <input accept="text/html" class="upload" id="file" name="file" type="file" value="index.html" />
# File lib/action_view/helpers/form_tag_helper.rb, line 220 220: def file_field_tag(name, options = {}) 221: text_field_tag(name, nil, options.update("type" => "file")) 222: 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.
:multipart - If set to true, the enctype is set to “multipart/form-data“.
:method - The method to use when submitting the form, usually either “get” or “post”. If “put”, “delete”, or another verb is used, a hidden input with name _method is added to simulate the verb over post.
A list of parameters to feed to the URL the form will be posted to.
:remote - If set to true, will allow the Unobtrusive JavaScript drivers to control the submit behaviour. By default this behaviour is an ajax submit.
form_tag('/posts') # => <form action="/posts" method="post"> form_tag('/posts/1', :method => :put) # => <form action="/posts/1" method="put"> form_tag('/upload', :multipart => true) # => <form action="/upload" method="post" enctype="multipart/form-data"> <%= form_tag('/posts')do -%> <div><%= submit_tag 'Save' %></div> <% end -%> # => <form action="/posts" method="post"><div><input type="submit" name="submit" value="Save" /></div></form> <%= form_tag('/posts', :remote => true) %> # => <form action="/posts" method="post" data-remote="true">
# File lib/action_view/helpers/form_tag_helper.rb, line 49 49: def form_tag(url_for_options = {}, options = {}, *parameters_for_url, &block) 50: html_options = html_options_for_form(url_for_options, options, *parameters_for_url) 51: if block_given? 52: form_tag_in_block(html_options, &block) 53: else 54: form_tag_html(html_options) 55: end 56: end
Displays an image which when clicked will submit the form.
source is passed to AssetTagHelper#path_to_image
:confirm => 'question?' - This will add a JavaScript confirm prompt with the question specified. If the user accepts, the form is processed normally, otherwise no action is taken.
:disabled - If set to true, the user will not be able to use this input.
Any other key creates standard HTML options for the tag.
image_submit_tag("login.png") # => <input src="/images/login.png" type="image" /> image_submit_tag("purchase.png", :disabled => true) # => <input disabled="disabled" src="/images/purchase.png" type="image" /> image_submit_tag("search.png", :class => 'search_button') # => <input class="search_button" src="/images/search.png" type="image" /> image_submit_tag("agree.png", :disabled => true, :class => "agree_disagree_button") # => <input class="agree_disagree_button" disabled="disabled" src="/images/agree.png" type="image" />
# File lib/action_view/helpers/form_tag_helper.rb, line 426 426: def image_submit_tag(source, options = {}) 427: options.stringify_keys! 428: 429: if confirm = options.delete("confirm") 430: add_confirm_to_attributes!(options, confirm) 431: end 432: 433: tag :input, { "type" => "image", "src" => path_to_image(source) }.update(options.stringify_keys) 434: end
Creates a label element. Accepts a block.
Creates standard HTML attributes for the tag.
label_tag 'name' # => <label for="name">Name</label> label_tag 'name', 'Your name' # => <label for="name">Your Name</label> label_tag 'name', nil, :class => 'small_label' # => <label for="name" class="small_label">Name</label>
# File lib/action_view/helpers/form_tag_helper.rb, line 159 159: def label_tag(name = nil, content_or_options = nil, options = nil, &block) 160: options = content_or_options if block_given? && content_or_options.is_a?(Hash) 161: options ||= {} 162: options.stringify_keys! 163: options["for"] = sanitize_to_id(name) unless name.blank? || options.has_key?("for") 164: content_tag :label, content_or_options || name.to_s.humanize, options, &block 165: end
Creates a number field.
:min - The minimum acceptable value.
:max - The maximum acceptable value.
:in - A range specifying the :min and :max values.
:step - The acceptable value granularity.
Otherwise accepts the same options as text_field_tag.
number_field_tag 'quantity', nil, :in => 1...10 => <input id="quantity" name="quantity" min="1" max="9" />
# File lib/action_view/helpers/form_tag_helper.rb, line 510 510: def number_field_tag(name, value = nil, options = {}) 511: options = options.stringify_keys 512: options["type"] ||= "number" 513: if range = options.delete("in") || options.delete("within") 514: options.update("min" => range.min, "max" => range.max) 515: end 516: text_field_tag(name, value, options) 517: end
Creates a password field, a masked text field that will hide the users input behind a mask character.
:disabled - If set to true, the user will not be able to use this input.
:size - The number of visible characters that will fit in the input.
:maxlength - The maximum number of characters that the browser will allow the user to enter.
Any other key creates standard HTML attributes for the tag.
password_field_tag 'pass' # => <input id="pass" name="pass" type="password" /> password_field_tag 'secret', 'Your secret here' # => <input id="secret" name="secret" type="password" value="Your secret here" /> password_field_tag 'masked', nil, :class => 'masked_input_field' # => <input class="masked_input_field" id="masked" name="masked" type="password" /> password_field_tag 'token', '', :size => 15 # => <input id="token" name="token" size="15" type="password" value="" /> password_field_tag 'key', nil, :maxlength => 16 # => <input id="key" maxlength="16" name="key" type="password" /> password_field_tag 'confirm_pass', nil, :disabled => true # => <input disabled="disabled" id="confirm_pass" name="confirm_pass" type="password" /> password_field_tag 'pin', '1234', :maxlength => 4, :size => 6, :class => "pin_input" # => <input class="pin_input" id="pin" maxlength="4" name="pin" size="6" type="password" value="1234" />
# File lib/action_view/helpers/form_tag_helper.rb, line 253 253: def password_field_tag(name = "password", value = nil, options = {}) 254: text_field_tag(name, value, options.update("type" => "password")) 255: end
Creates a range form element.
Accepts the same options as number_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 523 523: def range_field_tag(name, value = nil, options = {}) 524: number_field_tag(name, value, options.stringify_keys.update("type" => "range")) 525: end
Creates a text field of type “search”.
Accepts the same options as text_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 468 468: def search_field_tag(name, value = nil, options = {}) 469: text_field_tag(name, value, options.stringify_keys.update("type" => "search")) 470: 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.
:multiple - If set to true the selection will allow multiple choices.
:disabled - If set to true, the user will not be able to use this input.
Any other key creates standard HTML attributes for the tag.
select_tag "people", options_from_collection_for_select(@people, "name", "id") # <select id="people" name="people"><option value="1">David</option></select> select_tag "people", "<option>David</option>" # => <select id="people" name="people"><option>David</option></select> select_tag "count", "<option>1</option><option>2</option><option>3</option><option>4</option>" # => <select id="count" name="count"><option>1</option><option>2</option> # <option>3</option><option>4</option></select> select_tag "colors", "<option>Red</option><option>Green</option><option>Blue</option>", :multiple => true # => <select id="colors" multiple="multiple" name="colors[]"><option>Red</option> # <option>Green</option><option>Blue</option></select> select_tag "locations", "<option>Home</option><option selected="selected">Work</option><option>Out</option>" # => <select id="locations" name="locations"><option>Home</option><option selected='selected'>Work</option> # <option>Out</option></select> select_tag "access", "<option>Read</option><option>Write</option>", :multiple => true, :class => 'form_input' # => <select class="form_input" id="access" multiple="multiple" name="access[]"><option>Read</option> # <option>Write</option></select> select_tag "destination", "<option>NYC</option><option>Paris</option><option>Rome</option>", :disabled => true # => <select disabled="disabled" id="destination" name="destination"><option>NYC</option> # <option>Paris</option><option>Rome</option></select>
# File lib/action_view/helpers/form_tag_helper.rb, line 95 95: def select_tag(name, option_tags = nil, options = {}) 96: if Array === option_tags 97: ActiveSupport::Deprecation.warn 'Passing an array of option_tags to select_tag implicitly joins them without marking them as HTML-safe. Pass option_tags.join.html_safe instead.', caller 98: end 99: 100: html_name = (options[:multiple] == true && !name.to_s.ends_with?("[]")) ? "#{name}[]" : name 101: if blank = options.delete(:include_blank) 102: if blank.kind_of?(String) 103: option_tags = "<option value=\"\">#{blank}</option>".html_safe + option_tags 104: else 105: option_tags = "<option value=\"\"></option>".html_safe + option_tags 106: end 107: end 108: content_tag :select, option_tags, { "name" => html_name, "id" => sanitize_to_id(name) }.update(options.stringify_keys) 109: end
Creates a submit button with the text value as the caption.
:confirm => 'question?' - If present the unobtrusive JavaScript drivers will provide a prompt with the question specified. If the user accepts, the form is processed normally, otherwise no action is taken.
:disabled - If true, the user will not be able to use this input.
:disable_with - Value of this parameter will be used as the value for a disabled version of the submit button when the form is submitted. This feature is provided by the unobtrusive JavaScript driver.
Any other key creates standard HTML options for the tag.
submit_tag # => <input name="commit" type="submit" value="Save changes" /> submit_tag "Edit this article" # => <input name="commit" type="submit" value="Edit this article" /> submit_tag "Save edits", :disabled => true # => <input disabled="disabled" name="commit" type="submit" value="Save edits" /> submit_tag "Complete sale", :disable_with => "Please wait..." # => <input name="commit" data-disable-with="Please wait..." # type="submit" value="Complete sale" /> submit_tag nil, :class => "form_submit" # => <input class="form_submit" name="commit" type="submit" /> submit_tag "Edit", :disable_with => "Editing...", :class => "edit_button" # => <input class="edit_button" data-disable_with="Editing..." # name="commit" type="submit" value="Edit" /> submit_tag "Save", :confirm => "Are you sure?" # => <input name='commit' type='submit' value='Save' data-confirm="Are you sure?" />
# File lib/action_view/helpers/form_tag_helper.rb, line 389 389: def submit_tag(value = "Save changes", options = {}) 390: options.stringify_keys! 391: 392: if disable_with = options.delete("disable_with") 393: options["data-disable-with"] = disable_with 394: end 395: 396: if confirm = options.delete("confirm") 397: add_confirm_to_attributes!(options, confirm) 398: end 399: 400: tag :input, { "type" => "submit", "name" => "commit", "value" => value }.update(options.stringify_keys) 401: end
Creates a text field of type “tel”.
Accepts the same options as text_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 476 476: def telephone_field_tag(name, value = nil, options = {}) 477: text_field_tag(name, value, options.stringify_keys.update("type" => "tel")) 478: end
Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.
:size - A string specifying the dimensions (columns by rows) of the textarea (e.g., “25x10”).
:rows - Specify the number of rows in the textarea
:cols - Specify the number of columns in the textarea
:disabled - If set to true, the user will not be able to use this input.
:escape - By default, the contents of the text input are HTML escaped. If you need unescaped contents, set this to false.
Any other key creates standard HTML attributes for the tag.
text_area_tag 'post' # => <textarea id="post" name="post"></textarea> text_area_tag 'bio', @user.bio # => <textarea id="bio" name="bio">This is my biography.</textarea> text_area_tag 'body', nil, :rows => 10, :cols => 25 # => <textarea cols="25" id="body" name="body" rows="10"></textarea> text_area_tag 'body', nil, :size => "25x10" # => <textarea name="body" id="body" cols="25" rows="10"></textarea> text_area_tag 'description', "Description goes here.", :disabled => true # => <textarea disabled="disabled" id="description" name="description">Description goes here.</textarea> text_area_tag 'comment', nil, :class => 'comment_input' # => <textarea class="comment_input" id="comment" name="comment"></textarea>
# File lib/action_view/helpers/form_tag_helper.rb, line 286 286: def text_area_tag(name, content = nil, options = {}) 287: options.stringify_keys! 288: 289: if size = options.delete("size") 290: options["cols"], options["rows"] = size.split("x") if size.respond_to?(:split) 291: end 292: 293: escape = options.key?("escape") ? options.delete("escape") : true 294: content = html_escape(content) if escape 295: 296: content_tag :textarea, content.to_s.html_safe, { "name" => name, "id" => sanitize_to_id(name) }.update(options) 297: end
Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.
:disabled - If set to true, the user will not be able to use this input.
:size - The number of visible characters that will fit in the input.
:maxlength - The maximum number of characters that the browser will allow the user to enter.
Any other key creates standard HTML attributes for the tag.
text_field_tag 'name' # => <input id="name" name="name" type="text" /> text_field_tag 'query', 'Enter your search query here' # => <input id="query" name="query" type="text" value="Enter your search query here" /> text_field_tag 'request', nil, :class => 'special_input' # => <input class="special_input" id="request" name="request" type="text" /> text_field_tag 'address', '', :size => 75 # => <input id="address" name="address" size="75" type="text" value="" /> text_field_tag 'zip', nil, :maxlength => 5 # => <input id="zip" maxlength="5" name="zip" type="text" /> text_field_tag 'payment_amount', '$0.00', :disabled => true # => <input disabled="disabled" id="payment_amount" name="payment_amount" type="text" value="$0.00" /> text_field_tag 'ip', '0.0.0.0', :maxlength => 15, :size => 20, :class => "ip-input" # => <input class="ip-input" id="ip" maxlength="15" name="ip" size="20" type="text" value="0.0.0.0" />
# File lib/action_view/helpers/form_tag_helper.rb, line 141 141: def text_field_tag(name, value = nil, options = {}) 142: tag :input, { "type" => "text", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(options.stringify_keys) 143: end
Creates a text field of type “url”.
Accepts the same options as text_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 485 485: def url_field_tag(name, value = nil, options = {}) 486: text_field_tag(name, value, options.stringify_keys.update("type" => "url")) 487: end
# File lib/action_view/helpers/form_tag_helper.rb, line 561 561: def form_tag_html(html_options) 562: extra_tags = extra_tags_for_form(html_options) 563: (tag(:form, html_options, true) + extra_tags).html_safe 564: end
# File lib/action_view/helpers/form_tag_helper.rb, line 566 566: def form_tag_in_block(html_options, &block) 567: content = capture(&block) 568: output = ActiveSupport::SafeBuffer.new 569: output.safe_concat(form_tag_html(html_options)) 570: output << content 571: output.safe_concat("</form>") 572: end
# File lib/action_view/helpers/form_tag_helper.rb, line 528 528: def html_options_for_form(url_for_options, options, *parameters_for_url) 529: options.stringify_keys.tap do |html_options| 530: html_options["enctype"] = "multipart/form-data" if html_options.delete("multipart") 531: # The following URL is unescaped, this is just a hash of options, and it is the 532: # responsability of the caller to escape all the values. 533: html_options["action"] = url_for(url_for_options, *parameters_for_url) 534: html_options["accept-charset"] = "UTF-8" 535: html_options["data-remote"] = true if html_options.delete("remote") 536: end 537: end
see www.w3.org/TR/html4/types.html#type-name
# File lib/action_view/helpers/form_tag_helper.rb, line 583 583: def sanitize_to_id(name) 584: name.to_s.gsub(']','').gsub(/[^-a-zA-Z0-9:.]/, "_") 585: end
# File lib/action_view/helpers/form_tag_helper.rb, line 574 574: def token_tag 575: unless protect_against_forgery? 576: '' 577: else 578: tag(:input, :type => "hidden", :name => request_forgery_protection_token.to_s, :value => form_authenticity_token) 579: end 580: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.